From f4ede262c4351eb839566acac73c6be6e4c8f020 Mon Sep 17 00:00:00 2001 From: Qijue Wang Date: Mon, 22 Sep 2025 21:37:24 +0000 Subject: [PATCH] Deprecate several services --- gradle.properties | 3 - .../2013-02-18/opsworks-2013-02-18.json | 9603 ----------------- .../2016-11-01/opsworkscm-2016-11-01.json | 3089 ------ .../privatenetworks-2021-12-03.json | 3948 ------- 4 files changed, 16643 deletions(-) delete mode 100644 models/opsworks/service/2013-02-18/opsworks-2013-02-18.json delete mode 100644 models/opsworkscm/service/2016-11-01/opsworkscm-2016-11-01.json delete mode 100644 models/privatenetworks/service/2021-12-03/privatenetworks-2021-12-03.json diff --git a/gradle.properties b/gradle.properties index 7b8d3fa9..e3c55408 100644 --- a/gradle.properties +++ b/gradle.properties @@ -272,8 +272,6 @@ model.observabilityadmin.version=1.0.3 model.omics.version=1.0.3 model.opensearch.version=1.0.3 model.opensearchserverless.version=1.0.4 -model.opsworks.version=1.0.0 -model.opsworkscm.version=1.0.2 model.organizations.version=1.0.4 model.osis.version=1.0.3 model.outposts.version=1.0.3 @@ -295,7 +293,6 @@ model.pinpoint-sms-voice-v2.version=1.0.2 model.pipes.version=1.0.1 model.polly.version=1.0.2 model.pricing.version=1.0.2 -model.privatenetworks.version=1.0.0 model.proton.version=1.0.1 model.qapps.version=1.0.2 model.qbusiness.version=1.0.4 diff --git a/models/opsworks/service/2013-02-18/opsworks-2013-02-18.json b/models/opsworks/service/2013-02-18/opsworks-2013-02-18.json deleted file mode 100644 index 48c3298c..00000000 --- a/models/opsworks/service/2013-02-18/opsworks-2013-02-18.json +++ /dev/null @@ -1,9603 +0,0 @@ -{ - "smithy": "2.0", - "metadata": { - "suppressions": [ - { - "id": "HttpMethodSemantics", - "namespace": "*" - }, - { - "id": "HttpResponseCodeSemantics", - "namespace": "*" - }, - { - "id": "PaginatedTrait", - "namespace": "*" - }, - { - "id": "HttpHeaderTrait", - "namespace": "*" - }, - { - "id": "HttpUriConflict", - "namespace": "*" - }, - { - "id": "Service", - "namespace": "*" - } - ] - }, - "shapes": { - "com.amazonaws.opsworks#AgentVersion": { - "type": "structure", - "members": { - "Version": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The agent version.

" - } - }, - "ConfigurationManager": { - "target": "com.amazonaws.opsworks#StackConfigurationManager", - "traits": { - "smithy.api#documentation": "

The configuration manager.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an agent version.

" - } - }, - "com.amazonaws.opsworks#AgentVersions": { - "type": "list", - "member": { - "target": "com.amazonaws.opsworks#AgentVersion" - } - }, - "com.amazonaws.opsworks#App": { - "type": "structure", - "members": { - "AppId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The app ID.

" - } - }, - "StackId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The app stack ID.

" - } - }, - "Shortname": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The app's short name.

" - } - }, - "Name": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The app name.

" - } - }, - "Description": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

A description of the app.

" - } - }, - "DataSources": { - "target": "com.amazonaws.opsworks#DataSources", - "traits": { - "smithy.api#documentation": "

The app's data sources.

" - } - }, - "Type": { - "target": "com.amazonaws.opsworks#AppType", - "traits": { - "smithy.api#documentation": "

The app type.

" - } - }, - "AppSource": { - "target": "com.amazonaws.opsworks#Source", - "traits": { - "smithy.api#documentation": "

A Source object that describes the app repository.

" - } - }, - "Domains": { - "target": "com.amazonaws.opsworks#Strings", - "traits": { - "smithy.api#documentation": "

The app vhost settings with multiple domains separated by commas. For example:\n 'www.example.com, example.com'\n

" - } - }, - "EnableSsl": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

Whether to enable SSL for the app.

" - } - }, - "SslConfiguration": { - "target": "com.amazonaws.opsworks#SslConfiguration", - "traits": { - "smithy.api#documentation": "

An SslConfiguration object with the SSL configuration.

" - } - }, - "Attributes": { - "target": "com.amazonaws.opsworks#AppAttributes", - "traits": { - "smithy.api#documentation": "

The stack attributes.

" - } - }, - "CreatedAt": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

When the app was created.

" - } - }, - "Environment": { - "target": "com.amazonaws.opsworks#EnvironmentVariables", - "traits": { - "smithy.api#documentation": "

An array of EnvironmentVariable objects that specify environment variables to be\n associated with the app. After you deploy the app, these variables are defined on the\n associated app server instances. For more information, see Environment Variables.

\n \n

There is no specific limit on the number of environment variables. \n However, the size of the associated data structure - which includes the variable names, values, and protected flag \n values - cannot exceed 20 KB. This limit should accommodate most if not all use cases, but if you do exceed it, you \n will cause an exception (API) with an \"Environment: is too large (maximum is 20 KB)\" message.

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "

A description of the app.

" - } - }, - "com.amazonaws.opsworks#AppAttributes": { - "type": "map", - "key": { - "target": "com.amazonaws.opsworks#AppAttributesKeys" - }, - "value": { - "target": "com.amazonaws.opsworks#String" - } - }, - "com.amazonaws.opsworks#AppAttributesKeys": { - "type": "enum", - "members": { - "DocumentRoot": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DocumentRoot" - } - }, - "RailsEnv": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RailsEnv" - } - }, - "AutoBundleOnDeploy": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AutoBundleOnDeploy" - } - }, - "AwsFlowRubySettings": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AwsFlowRubySettings" - } - } - } - }, - "com.amazonaws.opsworks#AppType": { - "type": "enum", - "members": { - "aws_flow_ruby": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "aws-flow-ruby" - } - }, - "java": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "java" - } - }, - "rails": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "rails" - } - }, - "php": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "php" - } - }, - "nodejs": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "nodejs" - } - }, - "static": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "static" - } - }, - "other": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "other" - } - } - } - }, - "com.amazonaws.opsworks#Apps": { - "type": "list", - "member": { - "target": "com.amazonaws.opsworks#App" - } - }, - "com.amazonaws.opsworks#Architecture": { - "type": "enum", - "members": { - "x86_64": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "x86_64" - } - }, - "i386": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "i386" - } - } - } - }, - "com.amazonaws.opsworks#AssignInstance": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#AssignInstanceRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Assign a registered instance to a layer.

\n \n

\n Required Permissions: To use this action, an Identity and Access Management\n (IAM) user must have a Manage permissions\n level for the stack or an attached policy that explicitly grants permissions. For more\n information on user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#AssignInstanceRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance ID.

", - "smithy.api#required": {} - } - }, - "LayerIds": { - "target": "com.amazonaws.opsworks#Strings", - "traits": { - "smithy.api#documentation": "

The layer ID, which must correspond to a custom layer. You cannot assign a registered instance to a built-in layer.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#AssignVolume": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#AssignVolumeRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Assigns one of the stack's registered Amazon EBS volumes to a specified instance. The volume must\n first be registered with the stack by calling RegisterVolume. After you register the\n volume, you must call UpdateVolume to specify a mount point before calling\n AssignVolume. For more information, see Resource Management.

\n

\n Required Permissions: To use this action, an IAM user must have a Manage \n permissions\n level for the stack, or an attached policy that explicitly grants permissions. For more\n information on user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#AssignVolumeRequest": { - "type": "structure", - "members": { - "VolumeId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The volume ID.

", - "smithy.api#required": {} - } - }, - "InstanceId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance ID.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#AssociateElasticIp": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#AssociateElasticIpRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Associates one of the stack's registered Elastic IP addresses with a specified instance. The\n address must first be registered with the stack by calling RegisterElasticIp. For more\n information, see Resource\n Management.

\n

\n Required Permissions: To use this action, an IAM user must have a \n Manage permissions\n level for the stack, or an attached policy that explicitly grants permissions. For more\n information on user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#AssociateElasticIpRequest": { - "type": "structure", - "members": { - "ElasticIp": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The Elastic IP address.

", - "smithy.api#required": {} - } - }, - "InstanceId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance ID.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#AttachElasticLoadBalancer": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#AttachElasticLoadBalancerRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Attaches an Elastic Load Balancing load balancer to a specified layer. OpsWorks Stacks does not support \n Application Load Balancer. You can only use Classic Load Balancer with OpsWorks Stacks. \n For more information, see Elastic Load\n Balancing.

\n \n

You must create the Elastic Load Balancing instance separately, by using the Elastic Load Balancing console, API, or CLI. For\n more information, see the Elastic Load Balancing Developer Guide.

\n \n

\n Required Permissions: To use this action, an IAM user must have a Manage permissions\n level for the stack, or an attached policy that explicitly grants permissions. For more\n information on user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#AttachElasticLoadBalancerRequest": { - "type": "structure", - "members": { - "ElasticLoadBalancerName": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The Elastic Load Balancing instance's name.

", - "smithy.api#required": {} - } - }, - "LayerId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The ID of the layer to which the Elastic Load Balancing instance is to be attached.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#AutoScalingThresholds": { - "type": "structure", - "members": { - "InstanceCount": { - "target": "com.amazonaws.opsworks#Integer", - "traits": { - "smithy.api#documentation": "

The number of instances to add or remove when the load exceeds a threshold.

" - } - }, - "ThresholdsWaitTime": { - "target": "com.amazonaws.opsworks#Minute", - "traits": { - "smithy.api#documentation": "

The amount of time, in minutes, that the load must exceed a threshold before more instances are added or removed.

" - } - }, - "IgnoreMetricsTime": { - "target": "com.amazonaws.opsworks#Minute", - "traits": { - "smithy.api#documentation": "

The amount of time (in minutes) after a scaling event occurs that OpsWorks Stacks should ignore metrics\n and suppress additional scaling events. For example, OpsWorks Stacks adds new instances following\n an upscaling event but the instances won't start reducing the load until they have been booted\n and configured. There is no point in raising additional scaling events during that operation,\n which typically takes several minutes. IgnoreMetricsTime allows you to direct\n OpsWorks Stacks to suppress scaling events long enough to get the new instances online.

" - } - }, - "CpuThreshold": { - "target": "com.amazonaws.opsworks#Double", - "traits": { - "smithy.api#documentation": "

The CPU utilization threshold, as a percent of the available CPU. A value of -1 disables the threshold.

" - } - }, - "MemoryThreshold": { - "target": "com.amazonaws.opsworks#Double", - "traits": { - "smithy.api#documentation": "

The memory utilization threshold, as a percent of the available memory. A value of -1 disables the threshold.

" - } - }, - "LoadThreshold": { - "target": "com.amazonaws.opsworks#Double", - "traits": { - "smithy.api#documentation": "

The load threshold. A value of -1 disables the threshold. For more information about how load is computed, \n see Load (computing).

" - } - }, - "Alarms": { - "target": "com.amazonaws.opsworks#Strings", - "traits": { - "smithy.api#documentation": "

Custom CloudWatch auto scaling alarms, to be used as thresholds. This parameter takes a list of up to five alarm names,\n which are case sensitive and must be in the same region as the stack.

\n \n

To use custom alarms, you must update your service role to allow\n cloudwatch:DescribeAlarms. You can either have OpsWorks Stacks update the role for\n you when you first use this feature or you can edit the role manually. For more information,\n see Allowing OpsWorks Stacks to Act on Your Behalf.

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a load-based auto scaling upscaling or downscaling threshold configuration, which specifies when OpsWorks Stacks starts or \n stops load-based instances.

" - } - }, - "com.amazonaws.opsworks#AutoScalingType": { - "type": "enum", - "members": { - "load": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "load" - } - }, - "timer": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "timer" - } - } - } - }, - "com.amazonaws.opsworks#BlockDeviceMapping": { - "type": "structure", - "members": { - "DeviceName": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The device name that is exposed to the instance, such as /dev/sdh. For the root\n device, you can use the explicit device name or you can set this parameter to\n ROOT_DEVICE and OpsWorks Stacks will provide the correct device name.

" - } - }, - "NoDevice": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

Suppresses the specified device included in the AMI's block device mapping.

" - } - }, - "VirtualName": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The virtual device name. For more information, see BlockDeviceMapping.

" - } - }, - "Ebs": { - "target": "com.amazonaws.opsworks#EbsBlockDevice", - "traits": { - "smithy.api#documentation": "

An EBSBlockDevice that defines how to configure an Amazon EBS volume when the\n instance is launched.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a block device mapping. This data type maps directly to the Amazon EC2 BlockDeviceMapping data type.

" - } - }, - "com.amazonaws.opsworks#BlockDeviceMappings": { - "type": "list", - "member": { - "target": "com.amazonaws.opsworks#BlockDeviceMapping" - } - }, - "com.amazonaws.opsworks#Boolean": { - "type": "boolean" - }, - "com.amazonaws.opsworks#ChefConfiguration": { - "type": "structure", - "members": { - "ManageBerkshelf": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

Whether to enable Berkshelf.

" - } - }, - "BerkshelfVersion": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The Berkshelf version.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the Chef configuration.

" - } - }, - "com.amazonaws.opsworks#CloneStack": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#CloneStackRequest" - }, - "output": { - "target": "com.amazonaws.opsworks#CloneStackResult" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a clone of a specified stack. For more information, see Clone a\n Stack. By default, all parameters are set to the values used by the parent stack.

\n

\n Required Permissions: To use this action, an IAM user must have an attached policy\n that explicitly grants permissions. For more information about user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#CloneStackRequest": { - "type": "structure", - "members": { - "SourceStackId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The source stack ID.

", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The cloned stack name. Stack names can be a maximum of 64 characters.

" - } - }, - "Region": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The cloned stack Amazon Web Services Region, such as ap-northeast-2. For more information \n about Amazon Web Services Regions, see\n Regions and Endpoints.

" - } - }, - "VpcId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The ID of the VPC that the cloned stack is to be launched into. It must be in the specified region. All\n instances are launched into this VPC, and you cannot change the ID later.

\n \n

If the VPC ID corresponds to a default VPC and you have specified either the\n DefaultAvailabilityZone or the DefaultSubnetId parameter only,\n OpsWorks Stacks infers the value of the other parameter. If you specify neither parameter, OpsWorks Stacks sets\n these parameters to the first valid Availability Zone for the specified region and the\n corresponding default VPC subnet ID, respectively.

\n

If you specify a nondefault VPC ID, note the following:

\n \n

For more information about how to use OpsWorks Stacks with a VPC, see Running a Stack in a\n VPC. For more information about default VPC and EC2 Classic, see Supported\n Platforms.

" - } - }, - "Attributes": { - "target": "com.amazonaws.opsworks#StackAttributes", - "traits": { - "smithy.api#documentation": "

A list of stack attributes and values as key/value pairs to be added to the cloned stack.

" - } - }, - "ServiceRoleArn": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The stack Identity and Access Management (IAM) role, which allows OpsWorks Stacks to work with Amazon Web Services\n resources on your behalf. You must set this parameter to the Amazon Resource Name (ARN) for an\n existing IAM role. If you create a stack by using the OpsWorkss Stacks console, it creates the role for\n you. You can obtain an existing stack's IAM ARN programmatically by calling\n DescribePermissions. For more information about IAM ARNs, see \n Using\n Identifiers.

\n \n

You must set this parameter to a valid service role ARN or the action will fail; there is no default value. \n You can specify the source stack's service role ARN, if you prefer, but you must do so explicitly.

\n ", - "smithy.api#required": {} - } - }, - "DefaultInstanceProfileArn": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an IAM profile that is the default profile for all of the stack's \n EC2 instances.\n For more information about IAM ARNs, see Using\n Identifiers.

" - } - }, - "DefaultOs": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The stack's operating system, which must be set to one of the following.

\n \n

The default option is the parent stack's operating system.\n Not all operating systems are supported with all versions of Chef. For more information about supported operating systems,\n see OpsWorks Stacks Operating Systems.

\n \n

You can specify a different Linux operating system for the cloned stack, but you cannot change from Linux to \n Windows or Windows to Linux.

\n " - } - }, - "HostnameTheme": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The stack's host name theme, with spaces are replaced by underscores. The theme is used to\n generate host names for the stack's instances. By default, HostnameTheme is set\n to Layer_Dependent, which creates host names by appending integers to the layer's\n short name. The other themes are:

\n \n

To obtain a generated host name, call GetHostNameSuggestion, which returns a\n host name based on the current theme.

" - } - }, - "DefaultAvailabilityZone": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The cloned stack's default Availability Zone, which must be in the specified region. For more\n information, see Regions and\n Endpoints. If you also specify a value for DefaultSubnetId, the subnet must\n be in the same zone. For more information, see the VpcId parameter description.\n

" - } - }, - "DefaultSubnetId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The stack's default VPC subnet ID. This parameter is required if you specify a value for the\n VpcId parameter. All instances are launched into this subnet unless you specify\n otherwise when you create the instance. If you also specify a value for\n DefaultAvailabilityZone, the subnet must be in that zone. For information on\n default values and when this parameter is required, see the VpcId parameter\n description.

" - } - }, - "CustomJson": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

A string that contains user-defined, custom JSON. It is used to override the corresponding default stack configuration \n JSON values. The string should be in the following format:

\n

\n \"{\\\"key1\\\": \\\"value1\\\", \\\"key2\\\": \\\"value2\\\",...}\"\n

\n

For more information about custom JSON, see Use Custom JSON to\n Modify the Stack Configuration Attributes\n

" - } - }, - "ConfigurationManager": { - "target": "com.amazonaws.opsworks#StackConfigurationManager", - "traits": { - "smithy.api#documentation": "

The configuration manager. When you clone a stack we recommend that you use the configuration manager to specify the \n 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.

" - } - }, - "ChefConfiguration": { - "target": "com.amazonaws.opsworks#ChefConfiguration", - "traits": { - "smithy.api#documentation": "

A ChefConfiguration object that specifies whether to enable Berkshelf and the\n Berkshelf version on Chef 11.10 stacks. For more information, see Create a New Stack.

" - } - }, - "UseCustomCookbooks": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

Whether to use custom cookbooks.

" - } - }, - "UseOpsworksSecurityGroups": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

Whether to associate the OpsWorks Stacks built-in security groups with the stack's layers.

\n

OpsWorks Stacks provides a standard set of security groups, one for each layer, which are\n associated with layers by default. With UseOpsworksSecurityGroups you can instead\n provide your own custom security groups. UseOpsworksSecurityGroups has the\n following settings:

\n \n

For more information, see Create a New\n Stack.

" - } - }, - "CustomCookbooksSource": { - "target": "com.amazonaws.opsworks#Source", - "traits": { - "smithy.api#documentation": "

Contains the information required to retrieve an app or cookbook from a repository. For more information, \n see Adding Apps or \n Cookbooks and Recipes.

" - } - }, - "DefaultSshKeyName": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

A default Amazon EC2 key pair name. The default value is none. If you specify a key pair name, \n OpsWorks installs the public key on the instance and you can use the private key with an SSH\n client to log in to the instance. For more information, see Using SSH to\n Communicate with an Instance and Managing SSH\n Access. You can override this setting by specifying a different key pair, or no key\n pair, when you \n create an instance.

" - } - }, - "ClonePermissions": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

Whether to clone the source stack's permissions.

" - } - }, - "CloneAppIds": { - "target": "com.amazonaws.opsworks#Strings", - "traits": { - "smithy.api#documentation": "

A list of source stack app IDs to be included in the cloned stack.

" - } - }, - "DefaultRootDeviceType": { - "target": "com.amazonaws.opsworks#RootDeviceType", - "traits": { - "smithy.api#documentation": "

The default root device type. This value is used by default for all instances in the cloned\n stack, but you can override it when you create an instance. For more information, see Storage for the Root Device.

" - } - }, - "AgentVersion": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The default OpsWorks Stacks agent version. You have the following options:

\n \n

The default setting is LATEST. To specify an agent version,\n you must use the complete version number, not the abbreviated number shown on the console.\n For a list of available agent version numbers, call DescribeAgentVersions. AgentVersion cannot be set to Chef 12.2.

\n \n

You can also specify an agent version when you create or update an instance, which overrides the stack's \n default setting.

\n " - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#CloneStackResult": { - "type": "structure", - "members": { - "StackId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The cloned stack ID.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the response to a CloneStack request.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.opsworks#CloudWatchLogsConfiguration": { - "type": "structure", - "members": { - "Enabled": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

Whether CloudWatch Logs is enabled for a layer.

" - } - }, - "LogStreams": { - "target": "com.amazonaws.opsworks#CloudWatchLogsLogStreams", - "traits": { - "smithy.api#documentation": "

A list of configuration options for CloudWatch Logs.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the Amazon CloudWatch Logs configuration for a layer.

" - } - }, - "com.amazonaws.opsworks#CloudWatchLogsEncoding": { - "type": "enum", - "members": { - "ascii": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ascii" - } - }, - "big5": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "big5" - } - }, - "big5hkscs": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "big5hkscs" - } - }, - "cp037": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cp037" - } - }, - "cp424": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cp424" - } - }, - "cp437": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cp437" - } - }, - "cp500": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cp500" - } - }, - "cp720": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cp720" - } - }, - "cp737": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cp737" - } - }, - "cp775": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cp775" - } - }, - "cp850": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cp850" - } - }, - "cp852": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cp852" - } - }, - "cp855": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cp855" - } - }, - "cp856": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cp856" - } - }, - "cp857": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cp857" - } - }, - "cp858": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cp858" - } - }, - "cp860": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cp860" - } - }, - "cp861": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cp861" - } - }, - "cp862": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cp862" - } - }, - "cp863": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cp863" - } - }, - "cp864": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cp864" - } - }, - "cp865": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cp865" - } - }, - "cp866": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cp866" - } - }, - "cp869": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cp869" - } - }, - "cp874": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cp874" - } - }, - "cp875": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cp875" - } - }, - "cp932": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cp932" - } - }, - "cp949": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cp949" - } - }, - "cp950": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cp950" - } - }, - "cp1006": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cp1006" - } - }, - "cp1026": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cp1026" - } - }, - "cp1140": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cp1140" - } - }, - "cp1250": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cp1250" - } - }, - "cp1251": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cp1251" - } - }, - "cp1252": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cp1252" - } - }, - "cp1253": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cp1253" - } - }, - "cp1254": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cp1254" - } - }, - "cp1255": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cp1255" - } - }, - "cp1256": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cp1256" - } - }, - "cp1257": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cp1257" - } - }, - "cp1258": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "cp1258" - } - }, - "euc_jp": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "euc_jp" - } - }, - "euc_jis_2004": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "euc_jis_2004" - } - }, - "euc_jisx0213": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "euc_jisx0213" - } - }, - "euc_kr": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "euc_kr" - } - }, - "gb2312": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "gb2312" - } - }, - "gbk": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "gbk" - } - }, - "gb18030": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "gb18030" - } - }, - "hz": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "hz" - } - }, - "iso2022_jp": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "iso2022_jp" - } - }, - "iso2022_jp_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "iso2022_jp_1" - } - }, - "iso2022_jp_2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "iso2022_jp_2" - } - }, - "iso2022_jp_2004": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "iso2022_jp_2004" - } - }, - "iso2022_jp_3": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "iso2022_jp_3" - } - }, - "iso2022_jp_ext": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "iso2022_jp_ext" - } - }, - "iso2022_kr": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "iso2022_kr" - } - }, - "latin_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "latin_1" - } - }, - "iso8859_2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "iso8859_2" - } - }, - "iso8859_3": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "iso8859_3" - } - }, - "iso8859_4": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "iso8859_4" - } - }, - "iso8859_5": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "iso8859_5" - } - }, - "iso8859_6": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "iso8859_6" - } - }, - "iso8859_7": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "iso8859_7" - } - }, - "iso8859_8": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "iso8859_8" - } - }, - "iso8859_9": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "iso8859_9" - } - }, - "iso8859_10": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "iso8859_10" - } - }, - "iso8859_13": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "iso8859_13" - } - }, - "iso8859_14": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "iso8859_14" - } - }, - "iso8859_15": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "iso8859_15" - } - }, - "iso8859_16": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "iso8859_16" - } - }, - "johab": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "johab" - } - }, - "koi8_r": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "koi8_r" - } - }, - "koi8_u": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "koi8_u" - } - }, - "mac_cyrillic": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "mac_cyrillic" - } - }, - "mac_greek": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "mac_greek" - } - }, - "mac_iceland": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "mac_iceland" - } - }, - "mac_latin2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "mac_latin2" - } - }, - "mac_roman": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "mac_roman" - } - }, - "mac_turkish": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "mac_turkish" - } - }, - "ptcp154": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ptcp154" - } - }, - "shift_jis": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "shift_jis" - } - }, - "shift_jis_2004": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "shift_jis_2004" - } - }, - "shift_jisx0213": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "shift_jisx0213" - } - }, - "utf_32": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "utf_32" - } - }, - "utf_32_be": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "utf_32_be" - } - }, - "utf_32_le": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "utf_32_le" - } - }, - "utf_16": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "utf_16" - } - }, - "utf_16_be": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "utf_16_be" - } - }, - "utf_16_le": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "utf_16_le" - } - }, - "utf_7": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "utf_7" - } - }, - "utf_8": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "utf_8" - } - }, - "utf_8_sig": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "utf_8_sig" - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies the encoding of the log file so that the file can be read correctly. \n The default is utf_8. Encodings supported by Python codecs.decode() can be used here.

" - } - }, - "com.amazonaws.opsworks#CloudWatchLogsInitialPosition": { - "type": "enum", - "members": { - "start_of_file": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "start_of_file" - } - }, - "end_of_file": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "end_of_file" - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies where to start to read data (start_of_file or end_of_file). The default is start_of_file. It's only used if there is no state persisted for that log stream.

" - } - }, - "com.amazonaws.opsworks#CloudWatchLogsLogStream": { - "type": "structure", - "members": { - "LogGroupName": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

Specifies the destination log group. A log group is created automatically if it doesn't already exist. \n Log group names can be between 1 and 512 characters long. Allowed characters include a-z, A-Z, 0-9, '_' (underscore), \n '-' (hyphen), '/' (forward slash), and '.' (period).

" - } - }, - "DatetimeFormat": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

Specifies how the time stamp is extracted from logs. For more information, see the \n CloudWatch Logs Agent Reference.

" - } - }, - "TimeZone": { - "target": "com.amazonaws.opsworks#CloudWatchLogsTimeZone", - "traits": { - "smithy.api#documentation": "

Specifies the time zone of log event time stamps.

" - } - }, - "File": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

Specifies log files that you want to push to CloudWatch Logs.

\n

\n File can point to a specific file or multiple files (by using wild card characters such \n as /var/log/system.log*).\n Only the latest file is pushed to CloudWatch Logs, based on file modification time. We recommend that you use \n wild card characters to specify a series\n of files of the same type, such as access_log.2014-06-01-01, access_log.2014-06-01-02, and so on\n by using a pattern like access_log.*. Don't use a wildcard to match multiple file types,\n such as access_log_80 and access_log_443. To specify multiple, different file types, add another\n log stream entry to the configuration file, so that each log file type is stored in a different log group.

\n

Zipped files are not supported.

" - } - }, - "FileFingerprintLines": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

Specifies the range of lines for identifying a file. The valid values are one number, or two dash-delimited numbers, \n such as '1', '2-5'. The default value is '1', meaning the first line is used to calculate the fingerprint. \n Fingerprint lines are \n not sent to CloudWatch Logs unless all specified lines are available.

" - } - }, - "MultiLineStartPattern": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

Specifies the pattern for identifying the start of a log message.

" - } - }, - "InitialPosition": { - "target": "com.amazonaws.opsworks#CloudWatchLogsInitialPosition", - "traits": { - "smithy.api#documentation": "

Specifies where to start to read data (start_of_file or end_of_file). The default is start_of_file. \n This setting is only used if there is no state persisted for that log stream.

" - } - }, - "Encoding": { - "target": "com.amazonaws.opsworks#CloudWatchLogsEncoding", - "traits": { - "smithy.api#documentation": "

Specifies the encoding of the log file so that the file can be read correctly. \n The default is utf_8. Encodings supported by Python codecs.decode() can be used here.

" - } - }, - "BufferDuration": { - "target": "com.amazonaws.opsworks#Integer", - "traits": { - "smithy.api#documentation": "

Specifies the time duration for the batching of log events. The minimum value is 5000ms and default value is 5000ms.

" - } - }, - "BatchCount": { - "target": "com.amazonaws.opsworks#Integer", - "traits": { - "smithy.api#documentation": "

Specifies the max number of log events in a batch, up to 10000. The default value is 1000.

" - } - }, - "BatchSize": { - "target": "com.amazonaws.opsworks#Integer", - "traits": { - "smithy.api#documentation": "

Specifies the maximum size of log events in a batch, in bytes, up to 1048576 bytes. \n The default value is 32768 bytes. This size is calculated as the sum of all event messages \n in UTF-8, plus 26 bytes for each log event.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the CloudWatch Logs configuration for a layer. For detailed information about members of this data type, \n see the CloudWatch Logs Agent Reference.

" - } - }, - "com.amazonaws.opsworks#CloudWatchLogsLogStreams": { - "type": "list", - "member": { - "target": "com.amazonaws.opsworks#CloudWatchLogsLogStream" - }, - "traits": { - "smithy.api#documentation": "

Describes the Amazon CloudWatch Logs configuration for a layer.

" - } - }, - "com.amazonaws.opsworks#CloudWatchLogsTimeZone": { - "type": "enum", - "members": { - "LOCAL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LOCAL" - } - }, - "UTC": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UTC" - } - } - }, - "traits": { - "smithy.api#documentation": "

The preferred time zone for logs streamed to CloudWatch Logs. \n Valid values are LOCAL and UTC, for Coordinated Universal Time.

" - } - }, - "com.amazonaws.opsworks#Command": { - "type": "structure", - "members": { - "CommandId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The command ID.

" - } - }, - "InstanceId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The ID of the instance where the command was executed.

" - } - }, - "DeploymentId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The command deployment ID.

" - } - }, - "CreatedAt": { - "target": "com.amazonaws.opsworks#DateTime", - "traits": { - "smithy.api#documentation": "

Date and time when the command was run.

" - } - }, - "AcknowledgedAt": { - "target": "com.amazonaws.opsworks#DateTime", - "traits": { - "smithy.api#documentation": "

Date and time when the command was acknowledged.

" - } - }, - "CompletedAt": { - "target": "com.amazonaws.opsworks#DateTime", - "traits": { - "smithy.api#documentation": "

Date when the command completed.

" - } - }, - "Status": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The command status:

\n " - } - }, - "ExitCode": { - "target": "com.amazonaws.opsworks#Integer", - "traits": { - "smithy.api#documentation": "

The command exit code.

" - } - }, - "LogUrl": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The URL of the command log.

" - } - }, - "Type": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The command type:

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a command.

" - } - }, - "com.amazonaws.opsworks#Commands": { - "type": "list", - "member": { - "target": "com.amazonaws.opsworks#Command" - } - }, - "com.amazonaws.opsworks#CreateApp": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#CreateAppRequest" - }, - "output": { - "target": "com.amazonaws.opsworks#CreateAppResult" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates an app for a specified stack. For more information, see Creating\n Apps.

\n

\n Required Permissions: To use this action, an IAM user must have a Manage permissions\n level for the stack, or an attached policy that explicitly grants permissions. For more\n information on user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#CreateAppRequest": { - "type": "structure", - "members": { - "StackId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The stack ID.

", - "smithy.api#required": {} - } - }, - "Shortname": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The app's short name.

" - } - }, - "Name": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The app name.

", - "smithy.api#required": {} - } - }, - "Description": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

A description of the app.

" - } - }, - "DataSources": { - "target": "com.amazonaws.opsworks#DataSources", - "traits": { - "smithy.api#documentation": "

The app's data source.

" - } - }, - "Type": { - "target": "com.amazonaws.opsworks#AppType", - "traits": { - "smithy.api#documentation": "

The app type. Each supported type is associated with a particular layer. For example, PHP\n applications are associated with a PHP layer. OpsWorks Stacks deploys an application to those instances\n that are members of the corresponding layer. If your app isn't one of the standard types, or\n you prefer to implement your own Deploy recipes, specify other.

", - "smithy.api#required": {} - } - }, - "AppSource": { - "target": "com.amazonaws.opsworks#Source", - "traits": { - "smithy.api#documentation": "

A Source object that specifies the app repository.

" - } - }, - "Domains": { - "target": "com.amazonaws.opsworks#Strings", - "traits": { - "smithy.api#documentation": "

The app virtual host settings, with multiple domains separated by commas. For example:\n 'www.example.com, example.com'\n

" - } - }, - "EnableSsl": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

Whether to enable SSL for the app.

" - } - }, - "SslConfiguration": { - "target": "com.amazonaws.opsworks#SslConfiguration", - "traits": { - "smithy.api#documentation": "

An SslConfiguration object with the SSL configuration.

" - } - }, - "Attributes": { - "target": "com.amazonaws.opsworks#AppAttributes", - "traits": { - "smithy.api#documentation": "

One or more user-defined key/value pairs to be added to the stack attributes.

" - } - }, - "Environment": { - "target": "com.amazonaws.opsworks#EnvironmentVariables", - "traits": { - "smithy.api#documentation": "

An array of EnvironmentVariable objects that specify environment variables to be\n associated with the app. After you deploy the app, these variables are defined on the\n associated app server instance. For more information, see Environment Variables.

\n

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 20 KB. 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 20KB).\"

\n \n

If you have specified one or more environment variables, you cannot modify the stack's Chef version.

\n " - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#CreateAppResult": { - "type": "structure", - "members": { - "AppId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The app ID.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the response to a CreateApp request.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.opsworks#CreateDeployment": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#CreateDeploymentRequest" - }, - "output": { - "target": "com.amazonaws.opsworks#CreateDeploymentResult" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Runs deployment or stack commands. For more information, see Deploying\n Apps and Run Stack Commands.

\n

\n Required Permissions: To use this action, an IAM user must have a Deploy or Manage\n permissions level for the stack, or an attached policy that explicitly grants permissions. For\n more information on user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#CreateDeploymentRequest": { - "type": "structure", - "members": { - "StackId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The stack ID.

", - "smithy.api#required": {} - } - }, - "AppId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The app ID. This parameter is required for app deployments, but not for other deployment commands.

" - } - }, - "InstanceIds": { - "target": "com.amazonaws.opsworks#Strings", - "traits": { - "smithy.api#documentation": "

The instance IDs for the deployment targets.

" - } - }, - "LayerIds": { - "target": "com.amazonaws.opsworks#Strings", - "traits": { - "smithy.api#documentation": "

The layer IDs for the deployment targets.

" - } - }, - "Command": { - "target": "com.amazonaws.opsworks#DeploymentCommand", - "traits": { - "smithy.api#documentation": "

A DeploymentCommand object that specifies the deployment command and any\n associated arguments.

", - "smithy.api#required": {} - } - }, - "Comment": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

A user-defined comment.

" - } - }, - "CustomJson": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

A string that contains user-defined, custom JSON. You can use this parameter to override some corresponding default \n stack configuration JSON values. The string should be in the following format:

\n

\n \"{\\\"key1\\\": \\\"value1\\\", \\\"key2\\\": \\\"value2\\\",...}\"\n

\n

For more information about custom JSON, see Use Custom JSON to\n Modify the Stack Configuration Attributes and \n Overriding Attributes With Custom \n JSON.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#CreateDeploymentResult": { - "type": "structure", - "members": { - "DeploymentId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The deployment ID, which can be used with other requests to identify the deployment.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the response to a CreateDeployment request.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.opsworks#CreateInstance": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#CreateInstanceRequest" - }, - "output": { - "target": "com.amazonaws.opsworks#CreateInstanceResult" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates an instance in a specified stack. For more information, see Adding an\n Instance to a Layer.

\n

\n Required Permissions: To use this action, an IAM user must have a Manage permissions\n level for the stack, or an attached policy that explicitly grants permissions. For more\n information on user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#CreateInstanceRequest": { - "type": "structure", - "members": { - "StackId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The stack ID.

", - "smithy.api#required": {} - } - }, - "LayerIds": { - "target": "com.amazonaws.opsworks#Strings", - "traits": { - "smithy.api#documentation": "

An array that contains the instance's layer IDs.

", - "smithy.api#required": {} - } - }, - "InstanceType": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance type, such as t2.micro. For a list of supported instance types,\n open the stack in the console, choose Instances, and choose + Instance.\n The Size list contains the currently supported types. \n For more information, see Instance\n Families and Types. The parameter values that you use to specify the various types are\n in the API Name column of the Available Instance Types table.

", - "smithy.api#required": {} - } - }, - "AutoScalingType": { - "target": "com.amazonaws.opsworks#AutoScalingType", - "traits": { - "smithy.api#documentation": "

For load-based or time-based instances, the type. Windows stacks can use only time-based instances.

" - } - }, - "Hostname": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance host name. The following are character limits for instance host names.

\n " - } - }, - "Os": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance's operating system, which must be set to one of the following.

\n \n

Not all operating systems are supported with all versions of Chef. For more information about the supported operating systems,\n see OpsWorks Stacks Operating Systems.

\n

The default option is the current Amazon Linux version. If you set this parameter to\n Custom, you must use the CreateInstance action's AmiId parameter to\n specify the custom AMI that you want to use. Block device mappings are not supported if the value is Custom. \n For more information about how to use custom AMIs with OpsWorks Stacks, see Using\n Custom AMIs.

" - } - }, - "AmiId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

A custom AMI ID to be used to create the instance. The AMI should be based on one of the\n supported operating systems.\n For more information, see\n Using Custom AMIs.

\n \n

If you specify a custom AMI, you must set Os to Custom.

\n " - } - }, - "SshKeyName": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance's Amazon EC2 key-pair name.

" - } - }, - "AvailabilityZone": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance Availability Zone. For more information, see Regions and Endpoints.

" - } - }, - "VirtualizationType": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance's virtualization type, paravirtual or hvm.

" - } - }, - "SubnetId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

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 \n default subnet ID value and direct OpsWorks Stacks to launch the instance in a different subnet.

" - } - }, - "Architecture": { - "target": "com.amazonaws.opsworks#Architecture", - "traits": { - "smithy.api#documentation": "

The instance architecture. The default option is x86_64. Instance types do not\n necessarily support both architectures. For a list of the architectures that are supported by\n the different instance types, see Instance Families and\n Types.

" - } - }, - "RootDeviceType": { - "target": "com.amazonaws.opsworks#RootDeviceType", - "traits": { - "smithy.api#documentation": "

The instance root device type. For more information, see Storage for the Root Device.

" - } - }, - "BlockDeviceMappings": { - "target": "com.amazonaws.opsworks#BlockDeviceMappings", - "traits": { - "smithy.api#documentation": "

An array of BlockDeviceMapping objects that specify the instance's block\n devices. For more information, see Block\n Device Mapping. Note that block device mappings are not supported for custom AMIs.

" - } - }, - "InstallUpdatesOnBoot": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

Whether to install operating system and package updates when the instance boots. The default\n value is true. To control when updates are installed, set this value to\n false. You must then update your instances manually by using\n CreateDeployment to run the update_dependencies stack command or\n by manually running yum (Amazon Linux) or apt-get (Ubuntu) on the\n instances.

\n \n

We strongly recommend using the default value of true to ensure that your\n instances have the latest security updates.

\n " - } - }, - "EbsOptimized": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

Whether to create an Amazon EBS-optimized instance.

" - } - }, - "AgentVersion": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The default OpsWorks Stacks agent version. You have the following options:

\n \n

The default setting is INHERIT. To specify an agent version,\n you must use the complete version number, not the abbreviated number shown on the console.\n For a list of available agent version numbers, call DescribeAgentVersions. \n AgentVersion cannot be set to Chef 12.2.

" - } - }, - "Tenancy": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance's tenancy option. The default option is no tenancy, or if the instance is running in a VPC, \n inherit tenancy settings from the VPC. The following are valid values for this parameter: \n dedicated, default, or host. Because there are costs associated with changes \n in tenancy options, we recommend that you research tenancy options before choosing them for your instances. \n For more information about dedicated hosts, see \n Dedicated Hosts Overview and \n Amazon EC2 Dedicated Hosts. \n For more information about dedicated instances, see \n Dedicated Instances and \n Amazon EC2 Dedicated Instances.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#CreateInstanceResult": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance ID.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the response to a CreateInstance request.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.opsworks#CreateLayer": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#CreateLayerRequest" - }, - "output": { - "target": "com.amazonaws.opsworks#CreateLayerResult" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a layer. For more information, see How to\n Create a Layer.

\n \n

You should use CreateLayer for noncustom layer types such as \n PHP App Server only if the stack\n does not have an existing layer of that type. A stack can have at most one instance of each\n noncustom layer; if you attempt to create a second instance, CreateLayer fails. A\n stack can have an arbitrary number of custom layers, so you can call CreateLayer as\n many times as you like for that layer type.

\n \n

\n Required Permissions: To use this action, an IAM user must \n have a Manage permissions\n level for the stack, or an attached policy that explicitly grants permissions. For more\n information on user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#CreateLayerRequest": { - "type": "structure", - "members": { - "StackId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The layer stack ID.

", - "smithy.api#required": {} - } - }, - "Type": { - "target": "com.amazonaws.opsworks#LayerType", - "traits": { - "smithy.api#documentation": "

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. \n Built-in layers are not available in Chef 12 stacks.

", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The layer name, which is used by the console. Layer names can be a maximum of 32 characters.

", - "smithy.api#required": {} - } - }, - "Shortname": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

For custom layers only, use this parameter to specify the layer's short name, which is used internally by \n OpsWorks Stacks and by Chef recipes. The short name is also used as the name for the directory where your \n app files are installed. It can have a maximum of 32 characters, which are limited to the alphanumeric \n characters, '-', '_', and '.'.

\n

Built-in layer short names are defined by OpsWorks Stacks. For more information, see the \n Layer Reference.

", - "smithy.api#required": {} - } - }, - "Attributes": { - "target": "com.amazonaws.opsworks#LayerAttributes", - "traits": { - "smithy.api#documentation": "

One or more user-defined key-value pairs to be added to the stack attributes.

\n

To create a cluster layer, set the EcsClusterArn attribute to the cluster's ARN.

" - } - }, - "CloudWatchLogsConfiguration": { - "target": "com.amazonaws.opsworks#CloudWatchLogsConfiguration", - "traits": { - "smithy.api#documentation": "

Specifies CloudWatch Logs configuration options for the layer. For more information, \n see CloudWatchLogsLogStream.

" - } - }, - "CustomInstanceProfileArn": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The ARN of an IAM profile to be used for the layer's EC2 instances. For more information\n about IAM ARNs, see Using Identifiers.

" - } - }, - "CustomJson": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

A JSON-formatted string containing custom stack configuration and deployment attributes\n to be installed on the layer's instances. For more information, see\n \n Using Custom JSON. This feature is supported as of version 1.7.42 of the CLI. \n

" - } - }, - "CustomSecurityGroupIds": { - "target": "com.amazonaws.opsworks#Strings", - "traits": { - "smithy.api#documentation": "

An array containing the layer custom security group IDs.

" - } - }, - "Packages": { - "target": "com.amazonaws.opsworks#Strings", - "traits": { - "smithy.api#documentation": "

An array of Package objects that describes the layer packages.

" - } - }, - "VolumeConfigurations": { - "target": "com.amazonaws.opsworks#VolumeConfigurations", - "traits": { - "smithy.api#documentation": "

A VolumeConfigurations object that describes the layer's Amazon EBS volumes.

" - } - }, - "EnableAutoHealing": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

Whether to disable auto healing for the layer.

" - } - }, - "AutoAssignElasticIps": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

Whether to automatically assign an Elastic IP\n address to the layer's instances. For more information, see How to Edit\n a Layer.

" - } - }, - "AutoAssignPublicIps": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

For stacks that are running in a VPC, whether to automatically assign a public IP address to\n the layer's instances. For more information, see How to Edit\n a Layer.

" - } - }, - "CustomRecipes": { - "target": "com.amazonaws.opsworks#Recipes", - "traits": { - "smithy.api#documentation": "

A LayerCustomRecipes object that specifies the layer custom recipes.

" - } - }, - "InstallUpdatesOnBoot": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

Whether to install operating system and package updates when the instance boots. The default\n value is true. To control when updates are installed, set this value to\n false. You must then update your instances manually by using\n CreateDeployment to run the update_dependencies stack command or\n by manually running yum (Amazon Linux) or apt-get (Ubuntu) on the\n instances.

\n \n

To ensure that your\n instances have the latest security updates, we strongly recommend using the default value of true.

\n " - } - }, - "UseEbsOptimizedInstances": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

Whether to use Amazon EBS-optimized instances.

" - } - }, - "LifecycleEventConfiguration": { - "target": "com.amazonaws.opsworks#LifecycleEventConfiguration", - "traits": { - "smithy.api#documentation": "

A LifeCycleEventConfiguration object that you can use to configure the Shutdown event to\n specify an execution timeout and enable or disable Elastic Load Balancer connection\n draining.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#CreateLayerResult": { - "type": "structure", - "members": { - "LayerId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The layer ID.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the response to a CreateLayer request.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.opsworks#CreateStack": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#CreateStackRequest" - }, - "output": { - "target": "com.amazonaws.opsworks#CreateStackResult" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a new stack. For more information, see Create a New\n Stack.

\n

\n Required Permissions: To use this action, an IAM user must have an attached policy\n that explicitly grants permissions. For more information about user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#CreateStackRequest": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The stack name. Stack names can be a maximum of 64 characters.

", - "smithy.api#required": {} - } - }, - "Region": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The stack's Amazon Web Services Region, such as ap-south-1. For more information about\n Amazon Web Services Regions, see Regions and Endpoints.

\n \n

In the CLI, this API maps to the --stack-region parameter. If the\n --stack-region parameter and the CLI common parameter\n --region are set to the same value, the stack uses a\n regional endpoint. If the --stack-region\n parameter is not set, but the CLI --region parameter is, this also\n results in a stack with a regional endpoint. However, if the\n --region parameter is set to us-east-1, and the\n --stack-region parameter is set to one of the following, then the\n stack uses a legacy or classic region: us-west-1,\n us-west-2, sa-east-1, eu-central-1, eu-west-1, ap-northeast-1, ap-southeast-1,\n ap-southeast-2. In this case, the actual API endpoint of the stack is in\n us-east-1. Only the preceding regions are supported as classic\n regions in the us-east-1 API endpoint. Because it is a best practice to\n choose the regional endpoint that is closest to where you manage Amazon Web Services, we recommend\n that you use regional endpoints for new stacks. The CLI common\n --region parameter always specifies a regional API endpoint; it\n cannot be used to specify a classic OpsWorks Stacks region.

\n ", - "smithy.api#required": {} - } - }, - "VpcId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

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 \n into this VPC. You cannot change the ID later.

\n \n

If the VPC ID corresponds to a default VPC and you have specified either the\n DefaultAvailabilityZone or the DefaultSubnetId parameter only,\n OpsWorks Stacks infers the value of the \n other parameter. If you specify neither parameter, OpsWorks Stacks sets\n these parameters to the first valid Availability Zone for the specified region and the\n corresponding default VPC subnet ID, respectively.

\n

If you specify a nondefault VPC ID, note the following:

\n \n

For more information about how to use OpsWorks Stacks with a VPC, see Running a Stack in a\n VPC. For more information about default VPC and EC2-Classic, see Supported\n Platforms.

" - } - }, - "Attributes": { - "target": "com.amazonaws.opsworks#StackAttributes", - "traits": { - "smithy.api#documentation": "

One or more user-defined key-value pairs to be added to the stack attributes.

" - } - }, - "ServiceRoleArn": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The stack's IAM role, which allows OpsWorks Stacks to work with Amazon Web Services\n resources on your behalf. You must set this parameter to the Amazon Resource Name (ARN) for an\n existing IAM role. For more information about IAM ARNs, see \n Using\n Identifiers.

", - "smithy.api#required": {} - } - }, - "DefaultInstanceProfileArn": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an IAM profile that is the default profile for all of the stack's EC2 instances.\n For more information about IAM ARNs, see Using\n Identifiers.

", - "smithy.api#required": {} - } - }, - "DefaultOs": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The stack's default operating system, which is installed on every instance unless you specify a different operating \n system when you create the instance. You can specify one of the following.

\n \n

The default option is the current Amazon Linux version.\n Not all operating systems are supported with all versions of Chef. For more information about supported operating systems,\n see OpsWorks Stacks Operating Systems.

" - } - }, - "HostnameTheme": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The stack's host name theme, with spaces replaced by underscores. The theme is used to\n generate host names for the stack's instances. By default, HostnameTheme is set\n to Layer_Dependent, which creates host names by appending integers to the layer's\n short name. The other themes are:

\n \n

To obtain a generated host name, call GetHostNameSuggestion, which returns a\n host name based on the current theme.

" - } - }, - "DefaultAvailabilityZone": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The stack's default Availability Zone, which must be in the specified region. For more\n information, see Regions and\n Endpoints. If you also specify a value for DefaultSubnetId, the subnet must\n be in the same zone. For more information, see the VpcId parameter description.\n

" - } - }, - "DefaultSubnetId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The stack's default VPC subnet ID. This parameter is required if you specify a value for the\n VpcId parameter. All instances are launched into this subnet unless you specify\n otherwise when you create the instance. If you also specify a value for\n DefaultAvailabilityZone, the subnet must be in that zone. For information on\n default values and when this parameter is required, see the VpcId parameter\n description.

" - } - }, - "CustomJson": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

A string that contains user-defined, custom JSON. It can be used to override the corresponding default stack configuration \n attribute values or to pass data to recipes. The string should be in the following format:

\n

\n \"{\\\"key1\\\": \\\"value1\\\", \\\"key2\\\": \\\"value2\\\",...}\"\n

\n

For more information about custom JSON, see Use Custom JSON to\n Modify the Stack Configuration Attributes.

" - } - }, - "ConfigurationManager": { - "target": "com.amazonaws.opsworks#StackConfigurationManager", - "traits": { - "smithy.api#documentation": "

The configuration manager. When you create a stack we recommend that you use the configuration manager to specify the \n Chef version: 12, 11.10, or 11.4 for Linux stacks, or 12.2 for Windows stacks. The default value for Linux stacks is \n currently 12.

" - } - }, - "ChefConfiguration": { - "target": "com.amazonaws.opsworks#ChefConfiguration", - "traits": { - "smithy.api#documentation": "

A ChefConfiguration object that specifies whether to enable Berkshelf and the\n Berkshelf version on Chef 11.10 stacks. For more information, see Create a New Stack.

" - } - }, - "UseCustomCookbooks": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

Whether the stack uses custom cookbooks.

" - } - }, - "UseOpsworksSecurityGroups": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

Whether to associate the OpsWorks Stacks built-in security groups with the stack's layers.

\n

OpsWorks Stacks provides a standard set of built-in security groups, one for each layer, which are\n associated with layers by default. With UseOpsworksSecurityGroups you can instead\n provide your own custom security groups. UseOpsworksSecurityGroups has the\n following settings:

\n \n

For more information, see Create a New\n Stack.

" - } - }, - "CustomCookbooksSource": { - "target": "com.amazonaws.opsworks#Source", - "traits": { - "smithy.api#documentation": "

Contains the information required to retrieve an app or cookbook from a repository. For more information, \n see Adding Apps or \n Cookbooks and Recipes.

" - } - }, - "DefaultSshKeyName": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

A default Amazon EC2 key pair name. The default value is none. If you specify a key pair name, \n OpsWorks installs the public key on the instance and you can use the private key with an SSH\n client to log in to the instance. For more information, see Using SSH to\n Communicate with an Instance and Managing SSH\n Access. You can override this setting by specifying a different key pair, or no key\n pair, when you \n create an instance.

" - } - }, - "DefaultRootDeviceType": { - "target": "com.amazonaws.opsworks#RootDeviceType", - "traits": { - "smithy.api#documentation": "

The default root device type. This value is the default for all instances in the stack,\n but you can override it when you create an instance. The default option is\n instance-store. For more information, see Storage for the Root Device.

" - } - }, - "AgentVersion": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The default OpsWorks Stacks agent version. You have the following options:

\n \n

The default setting is the most recent release of the agent. To specify an agent version,\n you must use the complete version number, not the abbreviated number shown on the console.\n For a list of available agent version numbers, call DescribeAgentVersions. AgentVersion cannot be set to Chef 12.2.

\n \n

You can also specify an agent version when you create or update an instance, \n which overrides the stack's default setting.

\n " - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#CreateStackResult": { - "type": "structure", - "members": { - "StackId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The stack ID, which is an opaque string that you use to identify the stack when performing\n actions such as DescribeStacks.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the response to a CreateStack request.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.opsworks#CreateUserProfile": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#CreateUserProfileRequest" - }, - "output": { - "target": "com.amazonaws.opsworks#CreateUserProfileResult" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a new user profile.

\n

\n Required Permissions: To use this action, an IAM user must have an attached policy\n that explicitly grants permissions. For more information about user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#CreateUserProfileRequest": { - "type": "structure", - "members": { - "IamUserArn": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The user's IAM ARN; this can also be a federated user's ARN.

", - "smithy.api#required": {} - } - }, - "SshUsername": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The user's SSH user name. The allowable characters are [a-z], [A-Z], [0-9], '-', and '_'. If\n the specified name includes other punctuation marks, OpsWorks Stacks removes them. For example,\n my.name is changed to myname. If you do not specify an SSH\n user name, OpsWorks Stacks generates one from the IAM user name.

" - } - }, - "SshPublicKey": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The user's public SSH key.

" - } - }, - "AllowSelfManagement": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

Whether users can specify their own SSH public key through the My Settings page. For more\n information, see Setting an IAM\n User's Public SSH Key.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#CreateUserProfileResult": { - "type": "structure", - "members": { - "IamUserArn": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The user's IAM ARN.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the response to a CreateUserProfile request.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.opsworks#DailyAutoScalingSchedule": { - "type": "map", - "key": { - "target": "com.amazonaws.opsworks#Hour" - }, - "value": { - "target": "com.amazonaws.opsworks#Switch" - } - }, - "com.amazonaws.opsworks#DataSource": { - "type": "structure", - "members": { - "Type": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The data source's type, AutoSelectOpsworksMysqlInstance,\n OpsworksMysqlInstance, RdsDbInstance, or None.

" - } - }, - "Arn": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The data source's ARN.

" - } - }, - "DatabaseName": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The database name.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an app's data source.

" - } - }, - "com.amazonaws.opsworks#DataSources": { - "type": "list", - "member": { - "target": "com.amazonaws.opsworks#DataSource" - } - }, - "com.amazonaws.opsworks#DateTime": { - "type": "string" - }, - "com.amazonaws.opsworks#DeleteApp": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#DeleteAppRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a specified app.

\n

\n Required Permissions: To use this action, an IAM user must have a \n Manage permissions\n level for the stack, or an attached policy that explicitly grants permissions. For more\n information on user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#DeleteAppRequest": { - "type": "structure", - "members": { - "AppId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The app ID.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#DeleteInstance": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#DeleteInstanceRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a specified instance, which terminates the associated Amazon EC2 instance. You must stop an instance before \n you can delete it.

\n

For more information, see Deleting\n Instances.

\n

\n Required Permissions: To use this action, an IAM user must have a Manage \n permissions\n level for the stack, or an attached policy that explicitly grants permissions. For more\n information on user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#DeleteInstanceRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance ID.

", - "smithy.api#required": {} - } - }, - "DeleteElasticIp": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

Whether to delete the instance Elastic IP address.

" - } - }, - "DeleteVolumes": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

Whether to delete the instance's Amazon EBS volumes.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#DeleteLayer": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#DeleteLayerRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a specified layer. You must first stop and then delete all associated instances or\n unassign registered instances. For more information, see How to\n Delete a Layer.

\n

\n Required Permissions: To use this action, an IAM user must have a \n Manage permissions\n level for the stack, or an attached policy that explicitly grants permissions. For more\n information on user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#DeleteLayerRequest": { - "type": "structure", - "members": { - "LayerId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The layer ID.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#DeleteStack": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#DeleteStackRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a specified stack. You must first delete all instances, layers, and apps or\n deregister registered instances. For more information, see Shut Down a\n Stack.

\n

\n Required Permissions: To use this action, an IAM user must have a Manage permissions\n level for the stack, or an attached policy that explicitly grants permissions. For more\n information on user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#DeleteStackRequest": { - "type": "structure", - "members": { - "StackId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The stack ID.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#DeleteUserProfile": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#DeleteUserProfileRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a user profile.

\n

\n Required Permissions: To use this action, an IAM user must have an attached \n policy\n that explicitly grants permissions. For more information about user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#DeleteUserProfileRequest": { - "type": "structure", - "members": { - "IamUserArn": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The user's IAM ARN. This can also be a federated user's ARN.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#Deployment": { - "type": "structure", - "members": { - "DeploymentId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The deployment ID.

" - } - }, - "StackId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The stack ID.

" - } - }, - "AppId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The app ID.

" - } - }, - "CreatedAt": { - "target": "com.amazonaws.opsworks#DateTime", - "traits": { - "smithy.api#documentation": "

Date when the deployment was created.

" - } - }, - "CompletedAt": { - "target": "com.amazonaws.opsworks#DateTime", - "traits": { - "smithy.api#documentation": "

Date when the deployment completed.

" - } - }, - "Duration": { - "target": "com.amazonaws.opsworks#Integer", - "traits": { - "smithy.api#documentation": "

The deployment duration.

" - } - }, - "IamUserArn": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The user's IAM ARN.

" - } - }, - "Comment": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

A user-defined comment.

" - } - }, - "Command": { - "target": "com.amazonaws.opsworks#DeploymentCommand", - "traits": { - "smithy.api#documentation": "

Used to specify a stack or deployment command.

" - } - }, - "Status": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The deployment status:

\n " - } - }, - "CustomJson": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

A string that contains user-defined custom JSON. It can be used to override the corresponding default stack configuration \n attribute values for stack or to pass data to recipes. The string should be in the following format:

\n

\n \"{\\\"key1\\\": \\\"value1\\\", \\\"key2\\\": \\\"value2\\\",...}\"\n

\n

For more information on custom JSON, see Use Custom JSON to\n Modify the Stack Configuration Attributes.

" - } - }, - "InstanceIds": { - "target": "com.amazonaws.opsworks#Strings", - "traits": { - "smithy.api#documentation": "

The IDs of the target instances.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a deployment of a stack or app.

" - } - }, - "com.amazonaws.opsworks#DeploymentCommand": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.opsworks#DeploymentCommandName", - "traits": { - "smithy.api#documentation": "

Specifies the operation. You can specify only one command.

\n

For stacks, the following commands are available:

\n \n \n

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.

\n \n

For apps, the following commands are available:

\n ", - "smithy.api#required": {} - } - }, - "Args": { - "target": "com.amazonaws.opsworks#DeploymentCommandArgs", - "traits": { - "smithy.api#documentation": "

The arguments of those commands that take arguments. It should be set to a JSON object with the following format:

\n

\n {\"arg_name1\" : [\"value1\", \"value2\", ...], \"arg_name2\" : [\"value1\", \"value2\", ...],\n ...}\n

\n

The update_dependencies command takes two arguments:

\n \n

For example, to upgrade an instance to Amazon Linux 2018.03, set Args to the\n following.

\n

\n { \"upgrade_os_to\":[\"Amazon Linux 2018.03\"], \"allow_reboot\":[\"true\"] } \n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Used to specify a stack or deployment command.

" - } - }, - "com.amazonaws.opsworks#DeploymentCommandArgs": { - "type": "map", - "key": { - "target": "com.amazonaws.opsworks#String" - }, - "value": { - "target": "com.amazonaws.opsworks#Strings" - } - }, - "com.amazonaws.opsworks#DeploymentCommandName": { - "type": "enum", - "members": { - "install_dependencies": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "install_dependencies" - } - }, - "update_dependencies": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "update_dependencies" - } - }, - "update_custom_cookbooks": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "update_custom_cookbooks" - } - }, - "execute_recipes": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "execute_recipes" - } - }, - "configure": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "configure" - } - }, - "setup": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "setup" - } - }, - "deploy": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "deploy" - } - }, - "rollback": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "rollback" - } - }, - "start": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "start" - } - }, - "stop": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "stop" - } - }, - "restart": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "restart" - } - }, - "undeploy": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "undeploy" - } - } - } - }, - "com.amazonaws.opsworks#Deployments": { - "type": "list", - "member": { - "target": "com.amazonaws.opsworks#Deployment" - } - }, - "com.amazonaws.opsworks#DeregisterEcsCluster": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#DeregisterEcsClusterRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Deregisters a specified Amazon ECS cluster from a stack.\n For more information, see\n \n Resource Management.

\n

\n Required Permissions: To use this action, an IAM user must have a Manage permissions\n level for the stack or an attached policy that explicitly grants permissions. For more\n information on user permissions, see\n https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html.

" - } - }, - "com.amazonaws.opsworks#DeregisterEcsClusterRequest": { - "type": "structure", - "members": { - "EcsClusterArn": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The cluster's Amazon Resource Number (ARN).

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#DeregisterElasticIp": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#DeregisterElasticIpRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Deregisters a specified Elastic IP address. The address can be registered by another\n stack after it is deregistered. For more information, see Resource Management.

\n

\n Required Permissions: To use this action, an IAM user must have a Manage permissions\n level for the stack, or an attached policy that explicitly grants permissions. For more\n information on user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#DeregisterElasticIpRequest": { - "type": "structure", - "members": { - "ElasticIp": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The Elastic IP address.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#DeregisterInstance": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#DeregisterInstanceRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Deregister an instance from OpsWorks Stacks. The instance can be a registered instance (Amazon EC2 or on-premises) or an instance created with OpsWorks. \n This action removes the instance from the stack and returns it to your control.

\n

\n Required Permissions: To use this action, an IAM user must have a Manage permissions\n level for the stack or an attached policy that explicitly grants permissions. For more\n information on user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#DeregisterInstanceRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance ID.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#DeregisterRdsDbInstance": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#DeregisterRdsDbInstanceRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Deregisters an Amazon RDS instance.

\n

\n Required Permissions: To use this action, an IAM user must have a Manage permissions\n level for the stack, or an attached policy that explicitly grants permissions. For more\n information on user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#DeregisterRdsDbInstanceRequest": { - "type": "structure", - "members": { - "RdsDbInstanceArn": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The Amazon RDS instance's ARN.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#DeregisterVolume": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#DeregisterVolumeRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Deregisters an Amazon EBS volume. The volume can then be registered by another stack. For more\n information, see Resource\n Management.

\n

\n Required Permissions: To use this action, an IAM user must have a Manage permissions\n level for the stack, or an attached policy that explicitly grants permissions. For more\n information on user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#DeregisterVolumeRequest": { - "type": "structure", - "members": { - "VolumeId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The OpsWorks Stacks volume ID, which is the GUID that OpsWorks Stacks assigned to the instance \n when you registered the volume with the stack, not the Amazon EC2 volume ID.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#DescribeAgentVersions": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#DescribeAgentVersionsRequest" - }, - "output": { - "target": "com.amazonaws.opsworks#DescribeAgentVersionsResult" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Describes the available OpsWorks Stacks agent versions. You must specify a stack ID or a\n configuration manager. DescribeAgentVersions returns a list of available\n agent versions for the specified stack or configuration manager.

" - } - }, - "com.amazonaws.opsworks#DescribeAgentVersionsRequest": { - "type": "structure", - "members": { - "StackId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The stack ID.

" - } - }, - "ConfigurationManager": { - "target": "com.amazonaws.opsworks#StackConfigurationManager", - "traits": { - "smithy.api#documentation": "

The configuration manager.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#DescribeAgentVersionsResult": { - "type": "structure", - "members": { - "AgentVersions": { - "target": "com.amazonaws.opsworks#AgentVersions", - "traits": { - "smithy.api#documentation": "

The agent versions for the specified stack or configuration manager. Note that this value is the complete version number, \n not the abbreviated number used by the console.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the response to a DescribeAgentVersions request.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.opsworks#DescribeApps": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#DescribeAppsRequest" - }, - "output": { - "target": "com.amazonaws.opsworks#DescribeAppsResult" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Requests a description of a specified set of apps.

\n \n

This call accepts only one resource-identifying parameter.

\n \n

\n Required Permissions: To use this action, an IAM user must have a Show, Deploy, \n or\n Manage permissions level for the stack, or an attached policy that explicitly grants\n permissions. For more information about user permissions, see Managing User\n Permissions.

", - "smithy.waiters#waitable": { - "AppExists": { - "acceptors": [ - { - "state": "success", - "matcher": { - "success": true - } - }, - { - "state": "failure", - "matcher": { - "success": false - } - } - ], - "minDelay": 1 - } - } - } - }, - "com.amazonaws.opsworks#DescribeAppsRequest": { - "type": "structure", - "members": { - "StackId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The app stack ID. If you use this parameter, DescribeApps returns a description\n of the apps in the specified stack.

" - } - }, - "AppIds": { - "target": "com.amazonaws.opsworks#Strings", - "traits": { - "smithy.api#documentation": "

An array of app IDs for the apps to be described. If you use this parameter,\n DescribeApps returns a description of the specified apps. Otherwise, it returns\n a description of every app.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#DescribeAppsResult": { - "type": "structure", - "members": { - "Apps": { - "target": "com.amazonaws.opsworks#Apps", - "traits": { - "smithy.api#documentation": "

An array of App objects that describe the specified apps.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the response to a DescribeApps request.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.opsworks#DescribeCommands": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#DescribeCommandsRequest" - }, - "output": { - "target": "com.amazonaws.opsworks#DescribeCommandsResult" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Describes the results of specified commands.

\n \n

This call accepts only one resource-identifying parameter.

\n \n

\n Required Permissions: To use this action, an IAM user must have a Show, Deploy, or\n Manage permissions level for the stack, or an attached policy that explicitly grants\n permissions. For more information about user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#DescribeCommandsRequest": { - "type": "structure", - "members": { - "DeploymentId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The deployment ID. If you include this parameter, DescribeCommands returns a\n description of the commands associated with the specified deployment.

" - } - }, - "InstanceId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance ID. If you include this parameter, DescribeCommands returns a\n description of the commands associated with the specified instance.

" - } - }, - "CommandIds": { - "target": "com.amazonaws.opsworks#Strings", - "traits": { - "smithy.api#documentation": "

An array of command IDs. If you include this parameter, DescribeCommands returns\n a description of the specified commands. Otherwise, it returns a description of every\n command.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#DescribeCommandsResult": { - "type": "structure", - "members": { - "Commands": { - "target": "com.amazonaws.opsworks#Commands", - "traits": { - "smithy.api#documentation": "

An array of Command objects that describe each of the specified commands.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the response to a DescribeCommands request.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.opsworks#DescribeDeployments": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#DescribeDeploymentsRequest" - }, - "output": { - "target": "com.amazonaws.opsworks#DescribeDeploymentsResult" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Requests a description of a specified set of deployments.

\n \n

This call accepts only one resource-identifying parameter.

\n \n

\n Required Permissions: To use this action, an IAM user must have a Show, Deploy, or\n Manage permissions level for the stack, or an attached policy that explicitly grants\n permissions. For more information about user permissions, see Managing User\n Permissions.

", - "smithy.waiters#waitable": { - "DeploymentSuccessful": { - "documentation": "Wait until a deployment has completed successfully.", - "acceptors": [ - { - "state": "success", - "matcher": { - "output": { - "path": "Deployments[].Status", - "expected": "successful", - "comparator": "allStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "Deployments[].Status", - "expected": "failed", - "comparator": "anyStringEquals" - } - } - } - ], - "minDelay": 15 - } - } - } - }, - "com.amazonaws.opsworks#DescribeDeploymentsRequest": { - "type": "structure", - "members": { - "StackId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The stack ID. If you include this parameter, the command returns a\n description of the commands associated with the specified stack.

" - } - }, - "AppId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The app ID. If you include this parameter, the command returns a\n description of the commands associated with the specified app.

" - } - }, - "DeploymentIds": { - "target": "com.amazonaws.opsworks#Strings", - "traits": { - "smithy.api#documentation": "

An array of deployment IDs to be described. If you include this parameter,\n the command returns a description of the specified deployments.\n Otherwise, it returns a description of every deployment.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#DescribeDeploymentsResult": { - "type": "structure", - "members": { - "Deployments": { - "target": "com.amazonaws.opsworks#Deployments", - "traits": { - "smithy.api#documentation": "

An array of Deployment objects that describe the deployments.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the response to a DescribeDeployments request.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.opsworks#DescribeEcsClusters": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#DescribeEcsClustersRequest" - }, - "output": { - "target": "com.amazonaws.opsworks#DescribeEcsClustersResult" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Describes Amazon ECS clusters that are registered with a stack. If you specify only a stack ID,\n you can use the MaxResults and NextToken parameters to paginate the\n response. However, OpsWorks Stacks currently supports only one cluster per layer, so the result\n set has a maximum of one element.

\n

\n Required Permissions: To use this action, an IAM user must have a Show, Deploy, or\n Manage permissions level for the stack or an attached policy that explicitly grants\n permission. For more information about user permissions, see Managing User\n Permissions.

\n

This call accepts only one resource-identifying parameter.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "EcsClusters", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.opsworks#DescribeEcsClustersRequest": { - "type": "structure", - "members": { - "EcsClusterArns": { - "target": "com.amazonaws.opsworks#Strings", - "traits": { - "smithy.api#documentation": "

A list of ARNs, one for each cluster to be described.

" - } - }, - "StackId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

A stack ID.\n DescribeEcsClusters returns a description of the cluster that is registered with the stack.

" - } - }, - "NextToken": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

If the previous paginated request did not return all of the remaining results,\n the response object'sNextToken parameter value is set to a token.\n To retrieve the next set of results, call DescribeEcsClusters\n again and assign that token to the request object's NextToken parameter.\n If there are no remaining results, the previous response\n object's NextToken parameter is set to null.

" - } - }, - "MaxResults": { - "target": "com.amazonaws.opsworks#Integer", - "traits": { - "smithy.api#documentation": "

To receive a paginated response, use this parameter to specify the maximum number\n of results to be returned with a single call. If the number of available results exceeds this maximum, the\n response includes a NextToken value that you can assign\n to the NextToken request parameter to get the next set of results.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#DescribeEcsClustersResult": { - "type": "structure", - "members": { - "EcsClusters": { - "target": "com.amazonaws.opsworks#EcsClusters", - "traits": { - "smithy.api#documentation": "

A list of EcsCluster objects containing the cluster descriptions.

" - } - }, - "NextToken": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

If a paginated request does not return all of the remaining results, this parameter is set to a token that\n you can assign to the request object's NextToken parameter to retrieve the next set of results.\n If the previous paginated request returned all of the remaining results,\n this parameter is set to null.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the response to a DescribeEcsClusters request.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.opsworks#DescribeElasticIps": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#DescribeElasticIpsRequest" - }, - "output": { - "target": "com.amazonaws.opsworks#DescribeElasticIpsResult" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Describes Elastic IP addresses.

\n \n

This call accepts only one resource-identifying parameter.

\n \n

\n Required Permissions: To use this action, an IAM user must have a Show, Deploy, or\n Manage permissions level for the stack, or an attached policy that explicitly grants\n permissions. For more information about user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#DescribeElasticIpsRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance ID. If you include this parameter, DescribeElasticIps returns a\n description of the Elastic IP addresses associated with the specified instance.

" - } - }, - "StackId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

A stack ID. If you include this parameter, DescribeElasticIps returns a\n description of the Elastic IP addresses that are registered with the specified stack.

" - } - }, - "Ips": { - "target": "com.amazonaws.opsworks#Strings", - "traits": { - "smithy.api#documentation": "

An array of Elastic IP addresses to be described. If you include this parameter,\n DescribeElasticIps returns a description of the specified Elastic IP addresses.\n Otherwise, it returns a description of every Elastic IP address.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#DescribeElasticIpsResult": { - "type": "structure", - "members": { - "ElasticIps": { - "target": "com.amazonaws.opsworks#ElasticIps", - "traits": { - "smithy.api#documentation": "

An ElasticIps object that describes the specified Elastic IP addresses.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the response to a DescribeElasticIps request.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.opsworks#DescribeElasticLoadBalancers": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#DescribeElasticLoadBalancersRequest" - }, - "output": { - "target": "com.amazonaws.opsworks#DescribeElasticLoadBalancersResult" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Describes a stack's Elastic Load Balancing instances.

\n \n

This call accepts only one resource-identifying parameter.

\n \n

\n Required Permissions: To use this action, an IAM user must have a Show, Deploy, or\n Manage permissions level for the stack, or an attached policy that explicitly grants\n permissions. For more information about user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#DescribeElasticLoadBalancersRequest": { - "type": "structure", - "members": { - "StackId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

A stack ID. The action describes the stack's Elastic Load Balancing instances.

" - } - }, - "LayerIds": { - "target": "com.amazonaws.opsworks#Strings", - "traits": { - "smithy.api#documentation": "

A list of layer IDs. The action describes the Elastic Load Balancing instances for the specified layers.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#DescribeElasticLoadBalancersResult": { - "type": "structure", - "members": { - "ElasticLoadBalancers": { - "target": "com.amazonaws.opsworks#ElasticLoadBalancers", - "traits": { - "smithy.api#documentation": "

A list of ElasticLoadBalancer objects that describe the specified Elastic Load Balancing\n instances.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the response to a DescribeElasticLoadBalancers request.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.opsworks#DescribeInstances": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#DescribeInstancesRequest" - }, - "output": { - "target": "com.amazonaws.opsworks#DescribeInstancesResult" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Requests a description of a set of instances.

\n \n

This call accepts only one resource-identifying parameter.

\n \n

\n Required Permissions: To use this action, an IAM user must have a Show, Deploy, or\n Manage permissions level for the stack, or an attached policy that explicitly grants\n permissions. For more information about user permissions, see Managing User\n Permissions.

", - "smithy.waiters#waitable": { - "InstanceOnline": { - "documentation": "Wait until OpsWorks instance is online.", - "acceptors": [ - { - "state": "success", - "matcher": { - "output": { - "path": "Instances[].Status", - "expected": "online", - "comparator": "allStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "Instances[].Status", - "expected": "setup_failed", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "Instances[].Status", - "expected": "shutting_down", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "Instances[].Status", - "expected": "start_failed", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "Instances[].Status", - "expected": "stopped", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "Instances[].Status", - "expected": "stopping", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "Instances[].Status", - "expected": "terminating", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "Instances[].Status", - "expected": "terminated", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "Instances[].Status", - "expected": "stop_failed", - "comparator": "anyStringEquals" - } - } - } - ], - "minDelay": 15 - }, - "InstanceRegistered": { - "documentation": "Wait until OpsWorks instance is registered.", - "acceptors": [ - { - "state": "success", - "matcher": { - "output": { - "path": "Instances[].Status", - "expected": "registered", - "comparator": "allStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "Instances[].Status", - "expected": "setup_failed", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "Instances[].Status", - "expected": "shutting_down", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "Instances[].Status", - "expected": "stopped", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "Instances[].Status", - "expected": "stopping", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "Instances[].Status", - "expected": "terminating", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "Instances[].Status", - "expected": "terminated", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "Instances[].Status", - "expected": "stop_failed", - "comparator": "anyStringEquals" - } - } - } - ], - "minDelay": 15 - }, - "InstanceStopped": { - "documentation": "Wait until OpsWorks instance is stopped.", - "acceptors": [ - { - "state": "success", - "matcher": { - "output": { - "path": "Instances[].Status", - "expected": "stopped", - "comparator": "allStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "Instances[].Status", - "expected": "booting", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "Instances[].Status", - "expected": "pending", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "Instances[].Status", - "expected": "rebooting", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "Instances[].Status", - "expected": "requested", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "Instances[].Status", - "expected": "running_setup", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "Instances[].Status", - "expected": "setup_failed", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "Instances[].Status", - "expected": "start_failed", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "Instances[].Status", - "expected": "stop_failed", - "comparator": "anyStringEquals" - } - } - } - ], - "minDelay": 15 - }, - "InstanceTerminated": { - "documentation": "Wait until OpsWorks instance is terminated.", - "acceptors": [ - { - "state": "success", - "matcher": { - "output": { - "path": "Instances[].Status", - "expected": "terminated", - "comparator": "allStringEquals" - } - } - }, - { - "state": "success", - "matcher": { - "errorType": "ResourceNotFoundException" - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "Instances[].Status", - "expected": "booting", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "Instances[].Status", - "expected": "online", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "Instances[].Status", - "expected": "pending", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "Instances[].Status", - "expected": "rebooting", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "Instances[].Status", - "expected": "requested", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "Instances[].Status", - "expected": "running_setup", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "Instances[].Status", - "expected": "setup_failed", - "comparator": "anyStringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "Instances[].Status", - "expected": "start_failed", - "comparator": "anyStringEquals" - } - } - } - ], - "minDelay": 15 - } - } - } - }, - "com.amazonaws.opsworks#DescribeInstancesRequest": { - "type": "structure", - "members": { - "StackId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

A stack ID. If you use this parameter, DescribeInstances returns descriptions of\n the instances associated with the specified stack.

" - } - }, - "LayerId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

A layer ID. If you use this parameter, DescribeInstances returns descriptions of\n the instances associated with the specified layer.

" - } - }, - "InstanceIds": { - "target": "com.amazonaws.opsworks#Strings", - "traits": { - "smithy.api#documentation": "

An array of instance IDs to be described. If you use this parameter,\n DescribeInstances returns a description of the specified instances. Otherwise,\n it returns a description of every instance.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#DescribeInstancesResult": { - "type": "structure", - "members": { - "Instances": { - "target": "com.amazonaws.opsworks#Instances", - "traits": { - "smithy.api#documentation": "

An array of Instance objects that describe the instances.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the response to a DescribeInstances request.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.opsworks#DescribeLayers": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#DescribeLayersRequest" - }, - "output": { - "target": "com.amazonaws.opsworks#DescribeLayersResult" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Requests a description of one or more layers in a specified stack.

\n \n

This call accepts only one resource-identifying parameter.

\n \n

\n Required Permissions: To use this action, an IAM user must have a Show, Deploy, or\n Manage permissions level for the stack, or an attached policy that explicitly grants\n permissions. For more information about user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#DescribeLayersRequest": { - "type": "structure", - "members": { - "StackId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The stack ID.

" - } - }, - "LayerIds": { - "target": "com.amazonaws.opsworks#Strings", - "traits": { - "smithy.api#documentation": "

An array of layer IDs that specify the layers to be described. If you omit this parameter,\n DescribeLayers returns a description of every layer in the specified stack.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#DescribeLayersResult": { - "type": "structure", - "members": { - "Layers": { - "target": "com.amazonaws.opsworks#Layers", - "traits": { - "smithy.api#documentation": "

An array of Layer objects that describe the layers.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the response to a DescribeLayers request.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.opsworks#DescribeLoadBasedAutoScaling": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#DescribeLoadBasedAutoScalingRequest" - }, - "output": { - "target": "com.amazonaws.opsworks#DescribeLoadBasedAutoScalingResult" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Describes load-based auto scaling configurations for specified layers.

\n \n

You must specify at least one of the parameters.

\n \n

\n Required Permissions: To use this action, an IAM user must have a Show, Deploy, or\n Manage permissions level for the stack, or an attached policy that explicitly grants\n permissions. For more information about user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#DescribeLoadBasedAutoScalingRequest": { - "type": "structure", - "members": { - "LayerIds": { - "target": "com.amazonaws.opsworks#Strings", - "traits": { - "smithy.api#documentation": "

An array of layer IDs.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#DescribeLoadBasedAutoScalingResult": { - "type": "structure", - "members": { - "LoadBasedAutoScalingConfigurations": { - "target": "com.amazonaws.opsworks#LoadBasedAutoScalingConfigurations", - "traits": { - "smithy.api#documentation": "

An array of LoadBasedAutoScalingConfiguration objects that describe each layer's\n configuration.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the response to a DescribeLoadBasedAutoScaling request.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.opsworks#DescribeMyUserProfile": { - "type": "operation", - "input": { - "target": "smithy.api#Unit" - }, - "output": { - "target": "com.amazonaws.opsworks#DescribeMyUserProfileResult" - }, - "traits": { - "smithy.api#documentation": "

Describes a user's SSH information.

\n

\n Required Permissions: To use this action, an IAM user must have self-management\n enabled or an attached policy that explicitly grants permissions. For more information about user\n permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#DescribeMyUserProfileResult": { - "type": "structure", - "members": { - "UserProfile": { - "target": "com.amazonaws.opsworks#SelfUserProfile", - "traits": { - "smithy.api#documentation": "

A UserProfile object that describes the user's SSH information.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the response to a DescribeMyUserProfile request.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.opsworks#DescribeOperatingSystems": { - "type": "operation", - "input": { - "target": "smithy.api#Unit" - }, - "output": { - "target": "com.amazonaws.opsworks#DescribeOperatingSystemsResponse" - }, - "traits": { - "smithy.api#documentation": "

Describes the operating systems that are supported by OpsWorks Stacks.

" - } - }, - "com.amazonaws.opsworks#DescribeOperatingSystemsResponse": { - "type": "structure", - "members": { - "OperatingSystems": { - "target": "com.amazonaws.opsworks#OperatingSystems", - "traits": { - "smithy.api#documentation": "

Contains information in response to a DescribeOperatingSystems request.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The response to a DescribeOperatingSystems request.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.opsworks#DescribePermissions": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#DescribePermissionsRequest" - }, - "output": { - "target": "com.amazonaws.opsworks#DescribePermissionsResult" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Describes the permissions for a specified stack.

\n

\n Required Permissions: To use this action, an IAM user must have a Manage permissions\n level for the stack, or an attached policy that explicitly grants permissions. For more\n information on user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#DescribePermissionsRequest": { - "type": "structure", - "members": { - "IamUserArn": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The user's IAM ARN. This can also be a federated user's ARN. For more information about IAM \n ARNs, see Using\n Identifiers.

" - } - }, - "StackId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The stack ID.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#DescribePermissionsResult": { - "type": "structure", - "members": { - "Permissions": { - "target": "com.amazonaws.opsworks#Permissions", - "traits": { - "smithy.api#documentation": "

An array of Permission objects that describe the stack permissions.

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the response to a DescribePermissions request.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.opsworks#DescribeRaidArrays": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#DescribeRaidArraysRequest" - }, - "output": { - "target": "com.amazonaws.opsworks#DescribeRaidArraysResult" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Describe an instance's RAID arrays.

\n \n

This call accepts only one resource-identifying parameter.

\n \n

\n Required Permissions: To use this action, an IAM user must have a Show, Deploy, or\n Manage permissions level for the stack, or an attached policy that explicitly grants\n permissions. For more information about user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#DescribeRaidArraysRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance ID. If you use this parameter, DescribeRaidArrays returns\n descriptions of the RAID arrays associated with the specified instance.

" - } - }, - "StackId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The stack ID.

" - } - }, - "RaidArrayIds": { - "target": "com.amazonaws.opsworks#Strings", - "traits": { - "smithy.api#documentation": "

An array of RAID array IDs. If you use this parameter, DescribeRaidArrays\n returns descriptions of the specified arrays. Otherwise, it returns a description of every\n array.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#DescribeRaidArraysResult": { - "type": "structure", - "members": { - "RaidArrays": { - "target": "com.amazonaws.opsworks#RaidArrays", - "traits": { - "smithy.api#documentation": "

A RaidArrays object that describes the specified RAID arrays.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the response to a DescribeRaidArrays request.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.opsworks#DescribeRdsDbInstances": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#DescribeRdsDbInstancesRequest" - }, - "output": { - "target": "com.amazonaws.opsworks#DescribeRdsDbInstancesResult" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Describes Amazon RDS instances.

\n

\n Required Permissions: To use this action, an IAM user must have a Show, Deploy, or\n Manage permissions level for the stack, or an attached policy that explicitly grants\n permissions. For more information about user permissions, see Managing User\n Permissions.

\n

This call accepts only one resource-identifying parameter.

" - } - }, - "com.amazonaws.opsworks#DescribeRdsDbInstancesRequest": { - "type": "structure", - "members": { - "StackId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The ID of the stack with which the instances are registered. The operation returns descriptions of all registered \n Amazon RDS instances.

", - "smithy.api#required": {} - } - }, - "RdsDbInstanceArns": { - "target": "com.amazonaws.opsworks#Strings", - "traits": { - "smithy.api#documentation": "

An array containing the ARNs of the instances to be described.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#DescribeRdsDbInstancesResult": { - "type": "structure", - "members": { - "RdsDbInstances": { - "target": "com.amazonaws.opsworks#RdsDbInstances", - "traits": { - "smithy.api#documentation": "

An a array of RdsDbInstance objects that describe the instances.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the response to a DescribeRdsDbInstances request.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.opsworks#DescribeServiceErrors": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#DescribeServiceErrorsRequest" - }, - "output": { - "target": "com.amazonaws.opsworks#DescribeServiceErrorsResult" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Describes OpsWorks Stacks service errors.

\n

\n Required Permissions: To use this action, an IAM user must have a Show, Deploy, or\n Manage permissions level for the stack, or an attached policy that explicitly grants\n permissions. For more information about user permissions, see Managing User\n Permissions.

\n

This call accepts only one resource-identifying parameter.

" - } - }, - "com.amazonaws.opsworks#DescribeServiceErrorsRequest": { - "type": "structure", - "members": { - "StackId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The stack ID. If you use this parameter, DescribeServiceErrors returns\n descriptions of the errors associated with the specified stack.

" - } - }, - "InstanceId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance ID. If you use this parameter, DescribeServiceErrors returns\n descriptions of the errors associated with the specified instance.

" - } - }, - "ServiceErrorIds": { - "target": "com.amazonaws.opsworks#Strings", - "traits": { - "smithy.api#documentation": "

An array of service error IDs. If you use this parameter, DescribeServiceErrors\n returns descriptions of the specified errors. Otherwise, it returns a description of every\n error.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#DescribeServiceErrorsResult": { - "type": "structure", - "members": { - "ServiceErrors": { - "target": "com.amazonaws.opsworks#ServiceErrors", - "traits": { - "smithy.api#documentation": "

An array of ServiceError objects that describe the specified service errors.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the response to a DescribeServiceErrors request.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.opsworks#DescribeStackProvisioningParameters": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#DescribeStackProvisioningParametersRequest" - }, - "output": { - "target": "com.amazonaws.opsworks#DescribeStackProvisioningParametersResult" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Requests a description of a stack's provisioning parameters.

\n

\n Required Permissions: To use this action, an IAM user must have a Show, Deploy, or\n Manage permissions level for the stack or an attached policy that explicitly grants\n permissions. For more information about user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#DescribeStackProvisioningParametersRequest": { - "type": "structure", - "members": { - "StackId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The stack ID.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#DescribeStackProvisioningParametersResult": { - "type": "structure", - "members": { - "AgentInstallerUrl": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The OpsWorks Stacks agent installer's URL.

" - } - }, - "Parameters": { - "target": "com.amazonaws.opsworks#Parameters", - "traits": { - "smithy.api#documentation": "

An embedded object that contains the provisioning parameters.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the response to a DescribeStackProvisioningParameters request.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.opsworks#DescribeStackSummary": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#DescribeStackSummaryRequest" - }, - "output": { - "target": "com.amazonaws.opsworks#DescribeStackSummaryResult" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Describes the number of layers and apps in a specified stack, and the number of instances in\n each state, such as running_setup or online.

\n

\n Required Permissions: To use this action, an IAM user must have a Show, Deploy, or\n Manage permissions level for the stack, or an attached policy that explicitly grants\n permissions. For more information about user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#DescribeStackSummaryRequest": { - "type": "structure", - "members": { - "StackId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The stack ID.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#DescribeStackSummaryResult": { - "type": "structure", - "members": { - "StackSummary": { - "target": "com.amazonaws.opsworks#StackSummary", - "traits": { - "smithy.api#documentation": "

A StackSummary object that contains the results.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the response to a DescribeStackSummary request.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.opsworks#DescribeStacks": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#DescribeStacksRequest" - }, - "output": { - "target": "com.amazonaws.opsworks#DescribeStacksResult" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Requests a description of one or more stacks.

\n

\n Required Permissions: To use this action, an IAM user must have a Show, Deploy, or\n Manage permissions level for the stack, or an attached policy that explicitly grants\n permissions. For more information about user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#DescribeStacksRequest": { - "type": "structure", - "members": { - "StackIds": { - "target": "com.amazonaws.opsworks#Strings", - "traits": { - "smithy.api#documentation": "

An array of stack IDs that specify the stacks to be described. If you omit this parameter, and have permissions to get information \n about all stacks, DescribeStacks returns a description of every stack. If the IAM policy that is attached to an IAM \n user limits the DescribeStacks action to specific stack ARNs, this parameter is required, and the user must specify a stack ARN that is allowed by the policy. \n Otherwise, DescribeStacks returns an AccessDenied error.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#DescribeStacksResult": { - "type": "structure", - "members": { - "Stacks": { - "target": "com.amazonaws.opsworks#Stacks", - "traits": { - "smithy.api#documentation": "

An array of Stack objects that describe the stacks.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the response to a DescribeStacks request.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.opsworks#DescribeTimeBasedAutoScaling": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#DescribeTimeBasedAutoScalingRequest" - }, - "output": { - "target": "com.amazonaws.opsworks#DescribeTimeBasedAutoScalingResult" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Describes time-based auto scaling configurations for specified instances.

\n \n

You must specify at least one of the parameters.

\n \n

\n Required Permissions: To use this action, an IAM user must have a Show, Deploy, or\n Manage permissions level for the stack, or an attached policy that explicitly grants\n permissions. For more information about user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#DescribeTimeBasedAutoScalingRequest": { - "type": "structure", - "members": { - "InstanceIds": { - "target": "com.amazonaws.opsworks#Strings", - "traits": { - "smithy.api#documentation": "

An array of instance IDs.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#DescribeTimeBasedAutoScalingResult": { - "type": "structure", - "members": { - "TimeBasedAutoScalingConfigurations": { - "target": "com.amazonaws.opsworks#TimeBasedAutoScalingConfigurations", - "traits": { - "smithy.api#documentation": "

An array of TimeBasedAutoScalingConfiguration objects that describe the\n configuration for the specified instances.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the response to a DescribeTimeBasedAutoScaling request.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.opsworks#DescribeUserProfiles": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#DescribeUserProfilesRequest" - }, - "output": { - "target": "com.amazonaws.opsworks#DescribeUserProfilesResult" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Describe specified users.

\n

\n Required Permissions: To use this action, an IAM user must have an attached policy\n that explicitly grants permissions. For more information about user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#DescribeUserProfilesRequest": { - "type": "structure", - "members": { - "IamUserArns": { - "target": "com.amazonaws.opsworks#Strings", - "traits": { - "smithy.api#documentation": "

An array of IAM or federated user ARNs that identify the users to be described.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#DescribeUserProfilesResult": { - "type": "structure", - "members": { - "UserProfiles": { - "target": "com.amazonaws.opsworks#UserProfiles", - "traits": { - "smithy.api#documentation": "

A Users object that describes the specified users.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the response to a DescribeUserProfiles request.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.opsworks#DescribeVolumes": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#DescribeVolumesRequest" - }, - "output": { - "target": "com.amazonaws.opsworks#DescribeVolumesResult" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Describes an instance's Amazon EBS volumes.

\n \n

This call accepts only one resource-identifying parameter.

\n \n

\n Required Permissions: To use this action, an IAM user must have a Show, Deploy, or\n Manage permissions level for the stack, or an attached policy that explicitly grants\n permissions. For more information about user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#DescribeVolumesRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance ID. If you use this parameter, DescribeVolumes returns descriptions\n of the volumes associated with the specified instance.

" - } - }, - "StackId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

A stack ID. The action describes the stack's registered Amazon EBS volumes.

" - } - }, - "RaidArrayId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The RAID array ID. If you use this parameter, DescribeVolumes returns\n descriptions of the volumes associated with the specified RAID array.

" - } - }, - "VolumeIds": { - "target": "com.amazonaws.opsworks#Strings", - "traits": { - "smithy.api#documentation": "

Am array of volume IDs. If you use this parameter, DescribeVolumes returns\n descriptions of the specified volumes. Otherwise, it returns a description of every\n volume.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#DescribeVolumesResult": { - "type": "structure", - "members": { - "Volumes": { - "target": "com.amazonaws.opsworks#Volumes", - "traits": { - "smithy.api#documentation": "

An array of volume IDs.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the response to a DescribeVolumes request.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.opsworks#DetachElasticLoadBalancer": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#DetachElasticLoadBalancerRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

Detaches a specified Elastic Load Balancing instance from its layer.

\n

\n Required Permissions: To use this action, an IAM user must have a Manage \n permissions\n level for the stack, or an attached policy that explicitly grants permissions. For more\n information on user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#DetachElasticLoadBalancerRequest": { - "type": "structure", - "members": { - "ElasticLoadBalancerName": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The Elastic Load Balancing instance's name.

", - "smithy.api#required": {} - } - }, - "LayerId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The ID of the layer that the Elastic Load Balancing instance is attached to.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#DisassociateElasticIp": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#DisassociateElasticIpRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Disassociates an Elastic IP address from its instance. The address remains registered with\n the stack. For more information, see Resource Management.

\n

\n Required Permissions: To use this action, an IAM user must have a Manage permissions\n level for the stack, or an attached policy that explicitly grants permissions. For more\n information on user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#DisassociateElasticIpRequest": { - "type": "structure", - "members": { - "ElasticIp": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The Elastic IP address.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#Double": { - "type": "double" - }, - "com.amazonaws.opsworks#EbsBlockDevice": { - "type": "structure", - "members": { - "SnapshotId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The snapshot ID.

" - } - }, - "Iops": { - "target": "com.amazonaws.opsworks#Integer", - "traits": { - "smithy.api#documentation": "

The number of I/O operations per second (IOPS) that the volume supports. For more\n information, see EbsBlockDevice.

" - } - }, - "VolumeSize": { - "target": "com.amazonaws.opsworks#Integer", - "traits": { - "smithy.api#documentation": "

The volume size, in GiB. For more information, see EbsBlockDevice.

" - } - }, - "VolumeType": { - "target": "com.amazonaws.opsworks#VolumeType", - "traits": { - "smithy.api#documentation": "

The volume type. gp2 for General Purpose (SSD) volumes, io1 for\n Provisioned IOPS (SSD) volumes, st1 for Throughput Optimized hard disk drives (HDD), sc1 for Cold HDD,and standard for Magnetic volumes.

\n

If you specify the io1 volume type, you must also specify a value for the Iops attribute. \n The maximum ratio of provisioned IOPS to requested volume size (in GiB) is 50:1. Amazon Web Services uses the default volume size (in GiB) \n specified in the AMI attributes to set IOPS to 50 x (volume size).

" - } - }, - "DeleteOnTermination": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

Whether the volume is deleted on instance termination.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an Amazon EBS volume. This data type maps directly to the Amazon EC2 EbsBlockDevice\n data type.

" - } - }, - "com.amazonaws.opsworks#EcsCluster": { - "type": "structure", - "members": { - "EcsClusterArn": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The cluster's ARN.

" - } - }, - "EcsClusterName": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The cluster name.

" - } - }, - "StackId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The stack ID.

" - } - }, - "RegisteredAt": { - "target": "com.amazonaws.opsworks#DateTime", - "traits": { - "smithy.api#documentation": "

The time and date that the cluster was registered with the stack.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a registered Amazon ECS cluster.

" - } - }, - "com.amazonaws.opsworks#EcsClusters": { - "type": "list", - "member": { - "target": "com.amazonaws.opsworks#EcsCluster" - } - }, - "com.amazonaws.opsworks#ElasticIp": { - "type": "structure", - "members": { - "Ip": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The IP address.

" - } - }, - "Name": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The name, which can be a maximum of 32 characters.

" - } - }, - "Domain": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The domain.

" - } - }, - "Region": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services Region. For more information, see Regions and Endpoints.

" - } - }, - "InstanceId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The ID of the instance that the address is attached to.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an Elastic IP address.

" - } - }, - "com.amazonaws.opsworks#ElasticIps": { - "type": "list", - "member": { - "target": "com.amazonaws.opsworks#ElasticIp" - } - }, - "com.amazonaws.opsworks#ElasticLoadBalancer": { - "type": "structure", - "members": { - "ElasticLoadBalancerName": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The Elastic Load Balancing instance name.

" - } - }, - "Region": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance's Amazon Web Services Region.

" - } - }, - "DnsName": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance's public DNS name.

" - } - }, - "StackId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The ID of the stack with which the instance is associated.

" - } - }, - "LayerId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The ID of the layer to which the instance is attached.

" - } - }, - "VpcId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The VPC ID.

" - } - }, - "AvailabilityZones": { - "target": "com.amazonaws.opsworks#Strings", - "traits": { - "smithy.api#documentation": "

A list of Availability Zones.

" - } - }, - "SubnetIds": { - "target": "com.amazonaws.opsworks#Strings", - "traits": { - "smithy.api#documentation": "

A list of subnet IDs, if the stack is running in a VPC.

" - } - }, - "Ec2InstanceIds": { - "target": "com.amazonaws.opsworks#Strings", - "traits": { - "smithy.api#documentation": "

A list of the EC2 instances for which the Elastic Load Balancing instance is managing traffic.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an Elastic Load Balancing instance.

" - } - }, - "com.amazonaws.opsworks#ElasticLoadBalancers": { - "type": "list", - "member": { - "target": "com.amazonaws.opsworks#ElasticLoadBalancer" - } - }, - "com.amazonaws.opsworks#EnvironmentVariable": { - "type": "structure", - "members": { - "Key": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

(Required) The environment variable's name, which can consist of up to 64 characters and must be specified. \n The name can contain upper- and lowercase letters, numbers, and underscores (_), but it must start with a letter or underscore.

", - "smithy.api#required": {} - } - }, - "Value": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

(Optional) The environment variable's value, which can be left empty. If you specify a value, \n it can contain up to 256 characters, which must all be printable.

", - "smithy.api#required": {} - } - }, - "Secure": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

(Optional) Whether the variable's value is returned by the DescribeApps action.\n To hide an environment variable's value, set Secure to true.\n DescribeApps returns *****FILTERED***** instead of the actual\n value. The default value for Secure is false.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Represents an app's environment variable.

" - } - }, - "com.amazonaws.opsworks#EnvironmentVariables": { - "type": "list", - "member": { - "target": "com.amazonaws.opsworks#EnvironmentVariable" - } - }, - "com.amazonaws.opsworks#GetHostnameSuggestion": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#GetHostnameSuggestionRequest" - }, - "output": { - "target": "com.amazonaws.opsworks#GetHostnameSuggestionResult" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Gets a generated host name for the specified layer, based on the current host name theme.

\n

\n Required Permissions: To use this action, an IAM user must have a Manage permissions\n level for the stack, or an attached policy that explicitly grants permissions. For more\n information on user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#GetHostnameSuggestionRequest": { - "type": "structure", - "members": { - "LayerId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The layer ID.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#GetHostnameSuggestionResult": { - "type": "structure", - "members": { - "LayerId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The layer ID.

" - } - }, - "Hostname": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The generated host name.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the response to a GetHostnameSuggestion request.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.opsworks#GrantAccess": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#GrantAccessRequest" - }, - "output": { - "target": "com.amazonaws.opsworks#GrantAccessResult" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "\n

This action can be used only with Windows stacks.

\n \n

Grants RDP access to a Windows instance for a specified time period.

" - } - }, - "com.amazonaws.opsworks#GrantAccessRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance's OpsWorks Stacks ID.

", - "smithy.api#required": {} - } - }, - "ValidForInMinutes": { - "target": "com.amazonaws.opsworks#ValidForInMinutes", - "traits": { - "smithy.api#documentation": "

The length of time (in minutes) that the grant is valid. When the grant expires at the end of this period, \n the user will no longer be able to use the credentials to log in. If the user is logged in at the time, they are \n logged out.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#GrantAccessResult": { - "type": "structure", - "members": { - "TemporaryCredential": { - "target": "com.amazonaws.opsworks#TemporaryCredential", - "traits": { - "smithy.api#documentation": "

A TemporaryCredential object that contains the data needed to log in to the\n instance by RDP clients, such as the Microsoft Remote Desktop Connection.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the response to a GrantAccess request.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.opsworks#Hour": { - "type": "string" - }, - "com.amazonaws.opsworks#Instance": { - "type": "structure", - "members": { - "AgentVersion": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The agent version. This parameter is set to INHERIT if\n the instance inherits the default stack setting or to a\n a version number for a fixed agent version.

" - } - }, - "AmiId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

A custom AMI ID to be used to create the instance. For more\n information, see Instances\n

" - } - }, - "Architecture": { - "target": "com.amazonaws.opsworks#Architecture", - "traits": { - "smithy.api#documentation": "

The instance architecture: \"i386\" or \"x86_64\".

" - } - }, - "Arn": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance's Amazon Resource Number (ARN).

" - } - }, - "AutoScalingType": { - "target": "com.amazonaws.opsworks#AutoScalingType", - "traits": { - "smithy.api#documentation": "

For load-based or time-based instances, the type.

" - } - }, - "AvailabilityZone": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance Availability Zone. For more information, see Regions and Endpoints.

" - } - }, - "BlockDeviceMappings": { - "target": "com.amazonaws.opsworks#BlockDeviceMappings", - "traits": { - "smithy.api#documentation": "

An array of BlockDeviceMapping objects that specify the instance's block device\n mappings.

" - } - }, - "CreatedAt": { - "target": "com.amazonaws.opsworks#DateTime", - "traits": { - "smithy.api#documentation": "

The time that the instance was created.

" - } - }, - "EbsOptimized": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

Whether this is an Amazon EBS-optimized instance.

" - } - }, - "Ec2InstanceId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The ID of the associated Amazon EC2 instance.

" - } - }, - "EcsClusterArn": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

For container instances, the Amazon ECS cluster's ARN.

" - } - }, - "EcsContainerInstanceArn": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

For container instances, the instance's ARN.

" - } - }, - "ElasticIp": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance Elastic IP address.

" - } - }, - "Hostname": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance host name. The following are character limits for instance host names.

\n " - } - }, - "InfrastructureClass": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

For registered instances, the infrastructure class: ec2 or\n on-premises.

" - } - }, - "InstallUpdatesOnBoot": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

Whether to install operating system and package updates when the instance boots. The default\n value is true. If this value is set to false, you must update\n instances manually by using CreateDeployment to run the\n update_dependencies stack command or\n by manually running yum (Amazon\n Linux) or apt-get (Ubuntu) on the instances.

\n \n

We strongly recommend using the default value of true to ensure that your\n instances have the latest security updates.

\n " - } - }, - "InstanceId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance ID.

" - } - }, - "InstanceProfileArn": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The ARN of the instance's IAM profile. For more information about IAM ARNs, \n see Using\n Identifiers.

" - } - }, - "InstanceType": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance type, such as t2.micro.

" - } - }, - "LastServiceErrorId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The ID of the last service error. For more information, call\n DescribeServiceErrors.

" - } - }, - "LayerIds": { - "target": "com.amazonaws.opsworks#Strings", - "traits": { - "smithy.api#documentation": "

An array containing the instance layer IDs.

" - } - }, - "Os": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance's operating system.

" - } - }, - "Platform": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance's platform.

" - } - }, - "PrivateDns": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance's private DNS name.

" - } - }, - "PrivateIp": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance's private IP address.

" - } - }, - "PublicDns": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance public DNS name.

" - } - }, - "PublicIp": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance public IP address.

" - } - }, - "RegisteredBy": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

For registered instances, who performed the registration.

" - } - }, - "ReportedAgentVersion": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance's reported OpsWorks Stacks agent version.

" - } - }, - "ReportedOs": { - "target": "com.amazonaws.opsworks#ReportedOs", - "traits": { - "smithy.api#documentation": "

For registered instances, the reported operating system.

" - } - }, - "RootDeviceType": { - "target": "com.amazonaws.opsworks#RootDeviceType", - "traits": { - "smithy.api#documentation": "

The instance's root device type. For more information, see Storage for the Root Device.

" - } - }, - "RootDeviceVolumeId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The root device volume ID.

" - } - }, - "SecurityGroupIds": { - "target": "com.amazonaws.opsworks#Strings", - "traits": { - "smithy.api#documentation": "

An array containing the instance security group IDs.

" - } - }, - "SshHostDsaKeyFingerprint": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The SSH key's Deep Security Agent (DSA) fingerprint.

" - } - }, - "SshHostRsaKeyFingerprint": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The SSH key's RSA fingerprint.

" - } - }, - "SshKeyName": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance's Amazon EC2 key-pair name.

" - } - }, - "StackId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The stack ID.

" - } - }, - "Status": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance status:

\n " - } - }, - "SubnetId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance's subnet ID; applicable only if the stack is running in a VPC.

" - } - }, - "Tenancy": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance's tenancy option, such as dedicated or host.

" - } - }, - "VirtualizationType": { - "target": "com.amazonaws.opsworks#VirtualizationType", - "traits": { - "smithy.api#documentation": "

The instance's virtualization type: paravirtual or hvm.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an instance.

" - } - }, - "com.amazonaws.opsworks#InstanceIdentity": { - "type": "structure", - "members": { - "Document": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

A JSON document that contains the metadata.

" - } - }, - "Signature": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

A signature that can be used to verify the document's accuracy and authenticity.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains a description of an Amazon EC2 instance from the Amazon EC2 metadata service. For more\n information, see Instance Metadata and User Data.

" - } - }, - "com.amazonaws.opsworks#Instances": { - "type": "list", - "member": { - "target": "com.amazonaws.opsworks#Instance" - } - }, - "com.amazonaws.opsworks#InstancesCount": { - "type": "structure", - "members": { - "Assigning": { - "target": "com.amazonaws.opsworks#Integer", - "traits": { - "smithy.api#documentation": "

The number of instances in the Assigning state.

" - } - }, - "Booting": { - "target": "com.amazonaws.opsworks#Integer", - "traits": { - "smithy.api#documentation": "

The number of instances with booting status.

" - } - }, - "ConnectionLost": { - "target": "com.amazonaws.opsworks#Integer", - "traits": { - "smithy.api#documentation": "

The number of instances with connection_lost status.

" - } - }, - "Deregistering": { - "target": "com.amazonaws.opsworks#Integer", - "traits": { - "smithy.api#documentation": "

The number of instances in the Deregistering state.

" - } - }, - "Online": { - "target": "com.amazonaws.opsworks#Integer", - "traits": { - "smithy.api#documentation": "

The number of instances with online status.

" - } - }, - "Pending": { - "target": "com.amazonaws.opsworks#Integer", - "traits": { - "smithy.api#documentation": "

The number of instances with pending status.

" - } - }, - "Rebooting": { - "target": "com.amazonaws.opsworks#Integer", - "traits": { - "smithy.api#documentation": "

The number of instances with rebooting status.

" - } - }, - "Registered": { - "target": "com.amazonaws.opsworks#Integer", - "traits": { - "smithy.api#documentation": "

The number of instances in the Registered state.

" - } - }, - "Registering": { - "target": "com.amazonaws.opsworks#Integer", - "traits": { - "smithy.api#documentation": "

The number of instances in the Registering state.

" - } - }, - "Requested": { - "target": "com.amazonaws.opsworks#Integer", - "traits": { - "smithy.api#documentation": "

The number of instances with requested status.

" - } - }, - "RunningSetup": { - "target": "com.amazonaws.opsworks#Integer", - "traits": { - "smithy.api#documentation": "

The number of instances with running_setup status.

" - } - }, - "SetupFailed": { - "target": "com.amazonaws.opsworks#Integer", - "traits": { - "smithy.api#documentation": "

The number of instances with setup_failed status.

" - } - }, - "ShuttingDown": { - "target": "com.amazonaws.opsworks#Integer", - "traits": { - "smithy.api#documentation": "

The number of instances with shutting_down status.

" - } - }, - "StartFailed": { - "target": "com.amazonaws.opsworks#Integer", - "traits": { - "smithy.api#documentation": "

The number of instances with start_failed status.

" - } - }, - "StopFailed": { - "target": "com.amazonaws.opsworks#Integer", - "traits": { - "smithy.api#documentation": "

The number of instances with stop_failed status.

" - } - }, - "Stopped": { - "target": "com.amazonaws.opsworks#Integer", - "traits": { - "smithy.api#documentation": "

The number of instances with stopped status.

" - } - }, - "Stopping": { - "target": "com.amazonaws.opsworks#Integer", - "traits": { - "smithy.api#documentation": "

The number of instances with stopping status.

" - } - }, - "Terminated": { - "target": "com.amazonaws.opsworks#Integer", - "traits": { - "smithy.api#documentation": "

The number of instances with terminated status.

" - } - }, - "Terminating": { - "target": "com.amazonaws.opsworks#Integer", - "traits": { - "smithy.api#documentation": "

The number of instances with terminating status.

" - } - }, - "Unassigning": { - "target": "com.amazonaws.opsworks#Integer", - "traits": { - "smithy.api#documentation": "

The number of instances in the Unassigning state.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes how many instances a stack has for each status.

" - } - }, - "com.amazonaws.opsworks#Integer": { - "type": "integer" - }, - "com.amazonaws.opsworks#Layer": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Number (ARN) of a layer.

" - } - }, - "StackId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The layer stack ID.

" - } - }, - "LayerId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The layer ID.

" - } - }, - "Type": { - "target": "com.amazonaws.opsworks#LayerType", - "traits": { - "smithy.api#documentation": "

The layer type.

" - } - }, - "Name": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The layer name. Layer names can be a maximum of 32 characters.

" - } - }, - "Shortname": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The layer short name.

" - } - }, - "Attributes": { - "target": "com.amazonaws.opsworks#LayerAttributes", - "traits": { - "smithy.api#documentation": "

The layer attributes.

\n

For the HaproxyStatsPassword, MysqlRootPassword, and\n GangliaPassword attributes, OpsWorks Stacks returns *****FILTERED*****\n instead of the actual value

\n

For an ECS Cluster layer, OpsWorks Stacks the EcsClusterArn attribute is set to the cluster's ARN.

" - } - }, - "CloudWatchLogsConfiguration": { - "target": "com.amazonaws.opsworks#CloudWatchLogsConfiguration", - "traits": { - "smithy.api#documentation": "

The Amazon CloudWatch Logs configuration settings for the layer.

" - } - }, - "CustomInstanceProfileArn": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The ARN of the default IAM profile to be used for the layer's EC2 instances. For more\n information about IAM ARNs, see Using\n Identifiers.

" - } - }, - "CustomJson": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

A JSON formatted string containing the layer's custom stack configuration and deployment attributes.

" - } - }, - "CustomSecurityGroupIds": { - "target": "com.amazonaws.opsworks#Strings", - "traits": { - "smithy.api#documentation": "

An array containing the layer's custom security group IDs.

" - } - }, - "DefaultSecurityGroupNames": { - "target": "com.amazonaws.opsworks#Strings", - "traits": { - "smithy.api#documentation": "

An array containing the layer's security group names.

" - } - }, - "Packages": { - "target": "com.amazonaws.opsworks#Strings", - "traits": { - "smithy.api#documentation": "

An array of Package objects that describe the layer's packages.

" - } - }, - "VolumeConfigurations": { - "target": "com.amazonaws.opsworks#VolumeConfigurations", - "traits": { - "smithy.api#documentation": "

A VolumeConfigurations object that describes the layer's Amazon EBS volumes.

" - } - }, - "EnableAutoHealing": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

Whether auto healing is disabled for the layer.

" - } - }, - "AutoAssignElasticIps": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

Whether to automatically assign an Elastic IP\n address to the layer's instances. For more information, see How to Edit\n a Layer.

" - } - }, - "AutoAssignPublicIps": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

For stacks that are running in a VPC, whether to automatically assign a public IP address to\n the layer's instances. For more information, see How to Edit\n a Layer.

" - } - }, - "DefaultRecipes": { - "target": "com.amazonaws.opsworks#Recipes", - "traits": { - "smithy.api#documentation": "

OpsWorks Stacks supports five lifecycle events: setup, configuration, \n deploy, undeploy, and shutdown.\n For each layer, OpsWorks Stacks runs a set of standard recipes for each event. You can also provide \n custom recipes for any or all layers and events. OpsWorks Stacks runs custom event recipes after the standard \n recipes. LayerCustomRecipes specifies the custom recipes for a particular layer to be run in response to each of \n the five events.

\n

To specify a recipe, use the cookbook's directory name in the repository followed by two colons and the recipe \n name, which is the recipe's file name without the .rb extension. For example: phpapp2::dbsetup specifies the \n dbsetup.rb recipe in the repository's phpapp2 folder.

" - } - }, - "CustomRecipes": { - "target": "com.amazonaws.opsworks#Recipes", - "traits": { - "smithy.api#documentation": "

A LayerCustomRecipes object that specifies the layer's custom recipes.

" - } - }, - "CreatedAt": { - "target": "com.amazonaws.opsworks#DateTime", - "traits": { - "smithy.api#documentation": "

Date when the layer was created.

" - } - }, - "InstallUpdatesOnBoot": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

Whether to install operating system and package updates when the instance boots. The default\n value is true. If this value is set to false, you must then update\n your instances manually by using CreateDeployment to run the\n update_dependencies stack command or manually running yum (Amazon\n Linux) or apt-get (Ubuntu) on the instances.

\n \n

We strongly recommend using the default value of true, to ensure that your\n instances have the latest security updates.

\n " - } - }, - "UseEbsOptimizedInstances": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

Whether the layer uses Amazon EBS-optimized instances.

" - } - }, - "LifecycleEventConfiguration": { - "target": "com.amazonaws.opsworks#LifecycleEventConfiguration", - "traits": { - "smithy.api#documentation": "

A LifeCycleEventConfiguration object that specifies the Shutdown event\n configuration.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a layer.

" - } - }, - "com.amazonaws.opsworks#LayerAttributes": { - "type": "map", - "key": { - "target": "com.amazonaws.opsworks#LayerAttributesKeys" - }, - "value": { - "target": "com.amazonaws.opsworks#String" - } - }, - "com.amazonaws.opsworks#LayerAttributesKeys": { - "type": "enum", - "members": { - "EcsClusterArn": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EcsClusterArn" - } - }, - "EnableHaproxyStats": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EnableHaproxyStats" - } - }, - "HaproxyStatsUrl": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HaproxyStatsUrl" - } - }, - "HaproxyStatsUser": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HaproxyStatsUser" - } - }, - "HaproxyStatsPassword": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HaproxyStatsPassword" - } - }, - "HaproxyHealthCheckUrl": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HaproxyHealthCheckUrl" - } - }, - "HaproxyHealthCheckMethod": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HaproxyHealthCheckMethod" - } - }, - "MysqlRootPassword": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MysqlRootPassword" - } - }, - "MysqlRootPasswordUbiquitous": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MysqlRootPasswordUbiquitous" - } - }, - "GangliaUrl": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GangliaUrl" - } - }, - "GangliaUser": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GangliaUser" - } - }, - "GangliaPassword": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GangliaPassword" - } - }, - "MemcachedMemory": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MemcachedMemory" - } - }, - "NodejsVersion": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NodejsVersion" - } - }, - "RubyVersion": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RubyVersion" - } - }, - "RubygemsVersion": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RubygemsVersion" - } - }, - "ManageBundler": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ManageBundler" - } - }, - "BundlerVersion": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BundlerVersion" - } - }, - "RailsStack": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RailsStack" - } - }, - "PassengerVersion": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PassengerVersion" - } - }, - "Jvm": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Jvm" - } - }, - "JvmVersion": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "JvmVersion" - } - }, - "JvmOptions": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "JvmOptions" - } - }, - "JavaAppServer": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "JavaAppServer" - } - }, - "JavaAppServerVersion": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "JavaAppServerVersion" - } - } - } - }, - "com.amazonaws.opsworks#LayerType": { - "type": "enum", - "members": { - "aws_flow_ruby": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "aws-flow-ruby" - } - }, - "ecs_cluster": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ecs-cluster" - } - }, - "java_app": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "java-app" - } - }, - "lb": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "lb" - } - }, - "web": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "web" - } - }, - "php_app": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "php-app" - } - }, - "rails_app": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "rails-app" - } - }, - "nodejs_app": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "nodejs-app" - } - }, - "memcached": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "memcached" - } - }, - "db_master": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "db-master" - } - }, - "monitoring_master": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "monitoring-master" - } - }, - "custom": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "custom" - } - } - } - }, - "com.amazonaws.opsworks#Layers": { - "type": "list", - "member": { - "target": "com.amazonaws.opsworks#Layer" - } - }, - "com.amazonaws.opsworks#LifecycleEventConfiguration": { - "type": "structure", - "members": { - "Shutdown": { - "target": "com.amazonaws.opsworks#ShutdownEventConfiguration", - "traits": { - "smithy.api#documentation": "

A ShutdownEventConfiguration object that specifies the Shutdown event\n configuration.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies the lifecycle event configuration

" - } - }, - "com.amazonaws.opsworks#ListTags": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#ListTagsRequest" - }, - "output": { - "target": "com.amazonaws.opsworks#ListTagsResult" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns a list of tags that are applied to the specified stack or layer.

" - } - }, - "com.amazonaws.opsworks#ListTagsRequest": { - "type": "structure", - "members": { - "ResourceArn": { - "target": "com.amazonaws.opsworks#ResourceArn", - "traits": { - "smithy.api#documentation": "

The stack or layer's Amazon Resource Number (ARN).

", - "smithy.api#required": {} - } - }, - "MaxResults": { - "target": "com.amazonaws.opsworks#MaxResults", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

Do not use. A validation exception occurs if you add a MaxResults parameter to a ListTagsRequest \n call.\n

" - } - }, - "NextToken": { - "target": "com.amazonaws.opsworks#NextToken", - "traits": { - "smithy.api#documentation": "

Do not use. A validation exception occurs if you add a NextToken parameter to a ListTagsRequest \n call.\n

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#ListTagsResult": { - "type": "structure", - "members": { - "Tags": { - "target": "com.amazonaws.opsworks#Tags", - "traits": { - "smithy.api#documentation": "

A set of key-value pairs that contain tag keys and tag values that are attached to a stack or layer.

" - } - }, - "NextToken": { - "target": "com.amazonaws.opsworks#NextToken", - "traits": { - "smithy.api#documentation": "

If a paginated request does not return all of the remaining results, this parameter is set to a token that\n you can assign to the request object's NextToken parameter to get the next set of results.\n If the previous paginated request returned all of the remaining results,\n this parameter is set to null.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the response to a ListTags request.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.opsworks#LoadBasedAutoScalingConfiguration": { - "type": "structure", - "members": { - "LayerId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The layer ID.

" - } - }, - "Enable": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

Whether load-based auto scaling is enabled for the layer.

" - } - }, - "UpScaling": { - "target": "com.amazonaws.opsworks#AutoScalingThresholds", - "traits": { - "smithy.api#documentation": "

An AutoScalingThresholds object that describes the upscaling configuration,\n which defines how and when OpsWorks Stacks increases the number of instances.

" - } - }, - "DownScaling": { - "target": "com.amazonaws.opsworks#AutoScalingThresholds", - "traits": { - "smithy.api#documentation": "

An AutoScalingThresholds object that describes the downscaling configuration,\n which defines how and when OpsWorks Stacks reduces the number of instances.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a layer's load-based auto scaling configuration.

" - } - }, - "com.amazonaws.opsworks#LoadBasedAutoScalingConfigurations": { - "type": "list", - "member": { - "target": "com.amazonaws.opsworks#LoadBasedAutoScalingConfiguration" - } - }, - "com.amazonaws.opsworks#MaxResults": { - "type": "integer", - "traits": { - "smithy.api#default": 0 - } - }, - "com.amazonaws.opsworks#Minute": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.opsworks#NextToken": { - "type": "string" - }, - "com.amazonaws.opsworks#OperatingSystem": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The name of the operating system, such as Amazon Linux 2.

" - } - }, - "Id": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The ID of a supported operating system, such as Amazon Linux 2.

" - } - }, - "Type": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The type of a supported operating system, either Linux or Windows.

" - } - }, - "ConfigurationManagers": { - "target": "com.amazonaws.opsworks#OperatingSystemConfigurationManagers", - "traits": { - "smithy.api#documentation": "

Supported configuration manager name and versions for an OpsWorks Stacks operating system.

" - } - }, - "ReportedName": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

A short name for the operating system manufacturer.

" - } - }, - "ReportedVersion": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The version of the operating system, including the release and edition, if applicable.

" - } - }, - "Supported": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

Indicates that an operating system is not supported for new instances.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes supported operating systems in OpsWorks Stacks.

" - } - }, - "com.amazonaws.opsworks#OperatingSystemConfigurationManager": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The name of the configuration manager, which is Chef.

" - } - }, - "Version": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The versions of the configuration manager that are supported by an operating system.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A block that contains information about the configuration manager (Chef) and the versions of the \n configuration manager that are supported for an operating system.

" - } - }, - "com.amazonaws.opsworks#OperatingSystemConfigurationManagers": { - "type": "list", - "member": { - "target": "com.amazonaws.opsworks#OperatingSystemConfigurationManager" - } - }, - "com.amazonaws.opsworks#OperatingSystems": { - "type": "list", - "member": { - "target": "com.amazonaws.opsworks#OperatingSystem" - } - }, - "com.amazonaws.opsworks#OpsWorks_20130218": { - "type": "service", - "version": "2013-02-18", - "operations": [ - { - "target": "com.amazonaws.opsworks#AssignInstance" - }, - { - "target": "com.amazonaws.opsworks#AssignVolume" - }, - { - "target": "com.amazonaws.opsworks#AssociateElasticIp" - }, - { - "target": "com.amazonaws.opsworks#AttachElasticLoadBalancer" - }, - { - "target": "com.amazonaws.opsworks#CloneStack" - }, - { - "target": "com.amazonaws.opsworks#CreateApp" - }, - { - "target": "com.amazonaws.opsworks#CreateDeployment" - }, - { - "target": "com.amazonaws.opsworks#CreateInstance" - }, - { - "target": "com.amazonaws.opsworks#CreateLayer" - }, - { - "target": "com.amazonaws.opsworks#CreateStack" - }, - { - "target": "com.amazonaws.opsworks#CreateUserProfile" - }, - { - "target": "com.amazonaws.opsworks#DeleteApp" - }, - { - "target": "com.amazonaws.opsworks#DeleteInstance" - }, - { - "target": "com.amazonaws.opsworks#DeleteLayer" - }, - { - "target": "com.amazonaws.opsworks#DeleteStack" - }, - { - "target": "com.amazonaws.opsworks#DeleteUserProfile" - }, - { - "target": "com.amazonaws.opsworks#DeregisterEcsCluster" - }, - { - "target": "com.amazonaws.opsworks#DeregisterElasticIp" - }, - { - "target": "com.amazonaws.opsworks#DeregisterInstance" - }, - { - "target": "com.amazonaws.opsworks#DeregisterRdsDbInstance" - }, - { - "target": "com.amazonaws.opsworks#DeregisterVolume" - }, - { - "target": "com.amazonaws.opsworks#DescribeAgentVersions" - }, - { - "target": "com.amazonaws.opsworks#DescribeApps" - }, - { - "target": "com.amazonaws.opsworks#DescribeCommands" - }, - { - "target": "com.amazonaws.opsworks#DescribeDeployments" - }, - { - "target": "com.amazonaws.opsworks#DescribeEcsClusters" - }, - { - "target": "com.amazonaws.opsworks#DescribeElasticIps" - }, - { - "target": "com.amazonaws.opsworks#DescribeElasticLoadBalancers" - }, - { - "target": "com.amazonaws.opsworks#DescribeInstances" - }, - { - "target": "com.amazonaws.opsworks#DescribeLayers" - }, - { - "target": "com.amazonaws.opsworks#DescribeLoadBasedAutoScaling" - }, - { - "target": "com.amazonaws.opsworks#DescribeMyUserProfile" - }, - { - "target": "com.amazonaws.opsworks#DescribeOperatingSystems" - }, - { - "target": "com.amazonaws.opsworks#DescribePermissions" - }, - { - "target": "com.amazonaws.opsworks#DescribeRaidArrays" - }, - { - "target": "com.amazonaws.opsworks#DescribeRdsDbInstances" - }, - { - "target": "com.amazonaws.opsworks#DescribeServiceErrors" - }, - { - "target": "com.amazonaws.opsworks#DescribeStackProvisioningParameters" - }, - { - "target": "com.amazonaws.opsworks#DescribeStacks" - }, - { - "target": "com.amazonaws.opsworks#DescribeStackSummary" - }, - { - "target": "com.amazonaws.opsworks#DescribeTimeBasedAutoScaling" - }, - { - "target": "com.amazonaws.opsworks#DescribeUserProfiles" - }, - { - "target": "com.amazonaws.opsworks#DescribeVolumes" - }, - { - "target": "com.amazonaws.opsworks#DetachElasticLoadBalancer" - }, - { - "target": "com.amazonaws.opsworks#DisassociateElasticIp" - }, - { - "target": "com.amazonaws.opsworks#GetHostnameSuggestion" - }, - { - "target": "com.amazonaws.opsworks#GrantAccess" - }, - { - "target": "com.amazonaws.opsworks#ListTags" - }, - { - "target": "com.amazonaws.opsworks#RebootInstance" - }, - { - "target": "com.amazonaws.opsworks#RegisterEcsCluster" - }, - { - "target": "com.amazonaws.opsworks#RegisterElasticIp" - }, - { - "target": "com.amazonaws.opsworks#RegisterInstance" - }, - { - "target": "com.amazonaws.opsworks#RegisterRdsDbInstance" - }, - { - "target": "com.amazonaws.opsworks#RegisterVolume" - }, - { - "target": "com.amazonaws.opsworks#SetLoadBasedAutoScaling" - }, - { - "target": "com.amazonaws.opsworks#SetPermission" - }, - { - "target": "com.amazonaws.opsworks#SetTimeBasedAutoScaling" - }, - { - "target": "com.amazonaws.opsworks#StartInstance" - }, - { - "target": "com.amazonaws.opsworks#StartStack" - }, - { - "target": "com.amazonaws.opsworks#StopInstance" - }, - { - "target": "com.amazonaws.opsworks#StopStack" - }, - { - "target": "com.amazonaws.opsworks#TagResource" - }, - { - "target": "com.amazonaws.opsworks#UnassignInstance" - }, - { - "target": "com.amazonaws.opsworks#UnassignVolume" - }, - { - "target": "com.amazonaws.opsworks#UntagResource" - }, - { - "target": "com.amazonaws.opsworks#UpdateApp" - }, - { - "target": "com.amazonaws.opsworks#UpdateElasticIp" - }, - { - "target": "com.amazonaws.opsworks#UpdateInstance" - }, - { - "target": "com.amazonaws.opsworks#UpdateLayer" - }, - { - "target": "com.amazonaws.opsworks#UpdateMyUserProfile" - }, - { - "target": "com.amazonaws.opsworks#UpdateRdsDbInstance" - }, - { - "target": "com.amazonaws.opsworks#UpdateStack" - }, - { - "target": "com.amazonaws.opsworks#UpdateUserProfile" - }, - { - "target": "com.amazonaws.opsworks#UpdateVolume" - } - ], - "traits": { - "aws.api#service": { - "sdkId": "OpsWorks", - "arnNamespace": "opsworks", - "cloudFormationName": "OpsWorks", - "cloudTrailEventSource": "opsworks.amazonaws.com", - "endpointPrefix": "opsworks" - }, - "aws.auth#sigv4": { - "name": "opsworks" - }, - "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "OpsWorks\n

Welcome to the OpsWorks Stacks API Reference. This guide provides descriptions, syntax, \n and\n usage examples for OpsWorks Stacks actions and data types, including common parameters and error\n codes.

\n

OpsWorks Stacks is an application management service that provides an integrated experience for\n managing the complete application lifecycle. For information about OpsWorks, see the\n OpsWorks information page.

\n

\n SDKs and CLI\n

\n

Use the OpsWorks Stacks API by using the Command Line Interface (CLI) or by using one of the \n Amazon Web Services SDKs to implement applications in your preferred language. For more information, see:

\n \n

\n Endpoints\n

\n

OpsWorks Stacks supports the following endpoints, all HTTPS. You must connect to one of the following endpoints. \n Stacks can only be accessed or managed within the endpoint in which they are created.

\n \n

\n Chef Versions\n

\n

When you call CreateStack, CloneStack, or UpdateStack we recommend you\n use the ConfigurationManager parameter to specify the Chef version.\n The recommended and default value for Linux stacks is currently 12. Windows stacks use Chef 12.2. For more information,\n see Chef Versions.

\n \n

You can specify Chef 12, 11.10, or 11.4 for your Linux stack. We recommend migrating your existing Linux stacks \n to Chef 12 as soon as possible.

\n ", - "smithy.api#title": "AWS OpsWorks", - "smithy.api#xmlNamespace": { - "uri": "http://opsworks.amazonaws.com/doc/2013-02-18/" - }, - "smithy.rules#endpointRuleSet": { - "version": "1.0", - "parameters": { - "Region": { - "builtIn": "AWS::Region", - "required": false, - "documentation": "The AWS region used to dispatch the request.", - "type": "String" - }, - "UseDualStack": { - "builtIn": "AWS::UseDualStack", - "required": true, - "default": false, - "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", - "type": "Boolean" - }, - "UseFIPS": { - "builtIn": "AWS::UseFIPS", - "required": true, - "default": false, - "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", - "type": "Boolean" - }, - "Endpoint": { - "builtIn": "SDK::Endpoint", - "required": false, - "documentation": "Override the endpoint used to send this request", - "type": "String" - } - }, - "rules": [ - { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Endpoint" - } - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "error": "Invalid Configuration: FIPS and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" - }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Region" - } - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "aws.partition", - "argv": [ - { - "ref": "Region" - } - ], - "assign": "PartitionResult" - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - }, - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://opsworks-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - }, - true - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://opsworks-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://opsworks.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [], - "endpoint": { - "url": "https://opsworks.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" - } - ] - }, - "smithy.rules#endpointTests": { - "testCases": [ - { - "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://opsworks.ap-northeast-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-northeast-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://opsworks.ap-northeast-2.amazonaws.com" - } - }, - "params": { - "Region": "ap-northeast-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://opsworks.ap-south-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-south-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://opsworks.ap-southeast-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-southeast-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://opsworks.ap-southeast-2.amazonaws.com" - } - }, - "params": { - "Region": "ap-southeast-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://opsworks.ca-central-1.amazonaws.com" - } - }, - "params": { - "Region": "ca-central-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://opsworks.eu-central-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-central-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://opsworks.eu-west-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-west-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://opsworks.eu-west-2.amazonaws.com" - } - }, - "params": { - "Region": "eu-west-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://opsworks.eu-west-3.amazonaws.com" - } - }, - "params": { - "Region": "eu-west-3", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://opsworks.sa-east-1.amazonaws.com" - } - }, - "params": { - "Region": "sa-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://opsworks.us-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://opsworks.us-east-2.amazonaws.com" - } - }, - "params": { - "Region": "us-east-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://opsworks.us-west-1.amazonaws.com" - } - }, - "params": { - "Region": "us-west-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://opsworks.us-west-2.amazonaws.com" - } - }, - "params": { - "Region": "us-west-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://opsworks-fips.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://opsworks-fips.us-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://opsworks.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://opsworks-fips.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://opsworks-fips.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://opsworks.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://opsworks.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://opsworks-fips.us-gov-east-1.api.aws" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://opsworks-fips.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://opsworks.us-gov-east-1.api.aws" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://opsworks.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://opsworks-fips.us-iso-east-1.c2s.ic.gov" - } - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://opsworks.us-iso-east-1.c2s.ic.gov" - } - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://opsworks-fips.us-isob-east-1.sc2s.sgov.gov" - } - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://opsworks.us-isob-east-1.sc2s.sgov.gov" - } - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": false, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": false, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "For custom endpoint with fips enabled and dualstack disabled", - "expect": { - "error": "Invalid Configuration: FIPS and custom endpoint are not supported" - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": false, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "For custom endpoint with fips disabled and dualstack enabled", - "expect": { - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": true, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "Missing region", - "expect": { - "error": "Invalid Configuration: Missing Region" - } - } - ], - "version": "1.0" - } - } - }, - "com.amazonaws.opsworks#Parameters": { - "type": "map", - "key": { - "target": "com.amazonaws.opsworks#String" - }, - "value": { - "target": "com.amazonaws.opsworks#String" - } - }, - "com.amazonaws.opsworks#Permission": { - "type": "structure", - "members": { - "StackId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

A stack ID.

" - } - }, - "IamUserArn": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for an Identity and Access Management (IAM) role. For more\n information about IAM ARNs, see Using\n Identifiers.

" - } - }, - "AllowSsh": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

Whether the user can use SSH.

" - } - }, - "AllowSudo": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

Whether the user can use sudo.

" - } - }, - "Level": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The user's permission level, which must be the following:

\n \n

For more information on the permissions associated with these levels, see Managing User Permissions\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes stack or user permissions.

" - } - }, - "com.amazonaws.opsworks#Permissions": { - "type": "list", - "member": { - "target": "com.amazonaws.opsworks#Permission" - } - }, - "com.amazonaws.opsworks#RaidArray": { - "type": "structure", - "members": { - "RaidArrayId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The array ID.

" - } - }, - "InstanceId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance ID.

" - } - }, - "Name": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The array name.

" - } - }, - "RaidLevel": { - "target": "com.amazonaws.opsworks#Integer", - "traits": { - "smithy.api#documentation": "

The RAID level.

" - } - }, - "NumberOfDisks": { - "target": "com.amazonaws.opsworks#Integer", - "traits": { - "smithy.api#documentation": "

The number of disks in the array.

" - } - }, - "Size": { - "target": "com.amazonaws.opsworks#Integer", - "traits": { - "smithy.api#documentation": "

The array's size.

" - } - }, - "Device": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The array's Linux device. For example /dev/mdadm0.

" - } - }, - "MountPoint": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The array's mount point.

" - } - }, - "AvailabilityZone": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The array's Availability Zone. For more information, see Regions and Endpoints.

" - } - }, - "CreatedAt": { - "target": "com.amazonaws.opsworks#DateTime", - "traits": { - "smithy.api#documentation": "

When the RAID array was created.

" - } - }, - "StackId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The stack ID.

" - } - }, - "VolumeType": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The volume type, standard or PIOPS.

" - } - }, - "Iops": { - "target": "com.amazonaws.opsworks#Integer", - "traits": { - "smithy.api#documentation": "

For PIOPS volumes, the IOPS per disk.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an instance's RAID array.

" - } - }, - "com.amazonaws.opsworks#RaidArrays": { - "type": "list", - "member": { - "target": "com.amazonaws.opsworks#RaidArray" - } - }, - "com.amazonaws.opsworks#RdsDbInstance": { - "type": "structure", - "members": { - "RdsDbInstanceArn": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance's ARN.

" - } - }, - "DbInstanceIdentifier": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The database instance identifier.

" - } - }, - "DbUser": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The master user name.

" - } - }, - "DbPassword": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

OpsWorks Stacks returns *****FILTERED***** instead of the actual value.

" - } - }, - "Region": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance's Amazon Web Services Region.

" - } - }, - "Address": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance's address.

" - } - }, - "Engine": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance's database engine.

" - } - }, - "StackId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The ID of the stack with which the instance is registered.

" - } - }, - "MissingOnRds": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

Set to true if OpsWorks Stacks is unable to discover the Amazon RDS instance. \n OpsWorks Stacks attempts\n to discover the instance only once. If this value is set to true, you must\n deregister the instance, and then register it again.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an Amazon RDS instance.

" - } - }, - "com.amazonaws.opsworks#RdsDbInstances": { - "type": "list", - "member": { - "target": "com.amazonaws.opsworks#RdsDbInstance" - } - }, - "com.amazonaws.opsworks#RebootInstance": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#RebootInstanceRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Reboots a specified instance. For more information, see Starting,\n Stopping, and Rebooting Instances.

\n

\n Required Permissions: To use this action, an IAM user must have a Manage permissions\n level for the stack, or an attached policy that explicitly grants permissions. For more\n information on user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#RebootInstanceRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance ID.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#Recipes": { - "type": "structure", - "members": { - "Setup": { - "target": "com.amazonaws.opsworks#Strings", - "traits": { - "smithy.api#documentation": "

An array of custom recipe names to be run following a setup event.

" - } - }, - "Configure": { - "target": "com.amazonaws.opsworks#Strings", - "traits": { - "smithy.api#documentation": "

An array of custom recipe names to be run following a configure event.

" - } - }, - "Deploy": { - "target": "com.amazonaws.opsworks#Strings", - "traits": { - "smithy.api#documentation": "

An array of custom recipe names to be run following a deploy event.

" - } - }, - "Undeploy": { - "target": "com.amazonaws.opsworks#Strings", - "traits": { - "smithy.api#documentation": "

An array of custom recipe names to be run following a undeploy event.

" - } - }, - "Shutdown": { - "target": "com.amazonaws.opsworks#Strings", - "traits": { - "smithy.api#documentation": "

An array of custom recipe names to be run following a shutdown event.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

OpsWorks Stacks supports five\n lifecycle events:\n setup, configuration, deploy, undeploy, and shutdown. For\n each layer, OpsWorks Stacks runs a set of standard recipes for each event. In addition, you can provide\n custom recipes for any or all layers and events. OpsWorks Stacks runs custom event recipes after the\n standard recipes. LayerCustomRecipes specifies the custom recipes for a\n particular layer to be run in response to each of the five events.

\n

To specify a recipe, use the cookbook's directory name in the repository followed by two colons and the recipe name, \n which is the recipe's file name without the .rb extension. For example: phpapp2::dbsetup specifies the dbsetup.rb recipe in \n the repository's phpapp2 folder.

" - } - }, - "com.amazonaws.opsworks#RegisterEcsCluster": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#RegisterEcsClusterRequest" - }, - "output": { - "target": "com.amazonaws.opsworks#RegisterEcsClusterResult" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Registers a specified Amazon ECS cluster with a stack. You can register only one\n cluster with a stack. A cluster can be registered with only one stack.\n For more information, see\n \n Resource Management.

\n

\n Required Permissions: To use this action, an IAM user must have a Manage permissions\n level for the stack or an attached policy that explicitly grants permissions. For more\n information on user permissions, see\n \n Managing User Permissions.

" - } - }, - "com.amazonaws.opsworks#RegisterEcsClusterRequest": { - "type": "structure", - "members": { - "EcsClusterArn": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The cluster's ARN.

", - "smithy.api#required": {} - } - }, - "StackId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The stack ID.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#RegisterEcsClusterResult": { - "type": "structure", - "members": { - "EcsClusterArn": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The cluster's ARN.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the response to a RegisterEcsCluster request.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.opsworks#RegisterElasticIp": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#RegisterElasticIpRequest" - }, - "output": { - "target": "com.amazonaws.opsworks#RegisterElasticIpResult" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Registers an Elastic IP address with a specified stack. An address can be registered with\n only one stack at a time. If the address is already registered, you must first deregister it\n by calling DeregisterElasticIp. For more information, see Resource Management.

\n

\n Required Permissions: To use this action, an IAM user must have a Manage permissions\n level for the stack, or an attached policy that explicitly grants permissions. For more\n information on user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#RegisterElasticIpRequest": { - "type": "structure", - "members": { - "ElasticIp": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The Elastic IP address.

", - "smithy.api#required": {} - } - }, - "StackId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The stack ID.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#RegisterElasticIpResult": { - "type": "structure", - "members": { - "ElasticIp": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The Elastic IP address.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the response to a RegisterElasticIp request.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.opsworks#RegisterInstance": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#RegisterInstanceRequest" - }, - "output": { - "target": "com.amazonaws.opsworks#RegisterInstanceResult" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Registers instances that were created outside of OpsWorks Stacks with a specified stack.

\n \n

We do not recommend using this action to register instances. The complete registration\n operation includes two tasks: installing the OpsWorks Stacks agent on the instance, and registering\n the instance with the stack. RegisterInstance handles only the second step. You\n should instead use the CLI register command, which performs the entire\n registration operation. For more information,\n see \n Registering an Instance with an OpsWorks Stacks Stack.

\n \n

Registered instances have the same requirements as instances that are created by using the CreateInstance \n API. \n For example, registered instances must be running a supported Linux-based operating system, and they must have a supported instance \n type. For more information about requirements for instances that you want to register, see \n Preparing the Instance.

\n

\n Required Permissions: To use this action, an IAM user must have a Manage permissions\n level for the stack or an attached policy that explicitly grants permissions. For more\n information on user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#RegisterInstanceRequest": { - "type": "structure", - "members": { - "StackId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The ID of the stack that the instance is to be registered with.

", - "smithy.api#required": {} - } - }, - "Hostname": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance's host name. The following are character limits for instance host names.

\n " - } - }, - "PublicIp": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance's public IP address.

" - } - }, - "PrivateIp": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance's private IP address.

" - } - }, - "RsaPublicKey": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instances public RSA key. This key is used to encrypt communication between the instance and the service.

" - } - }, - "RsaPublicKeyFingerprint": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instances public RSA key fingerprint.

" - } - }, - "InstanceIdentity": { - "target": "com.amazonaws.opsworks#InstanceIdentity", - "traits": { - "smithy.api#documentation": "

An InstanceIdentity object that contains the instance's identity.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#RegisterInstanceResult": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The registered instance's OpsWorks Stacks ID.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the response to a RegisterInstanceResult request.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.opsworks#RegisterRdsDbInstance": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#RegisterRdsDbInstanceRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Registers an Amazon RDS instance with a stack.

\n

\n Required Permissions: To use this action, an IAM user must have a Manage permissions\n level for the stack, or an attached policy that explicitly grants permissions. For more\n information on user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#RegisterRdsDbInstanceRequest": { - "type": "structure", - "members": { - "StackId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The stack ID.

", - "smithy.api#required": {} - } - }, - "RdsDbInstanceArn": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The Amazon RDS instance's ARN.

", - "smithy.api#required": {} - } - }, - "DbUser": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The database's master user name.

", - "smithy.api#required": {} - } - }, - "DbPassword": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The database password.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#RegisterVolume": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#RegisterVolumeRequest" - }, - "output": { - "target": "com.amazonaws.opsworks#RegisterVolumeResult" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Registers an Amazon EBS volume with a specified stack. A volume can be registered with only one\n stack at a time. If the volume is already registered, you must first deregister it by calling\n DeregisterVolume. For more information, see Resource Management.

\n

\n Required Permissions: To use this action, an IAM user must have a Manage permissions\n level for the stack, or an attached policy that explicitly grants permissions. For more\n information on user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#RegisterVolumeRequest": { - "type": "structure", - "members": { - "Ec2VolumeId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The Amazon EBS volume ID.

" - } - }, - "StackId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The stack ID.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#RegisterVolumeResult": { - "type": "structure", - "members": { - "VolumeId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The volume ID.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the response to a RegisterVolume request.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.opsworks#ReportedOs": { - "type": "structure", - "members": { - "Family": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The operating system family.

" - } - }, - "Name": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The operating system name.

" - } - }, - "Version": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The operating system version.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A registered instance's reported operating system.

" - } - }, - "com.amazonaws.opsworks#ResourceArn": { - "type": "string" - }, - "com.amazonaws.opsworks#ResourceNotFoundException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The exception message.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Indicates that a resource was not found.

", - "smithy.api#error": "client" - } - }, - "com.amazonaws.opsworks#RootDeviceType": { - "type": "enum", - "members": { - "ebs": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ebs" - } - }, - "instance_store": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "instance-store" - } - } - } - }, - "com.amazonaws.opsworks#SelfUserProfile": { - "type": "structure", - "members": { - "IamUserArn": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The user's IAM ARN.

" - } - }, - "Name": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The user's name.

" - } - }, - "SshUsername": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The user's SSH user name.

" - } - }, - "SshPublicKey": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The user's SSH public key.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a user's SSH information.

" - } - }, - "com.amazonaws.opsworks#ServiceError": { - "type": "structure", - "members": { - "ServiceErrorId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The error ID.

" - } - }, - "StackId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The stack ID.

" - } - }, - "InstanceId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance ID.

" - } - }, - "Type": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The error type.

" - } - }, - "Message": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

A message that describes the error.

" - } - }, - "CreatedAt": { - "target": "com.amazonaws.opsworks#DateTime", - "traits": { - "smithy.api#documentation": "

When the error occurred.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an OpsWorks Stacks service error.

" - } - }, - "com.amazonaws.opsworks#ServiceErrors": { - "type": "list", - "member": { - "target": "com.amazonaws.opsworks#ServiceError" - } - }, - "com.amazonaws.opsworks#SetLoadBasedAutoScaling": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#SetLoadBasedAutoScalingRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Specify the load-based auto scaling configuration for a specified layer. For more\n information, see Managing\n Load with Time-based and Load-based Instances.

\n \n

To use load-based auto scaling, you must create a set of load-based auto scaling instances. \n Load-based auto scaling operates only on the instances from that set, so you must ensure that you have created enough \n instances to handle the maximum anticipated load.

\n \n

\n Required Permissions: To use this action, an IAM user must have a Manage permissions\n level for the stack, or an attached policy that explicitly grants permissions. For more\n information on user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#SetLoadBasedAutoScalingRequest": { - "type": "structure", - "members": { - "LayerId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The layer ID.

", - "smithy.api#required": {} - } - }, - "Enable": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

Enables load-based auto scaling for the layer.

" - } - }, - "UpScaling": { - "target": "com.amazonaws.opsworks#AutoScalingThresholds", - "traits": { - "smithy.api#documentation": "

An AutoScalingThresholds object with the upscaling threshold configuration. If\n the load exceeds these thresholds for a specified amount of time, OpsWorks Stacks starts a specified\n number of instances.

" - } - }, - "DownScaling": { - "target": "com.amazonaws.opsworks#AutoScalingThresholds", - "traits": { - "smithy.api#documentation": "

An AutoScalingThresholds object with the downscaling threshold configuration. If\n the load falls below these thresholds for a specified amount of time, OpsWorks Stacks stops a specified\n number of instances.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#SetPermission": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#SetPermissionRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Specifies a user's permissions. For more information, see \n Security and\n Permissions.

\n

\n Required Permissions: To use this action, an IAM user must have a Manage permissions\n level for the stack, or an attached policy that explicitly grants permissions. For more\n information on user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#SetPermissionRequest": { - "type": "structure", - "members": { - "StackId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The stack ID.

", - "smithy.api#required": {} - } - }, - "IamUserArn": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The user's IAM ARN. This can also be a federated user's ARN.

", - "smithy.api#required": {} - } - }, - "AllowSsh": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

The user is allowed to use SSH to communicate with the instance.

" - } - }, - "AllowSudo": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

The user is allowed to use sudo to elevate privileges.

" - } - }, - "Level": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The user's permission level, which must be set to one of the following strings. You cannot set your own permissions level.

\n \n

For more information about the permissions associated with these levels, see Managing User Permissions.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#SetTimeBasedAutoScaling": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#SetTimeBasedAutoScalingRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Specify the time-based auto scaling configuration for a specified instance. For more\n information, see Managing\n Load with Time-based and Load-based Instances.

\n

\n Required Permissions: To use this action, an IAM user must have a Manage permissions\n level for the stack, or an attached policy that explicitly grants permissions. For more\n information on user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#SetTimeBasedAutoScalingRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance ID.

", - "smithy.api#required": {} - } - }, - "AutoScalingSchedule": { - "target": "com.amazonaws.opsworks#WeeklyAutoScalingSchedule", - "traits": { - "smithy.api#documentation": "

An AutoScalingSchedule with the instance schedule.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#ShutdownEventConfiguration": { - "type": "structure", - "members": { - "ExecutionTimeout": { - "target": "com.amazonaws.opsworks#Integer", - "traits": { - "smithy.api#documentation": "

The time, in seconds, that OpsWorks Stacks waits after triggering a Shutdown event before \n shutting down an instance.

" - } - }, - "DelayUntilElbConnectionsDrained": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

Whether to enable Elastic Load Balancing connection draining. For more information, see Connection Draining\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The Shutdown event configuration.

" - } - }, - "com.amazonaws.opsworks#Source": { - "type": "structure", - "members": { - "Type": { - "target": "com.amazonaws.opsworks#SourceType", - "traits": { - "smithy.api#documentation": "

The repository type.

" - } - }, - "Url": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The source URL. The following is an example of an Amazon S3 source \n URL: https://s3.amazonaws.com/opsworks-demo-bucket/opsworks_cookbook_demo.tar.gz.

" - } - }, - "Username": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

This parameter depends on the repository type.

\n " - } - }, - "Password": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

When included in a request, the parameter depends on the repository type.

\n \n

For more information on how to safely handle IAM credentials, see https://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html.

\n

In responses, OpsWorks Stacks returns *****FILTERED***** instead of the actual value.

" - } - }, - "SshKey": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

In requests, the repository's SSH key.

\n

In responses, OpsWorks Stacks returns *****FILTERED***** instead of the actual value.

" - } - }, - "Revision": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The application's version. OpsWorks Stacks enables you to easily deploy new versions of an application. \n One of the simplest approaches is to have branches or revisions in your repository that represent different \n versions that can potentially be deployed.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the information required to retrieve an app or cookbook from a repository. For more\n information, see Creating Apps or Custom Recipes and\n Cookbooks.

" - } - }, - "com.amazonaws.opsworks#SourceType": { - "type": "enum", - "members": { - "git": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "git" - } - }, - "svn": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "svn" - } - }, - "archive": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "archive" - } - }, - "s3": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "s3" - } - } - } - }, - "com.amazonaws.opsworks#SslConfiguration": { - "type": "structure", - "members": { - "Certificate": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The contents of the certificate's domain.crt file.

", - "smithy.api#required": {} - } - }, - "PrivateKey": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The private key; the contents of the certificate's domain.kex file.

", - "smithy.api#required": {} - } - }, - "Chain": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

Optional. Can be used to specify an intermediate certificate authority key or client authentication.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an app's SSL configuration.

" - } - }, - "com.amazonaws.opsworks#Stack": { - "type": "structure", - "members": { - "StackId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The stack ID.

" - } - }, - "Name": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The stack name. Stack names can be a maximum of 64 characters.

" - } - }, - "Arn": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The stack's ARN.

" - } - }, - "Region": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The stack Amazon Web Services Region, such as ap-northeast-2. For more information about \n Amazon Web Services Regions, see Regions and Endpoints.

" - } - }, - "VpcId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The VPC ID; applicable only if the stack is running in a VPC.

" - } - }, - "Attributes": { - "target": "com.amazonaws.opsworks#StackAttributes", - "traits": { - "smithy.api#documentation": "

The stack's attributes.

" - } - }, - "ServiceRoleArn": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The stack Identity and Access Management (IAM) role.

" - } - }, - "DefaultInstanceProfileArn": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The ARN of an IAM profile that is the default profile for all of the stack's EC2 instances.\n For more information about IAM ARNs, see Using\n Identifiers.

" - } - }, - "DefaultOs": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The stack's default operating system.

" - } - }, - "HostnameTheme": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The stack host name theme, with spaces replaced by underscores.

" - } - }, - "DefaultAvailabilityZone": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The stack's default Availability Zone. For more information, see Regions and Endpoints.

" - } - }, - "DefaultSubnetId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The default subnet ID; applicable only if the stack is running in a VPC.

" - } - }, - "CustomJson": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

A JSON object that contains user-defined attributes to be added to the stack configuration and deployment attributes. \n You can use custom JSON to override the corresponding default stack configuration attribute values or to pass data to recipes. \n The string should be in the following format:

\n

\n \"{\\\"key1\\\": \\\"value1\\\", \\\"key2\\\": \\\"value2\\\",...}\"\n

\n

For more information on custom JSON, see Use Custom JSON to\n Modify the Stack Configuration Attributes.

" - } - }, - "ConfigurationManager": { - "target": "com.amazonaws.opsworks#StackConfigurationManager", - "traits": { - "smithy.api#documentation": "

The configuration manager.

" - } - }, - "ChefConfiguration": { - "target": "com.amazonaws.opsworks#ChefConfiguration", - "traits": { - "smithy.api#documentation": "

A ChefConfiguration object that specifies whether to enable Berkshelf and the\n Berkshelf version. For more information, see Create a New Stack.

" - } - }, - "UseCustomCookbooks": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

Whether the stack uses custom cookbooks.

" - } - }, - "UseOpsworksSecurityGroups": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

Whether the stack automatically associates the OpsWorks Stacks built-in security groups with the stack's layers.

" - } - }, - "CustomCookbooksSource": { - "target": "com.amazonaws.opsworks#Source", - "traits": { - "smithy.api#documentation": "

Contains the information required to retrieve an app or cookbook from a repository. For more information, \n see Adding Apps or \n Cookbooks and Recipes.

" - } - }, - "DefaultSshKeyName": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

A default Amazon EC2 key pair for the stack's instances. You can override this value when you create or \n update an instance.

" - } - }, - "CreatedAt": { - "target": "com.amazonaws.opsworks#DateTime", - "traits": { - "smithy.api#documentation": "

The date when the stack was created.

" - } - }, - "DefaultRootDeviceType": { - "target": "com.amazonaws.opsworks#RootDeviceType", - "traits": { - "smithy.api#documentation": "

The default root device type. This value is used by default for all instances in the stack,\n but you can override it when you create an instance. For more information, see Storage for the Root Device.\n

" - } - }, - "AgentVersion": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The agent version. This parameter is set to LATEST for auto-update.\n or a version number for a fixed agent version.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a stack.

" - } - }, - "com.amazonaws.opsworks#StackAttributes": { - "type": "map", - "key": { - "target": "com.amazonaws.opsworks#StackAttributesKeys" - }, - "value": { - "target": "com.amazonaws.opsworks#String" - } - }, - "com.amazonaws.opsworks#StackAttributesKeys": { - "type": "enum", - "members": { - "Color": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Color" - } - } - } - }, - "com.amazonaws.opsworks#StackConfigurationManager": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The name. This parameter must be set to Chef.

" - } - }, - "Version": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

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. \n The default value for Linux stacks is 12.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the configuration manager.

" - } - }, - "com.amazonaws.opsworks#StackSummary": { - "type": "structure", - "members": { - "StackId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The stack ID.

" - } - }, - "Name": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The stack name.

" - } - }, - "Arn": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The stack's ARN.

" - } - }, - "LayersCount": { - "target": "com.amazonaws.opsworks#Integer", - "traits": { - "smithy.api#documentation": "

The number of layers.

" - } - }, - "AppsCount": { - "target": "com.amazonaws.opsworks#Integer", - "traits": { - "smithy.api#documentation": "

The number of apps.

" - } - }, - "InstancesCount": { - "target": "com.amazonaws.opsworks#InstancesCount", - "traits": { - "smithy.api#documentation": "

An InstancesCount object with the number of instances in each status.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Summarizes the number of layers, instances, and apps in a stack.

" - } - }, - "com.amazonaws.opsworks#Stacks": { - "type": "list", - "member": { - "target": "com.amazonaws.opsworks#Stack" - } - }, - "com.amazonaws.opsworks#StartInstance": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#StartInstanceRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Starts a specified instance. For more information, see Starting,\n Stopping, and Rebooting Instances.

\n

\n Required Permissions: To use this action, an IAM user must have a Manage permissions\n level for the stack, or an attached policy that explicitly grants permissions. For more\n information on user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#StartInstanceRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance ID.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#StartStack": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#StartStackRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Starts a stack's instances.

\n

\n Required Permissions: To use this action, an IAM user must have a Manage permissions\n level for the stack, or an attached policy that explicitly grants permissions. For more\n information on user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#StartStackRequest": { - "type": "structure", - "members": { - "StackId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The stack ID.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#StopInstance": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#StopInstanceRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Stops a specified instance. When you stop a standard instance, the data disappears and must\n be reinstalled when you restart the instance. You can stop an Amazon EBS-backed instance without\n losing data. For more information, see Starting,\n Stopping, and Rebooting Instances.

\n

\n Required Permissions: To use this action, an IAM user must have a Manage permissions\n level for the stack, or an attached policy that explicitly grants permissions. For more\n information on user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#StopInstanceRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance ID.

", - "smithy.api#required": {} - } - }, - "Force": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

Specifies whether to force an instance to stop. If the instance's root device type is ebs, or EBS-backed, \n adding the Force parameter to the StopInstances API call disassociates the OpsWorks Stacks \n instance from EC2, and forces deletion of only the OpsWorks Stacks instance. \n You must also delete the formerly-associated instance in EC2 after troubleshooting and replacing the OpsWorks Stacks \n instance with a new one.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#StopStack": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#StopStackRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Stops a specified stack.

\n

\n Required Permissions: To use this action, an IAM user must have a Manage permissions\n level for the stack, or an attached policy that explicitly grants permissions. For more\n information on user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#StopStackRequest": { - "type": "structure", - "members": { - "StackId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The stack ID.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#String": { - "type": "string" - }, - "com.amazonaws.opsworks#Strings": { - "type": "list", - "member": { - "target": "com.amazonaws.opsworks#String" - } - }, - "com.amazonaws.opsworks#Switch": { - "type": "string" - }, - "com.amazonaws.opsworks#TagKey": { - "type": "string" - }, - "com.amazonaws.opsworks#TagKeys": { - "type": "list", - "member": { - "target": "com.amazonaws.opsworks#TagKey" - } - }, - "com.amazonaws.opsworks#TagResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#TagResourceRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Apply cost-allocation tags to a specified stack or layer in OpsWorks Stacks. For more information about how \n tagging works, see Tags in the OpsWorks User Guide.

" - } - }, - "com.amazonaws.opsworks#TagResourceRequest": { - "type": "structure", - "members": { - "ResourceArn": { - "target": "com.amazonaws.opsworks#ResourceArn", - "traits": { - "smithy.api#documentation": "

The stack or layer's Amazon Resource Number (ARN).

", - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.opsworks#Tags", - "traits": { - "smithy.api#documentation": "

A map that contains tag keys and tag values that are attached to a stack or layer.

\n ", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#TagValue": { - "type": "string" - }, - "com.amazonaws.opsworks#Tags": { - "type": "map", - "key": { - "target": "com.amazonaws.opsworks#TagKey" - }, - "value": { - "target": "com.amazonaws.opsworks#TagValue" - } - }, - "com.amazonaws.opsworks#TemporaryCredential": { - "type": "structure", - "members": { - "Username": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The user name.

" - } - }, - "Password": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The password.

" - } - }, - "ValidForInMinutes": { - "target": "com.amazonaws.opsworks#Integer", - "traits": { - "smithy.api#documentation": "

The length of time (in minutes) that the grant is valid. When the grant expires, at the end of this period, \n the user will no longer be able to use the credentials to log in. If they are logged in at the time, they are \n automatically logged out.

" - } - }, - "InstanceId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance's OpsWorks Stacks ID.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Contains the data needed by RDP clients such as the Microsoft Remote Desktop Connection to log in to the instance.

" - } - }, - "com.amazonaws.opsworks#TimeBasedAutoScalingConfiguration": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance ID.

" - } - }, - "AutoScalingSchedule": { - "target": "com.amazonaws.opsworks#WeeklyAutoScalingSchedule", - "traits": { - "smithy.api#documentation": "

A WeeklyAutoScalingSchedule object with the instance schedule.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an instance's time-based auto scaling configuration.

" - } - }, - "com.amazonaws.opsworks#TimeBasedAutoScalingConfigurations": { - "type": "list", - "member": { - "target": "com.amazonaws.opsworks#TimeBasedAutoScalingConfiguration" - } - }, - "com.amazonaws.opsworks#UnassignInstance": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#UnassignInstanceRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Unassigns a registered instance from all layers that are using the instance. \n The instance remains in the stack as an unassigned instance, and can be assigned to \n another layer as needed. You cannot use this action with instances that were created \n with OpsWorks Stacks.

\n

\n Required Permissions: To use this action, an IAM user must \n have a Manage permissions level for the stack or an attached policy that explicitly \n grants permissions. For more information about user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#UnassignInstanceRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance ID.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#UnassignVolume": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#UnassignVolumeRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Unassigns an assigned Amazon EBS volume. The volume remains registered with the stack. For more\n information, see Resource\n Management.

\n

\n Required Permissions: To use this action, an IAM user must have a Manage permissions\n level for the stack, or an attached policy that explicitly grants permissions. For more\n information on user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#UnassignVolumeRequest": { - "type": "structure", - "members": { - "VolumeId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The volume ID.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#UntagResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#UntagResourceRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Removes tags from a specified stack or layer.

" - } - }, - "com.amazonaws.opsworks#UntagResourceRequest": { - "type": "structure", - "members": { - "ResourceArn": { - "target": "com.amazonaws.opsworks#ResourceArn", - "traits": { - "smithy.api#documentation": "

The stack or layer's Amazon Resource Number (ARN).

", - "smithy.api#required": {} - } - }, - "TagKeys": { - "target": "com.amazonaws.opsworks#TagKeys", - "traits": { - "smithy.api#documentation": "

A list of the keys of tags to be removed from a stack or layer.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#UpdateApp": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#UpdateAppRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates a specified app.

\n

\n Required Permissions: To use this action, an IAM user must have a Deploy or Manage\n permissions level for the stack, or an attached policy that explicitly grants permissions. For\n more information on user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#UpdateAppRequest": { - "type": "structure", - "members": { - "AppId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The app ID.

", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The app name.

" - } - }, - "Description": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

A description of the app.

" - } - }, - "DataSources": { - "target": "com.amazonaws.opsworks#DataSources", - "traits": { - "smithy.api#documentation": "

The app's data sources.

" - } - }, - "Type": { - "target": "com.amazonaws.opsworks#AppType", - "traits": { - "smithy.api#documentation": "

The app type.

" - } - }, - "AppSource": { - "target": "com.amazonaws.opsworks#Source", - "traits": { - "smithy.api#documentation": "

A Source object that specifies the app repository.

" - } - }, - "Domains": { - "target": "com.amazonaws.opsworks#Strings", - "traits": { - "smithy.api#documentation": "

The app's virtual host settings, with multiple domains separated by commas. For example:\n 'www.example.com, example.com'\n

" - } - }, - "EnableSsl": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

Whether SSL is enabled for the app.

" - } - }, - "SslConfiguration": { - "target": "com.amazonaws.opsworks#SslConfiguration", - "traits": { - "smithy.api#documentation": "

An SslConfiguration object with the SSL configuration.

" - } - }, - "Attributes": { - "target": "com.amazonaws.opsworks#AppAttributes", - "traits": { - "smithy.api#documentation": "

One or more user-defined key/value pairs to be added to the stack attributes.

" - } - }, - "Environment": { - "target": "com.amazonaws.opsworks#EnvironmentVariables", - "traits": { - "smithy.api#documentation": "

An array of EnvironmentVariable objects that specify environment variables to be\n associated with the app. After you deploy the app, these variables are defined on the\n associated app server instances.For more information, see Environment Variables.

\n

There is no specific limit on the number of environment variables. However, the size of the associated data structure - \n which includes the variables' names, values, and protected flag values - cannot exceed 20 KB. This limit should accommodate most \n if not all use cases. Exceeding it will cause an exception with the message, \"Environment: is too large (maximum is 20 KB).\"

\n \n

If you have specified one or more environment variables, you cannot modify the stack's Chef version.

\n " - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#UpdateElasticIp": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#UpdateElasticIpRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates a registered Elastic IP address's name. For more information, see Resource Management.

\n

\n Required Permissions: To use this action, an IAM user must have a Manage permissions\n level for the stack, or an attached policy that explicitly grants permissions. For more\n information on user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#UpdateElasticIpRequest": { - "type": "structure", - "members": { - "ElasticIp": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The IP address for which you want to update the name.

", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The new name, which can be a maximum of 32 characters.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#UpdateInstance": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#UpdateInstanceRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates a specified instance.

\n

\n Required Permissions: To use this action, an IAM user must have a Manage permissions\n level for the stack, or an attached policy that explicitly grants permissions. For more\n information on user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#UpdateInstanceRequest": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance ID.

", - "smithy.api#required": {} - } - }, - "LayerIds": { - "target": "com.amazonaws.opsworks#Strings", - "traits": { - "smithy.api#documentation": "

The instance's layer IDs.

" - } - }, - "InstanceType": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance type, such as t2.micro. For a list of supported instance types,\n open the stack in the console, choose Instances, and choose + Instance.\n The Size list contains the currently supported types. For more information, see Instance\n Families and Types. The parameter values that you use to specify the various types are\n in the API Name column of the Available Instance Types table.

" - } - }, - "AutoScalingType": { - "target": "com.amazonaws.opsworks#AutoScalingType", - "traits": { - "smithy.api#documentation": "

For load-based or time-based instances, the type. Windows stacks can use only time-based instances.

" - } - }, - "Hostname": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance host name. The following are character limits for instance host names.

\n " - } - }, - "Os": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance's operating system, which must be set to one of the following. You cannot update an instance that is using \n a custom AMI.

\n \n

Not all operating systems are supported with all versions of Chef. For more information about supported operating systems,\n see OpsWorks Stacks Operating Systems.

\n

The default option is the current Amazon Linux version. If you set this parameter to\n Custom, you must use the AmiId parameter to\n specify the custom AMI that you want to use. For more information about how to use custom AMIs with OpsWorks, see Using\n Custom AMIs.

\n \n

You can specify a different Linux operating system for the updated stack, but you cannot change from Linux to Windows or Windows to Linux.

\n " - } - }, - "AmiId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

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 \n instance is already using. \n You cannot apply a new AMI to an instance by running UpdateInstance. UpdateInstance does not work on instances that are using \n custom AMIs.\n

" - } - }, - "SshKeyName": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance's Amazon EC2 key name.

" - } - }, - "Architecture": { - "target": "com.amazonaws.opsworks#Architecture", - "traits": { - "smithy.api#documentation": "

The instance architecture. Instance types do not necessarily support both architectures. For\n a list of the architectures that are supported by the different instance types, see Instance\n Families and Types.

" - } - }, - "InstallUpdatesOnBoot": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

Whether to install operating system and package updates when the instance boots. The default\n value is true. To control when updates are installed, set this value to\n false. You must then update your instances manually by using\n CreateDeployment to run the update_dependencies stack command or\n by manually running yum (Amazon Linux) or apt-get (Ubuntu) on the\n instances.

\n \n

We strongly recommend using the default value of true, to ensure that your\n instances have the latest security updates.

\n " - } - }, - "EbsOptimized": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

This property cannot be updated.

" - } - }, - "AgentVersion": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The default OpsWorks Stacks agent version. You have the following options:

\n \n

The default setting is INHERIT. To specify an agent version,\n you must use the complete version number, not the abbreviated number shown on the console.\n For a list of available agent version numbers, call DescribeAgentVersions.

\n

AgentVersion cannot be set to Chef 12.2.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#UpdateLayer": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#UpdateLayerRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates a specified layer.

\n

\n Required Permissions: To use this action, an IAM user must have a Manage permissions\n level for the stack, or an attached policy that explicitly grants permissions. For more\n information on user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#UpdateLayerRequest": { - "type": "structure", - "members": { - "LayerId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The layer ID.

", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The layer name, which is used by the console. Layer names can be a maximum of 32 characters.

" - } - }, - "Shortname": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

For custom layers only, use this parameter to specify the layer's short name, which is used internally by \n OpsWorks Stacks and by Chef. The short name is also used as the name for the directory where your app files \n are installed. It can have a maximum of 32 characters and must be in the following format: /\\A[a-z0-9\\-\\_\\.]+\\Z/.

\n

Built-in layer short names are defined by OpsWorks Stacks. For more information, see the \n Layer reference in the OpsWorks User Guide.\n

" - } - }, - "Attributes": { - "target": "com.amazonaws.opsworks#LayerAttributes", - "traits": { - "smithy.api#documentation": "

One or more user-defined key/value pairs to be added to the stack attributes.

" - } - }, - "CloudWatchLogsConfiguration": { - "target": "com.amazonaws.opsworks#CloudWatchLogsConfiguration", - "traits": { - "smithy.api#documentation": "

Specifies CloudWatch Logs configuration options for the layer. For more information, \n see CloudWatchLogsLogStream.

" - } - }, - "CustomInstanceProfileArn": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The ARN of an IAM profile to be used for all of the layer's EC2 instances. For more\n information about IAM ARNs, see Using\n Identifiers.

" - } - }, - "CustomJson": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

A JSON-formatted string containing custom stack configuration and deployment attributes\n to be installed on the layer's instances. For more information, see\n \n Using Custom JSON.\n

" - } - }, - "CustomSecurityGroupIds": { - "target": "com.amazonaws.opsworks#Strings", - "traits": { - "smithy.api#documentation": "

An array containing the layer's custom security group IDs.

" - } - }, - "Packages": { - "target": "com.amazonaws.opsworks#Strings", - "traits": { - "smithy.api#documentation": "

An array of Package objects that describe the layer's packages.

" - } - }, - "VolumeConfigurations": { - "target": "com.amazonaws.opsworks#VolumeConfigurations", - "traits": { - "smithy.api#documentation": "

A VolumeConfigurations object that describes the layer's Amazon EBS volumes.

" - } - }, - "EnableAutoHealing": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

Whether to disable auto healing for the layer.

" - } - }, - "AutoAssignElasticIps": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

Whether to automatically assign an Elastic IP\n address to the layer's instances. For more information, see How to Edit\n a Layer.

" - } - }, - "AutoAssignPublicIps": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

For stacks that are running in a VPC, whether to automatically assign a public IP address to\n the layer's instances. For more information, see How to Edit\n a Layer.

" - } - }, - "CustomRecipes": { - "target": "com.amazonaws.opsworks#Recipes", - "traits": { - "smithy.api#documentation": "

A LayerCustomRecipes object that specifies the layer's custom recipes.

" - } - }, - "InstallUpdatesOnBoot": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

Whether to install operating system and package updates when the instance boots. The default\n value is true. To control when updates are installed, set this value to\n false. You must then update your instances manually by using\n CreateDeployment to run the update_dependencies stack command or\n manually running yum (Amazon Linux) or apt-get (Ubuntu) on the\n instances.

\n \n

We strongly recommend using the default value of true, to ensure that your\n instances have the latest security updates.

\n " - } - }, - "UseEbsOptimizedInstances": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

Whether to use Amazon EBS-optimized instances.

" - } - }, - "LifecycleEventConfiguration": { - "target": "com.amazonaws.opsworks#LifecycleEventConfiguration", - "traits": { - "smithy.api#documentation": "

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#UpdateMyUserProfile": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#UpdateMyUserProfileRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates a user's SSH public key.

\n

\n Required Permissions: To use this action, an IAM user must have self-management\n enabled or an attached policy that explicitly grants permissions. For more information about user\n permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#UpdateMyUserProfileRequest": { - "type": "structure", - "members": { - "SshPublicKey": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The user's SSH public key.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#UpdateRdsDbInstance": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#UpdateRdsDbInstanceRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates an Amazon RDS instance.

\n

\n Required Permissions: To use this action, an IAM user must have a Manage permissions\n level for the stack, or an attached policy that explicitly grants permissions. For more\n information on user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#UpdateRdsDbInstanceRequest": { - "type": "structure", - "members": { - "RdsDbInstanceArn": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The Amazon RDS instance's ARN.

", - "smithy.api#required": {} - } - }, - "DbUser": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The master user name.

" - } - }, - "DbPassword": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The database password.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#UpdateStack": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#UpdateStackRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates a specified stack.

\n

\n Required Permissions: To use this action, an IAM user must have a Manage permissions\n level for the stack, or an attached policy that explicitly grants permissions. For more\n information on user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#UpdateStackRequest": { - "type": "structure", - "members": { - "StackId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The stack ID.

", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The stack's new name. Stack names can be a maximum of 64 characters.

" - } - }, - "Attributes": { - "target": "com.amazonaws.opsworks#StackAttributes", - "traits": { - "smithy.api#documentation": "

One or more user-defined key-value pairs to be added to the stack attributes.

" - } - }, - "ServiceRoleArn": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

Do not use this parameter. You cannot update a stack's service role.

" - } - }, - "DefaultInstanceProfileArn": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The ARN of an IAM profile that is the default profile for all of the stack's EC2 instances.\n For more information about IAM ARNs, see Using\n Identifiers.

" - } - }, - "DefaultOs": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The stack's operating system, which must be set to one of the following:

\n \n

The default option is the stack's current operating system.\n Not all operating systems are supported with all versions of Chef. For more information about supported operating systems,\n see OpsWorks Stacks Operating Systems.

" - } - }, - "HostnameTheme": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The stack's new host name theme, with spaces replaced by underscores.\n The theme is used to generate host names for the stack's instances.\n By default, HostnameTheme is set to Layer_Dependent, which creates host names by appending integers to \n the\n layer's short name. The other themes are:

\n \n

To obtain a generated host name, call GetHostNameSuggestion, which returns a\n host name based on the current theme.

" - } - }, - "DefaultAvailabilityZone": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The stack's default Availability Zone, which must be in the\n stack's region. For more\n information, see Regions and\n Endpoints. If you also specify a value for DefaultSubnetId, the subnet must\n be in the same zone. For more information, see CreateStack.

" - } - }, - "DefaultSubnetId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The stack's default VPC subnet ID. This parameter is required if you specify a value for the\n VpcId parameter. All instances are launched into this subnet unless you specify\n otherwise when you create the instance. If you also specify a value for\n DefaultAvailabilityZone, the subnet must be in that zone. For information on\n default values and when this parameter is required, see the VpcId parameter\n description.

" - } - }, - "CustomJson": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

A string that contains user-defined, custom JSON. It can be used to override the corresponding default stack configuration \n JSON values or to pass data to recipes. The string should be in the following format:

\n

\n \"{\\\"key1\\\": \\\"value1\\\", \\\"key2\\\": \\\"value2\\\",...}\"\n

\n

For more information about custom JSON, see Use Custom JSON to\n Modify the Stack Configuration Attributes.

" - } - }, - "ConfigurationManager": { - "target": "com.amazonaws.opsworks#StackConfigurationManager", - "traits": { - "smithy.api#documentation": "

The configuration manager. When you update a stack, we recommend that you use the configuration manager to specify the \n 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.

" - } - }, - "ChefConfiguration": { - "target": "com.amazonaws.opsworks#ChefConfiguration", - "traits": { - "smithy.api#documentation": "

A ChefConfiguration object that specifies whether to enable Berkshelf and the\n Berkshelf version on Chef 11.10 stacks. For more information, see Create a New Stack.

" - } - }, - "UseCustomCookbooks": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

Whether the stack uses custom cookbooks.

" - } - }, - "CustomCookbooksSource": { - "target": "com.amazonaws.opsworks#Source", - "traits": { - "smithy.api#documentation": "

Contains the information required to retrieve an app or cookbook from a repository. For more information, \n see Adding Apps or \n Cookbooks and Recipes.

" - } - }, - "DefaultSshKeyName": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

A default Amazon EC2 key-pair name. The default value is\n none. If you specify a key-pair name,\n OpsWorks Stacks installs the public key on the instance and you can use the private key with an SSH\n client to log in to the instance. For more information, see Using SSH to\n Communicate with an Instance and Managing SSH\n Access. You can override this setting by specifying a different key pair, or no key\n pair, when you \n create an instance.

" - } - }, - "DefaultRootDeviceType": { - "target": "com.amazonaws.opsworks#RootDeviceType", - "traits": { - "smithy.api#documentation": "

The default root device type. This value is used by default for all instances in the stack,\n but you can override it when you create an instance. For more information, see Storage for the Root Device.

" - } - }, - "UseOpsworksSecurityGroups": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

Whether to associate the OpsWorks Stacks built-in security groups with the stack's layers.

\n

OpsWorks Stacks provides a standard set of built-in security groups, one for each layer, which are\n associated with layers by default. UseOpsworksSecurityGroups allows you to\n provide your own custom security groups\n instead of using the built-in groups. UseOpsworksSecurityGroups has\n the following settings:

\n \n

For more information, see Create a New\n Stack.

" - } - }, - "AgentVersion": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The default OpsWorks Stacks agent version. You have the following options:

\n \n

The default setting is LATEST. To specify an agent version,\n you must use the complete version number, not the abbreviated number shown on the console.\n For a list of available agent version numbers, call DescribeAgentVersions. \n AgentVersion cannot be set to Chef 12.2.

\n \n

You can also specify an agent version when you create or update an instance, which overrides the stack's default \n setting.

\n " - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#UpdateUserProfile": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#UpdateUserProfileRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates a specified user profile.

\n

\n Required Permissions: To use this action, an IAM user must have an attached policy\n that explicitly grants permissions. For more information about user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#UpdateUserProfileRequest": { - "type": "structure", - "members": { - "IamUserArn": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The user IAM ARN. This can also be a federated user's ARN.

", - "smithy.api#required": {} - } - }, - "SshUsername": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The user's SSH user name. The allowable characters are [a-z], [A-Z], [0-9], '-', and '_'. If\n the specified name includes other punctuation marks, OpsWorks Stacks removes them. For example,\n my.name will be changed to myname. If you do not specify an SSH\n user name, OpsWorks Stacks generates one from the IAM user name.

" - } - }, - "SshPublicKey": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The user's new SSH public key.

" - } - }, - "AllowSelfManagement": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

Whether users can specify their own SSH public key through the My Settings page. For more\n information, see Managing User\n Permissions.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#UpdateVolume": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworks#UpdateVolumeRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.opsworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates an Amazon EBS volume's name or mount point. For more information, see \n Resource Management.

\n

\n Required Permissions: To use this action, an IAM user must have a Manage permissions\n level for the stack, or an attached policy that explicitly grants permissions. For more\n information on user permissions, see Managing User\n Permissions.

" - } - }, - "com.amazonaws.opsworks#UpdateVolumeRequest": { - "type": "structure", - "members": { - "VolumeId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The volume ID.

", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The new name. Volume names can be a maximum of 128 characters.

" - } - }, - "MountPoint": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The new mount point.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworks#UserProfile": { - "type": "structure", - "members": { - "IamUserArn": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The user's IAM ARN.

" - } - }, - "Name": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The user's name.

" - } - }, - "SshUsername": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The user's SSH user name.

" - } - }, - "SshPublicKey": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The user's SSH public key.

" - } - }, - "AllowSelfManagement": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

Whether users can specify their own SSH public key through the My Settings page. For more\n information, see Managing User\n Permissions.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a user's SSH information.

" - } - }, - "com.amazonaws.opsworks#UserProfiles": { - "type": "list", - "member": { - "target": "com.amazonaws.opsworks#UserProfile" - } - }, - "com.amazonaws.opsworks#ValidForInMinutes": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 60, - "max": 1440 - } - } - }, - "com.amazonaws.opsworks#ValidationException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The exception message.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Indicates that a request was not valid.

", - "smithy.api#error": "client" - } - }, - "com.amazonaws.opsworks#VirtualizationType": { - "type": "enum", - "members": { - "paravirtual": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "paravirtual" - } - }, - "hvm": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "hvm" - } - } - } - }, - "com.amazonaws.opsworks#Volume": { - "type": "structure", - "members": { - "VolumeId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The volume ID.

" - } - }, - "Ec2VolumeId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The Amazon EC2 volume ID.

" - } - }, - "Name": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The volume name. Volume names are a maximum of 128 characters.

" - } - }, - "RaidArrayId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The RAID array ID.

" - } - }, - "InstanceId": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The instance ID.

" - } - }, - "Status": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The value returned by DescribeVolumes.

" - } - }, - "Size": { - "target": "com.amazonaws.opsworks#Integer", - "traits": { - "smithy.api#documentation": "

The volume size.

" - } - }, - "Device": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The device name.

" - } - }, - "MountPoint": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The volume mount point. For example, \"/mnt/disk1\".

" - } - }, - "Region": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services Region. For more information about Amazon Web Services Regions, see \n Regions and Endpoints.

" - } - }, - "AvailabilityZone": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The volume Availability Zone. For more information, see Regions and Endpoints.

" - } - }, - "VolumeType": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The volume type. For more information, see \n Amazon EBS Volume Types.

\n " - } - }, - "Iops": { - "target": "com.amazonaws.opsworks#Integer", - "traits": { - "smithy.api#documentation": "

For PIOPS volumes, the IOPS per disk.

" - } - }, - "Encrypted": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

Specifies whether an Amazon EBS volume is encrypted. For more information, \n see Amazon EBS Encryption.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an instance's Amazon EBS volume.

" - } - }, - "com.amazonaws.opsworks#VolumeConfiguration": { - "type": "structure", - "members": { - "MountPoint": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The volume mount point. For example \"/dev/sdh\".

", - "smithy.api#required": {} - } - }, - "RaidLevel": { - "target": "com.amazonaws.opsworks#Integer", - "traits": { - "smithy.api#documentation": "

The volume RAID level.

" - } - }, - "NumberOfDisks": { - "target": "com.amazonaws.opsworks#Integer", - "traits": { - "smithy.api#documentation": "

The number of disks in the volume.

", - "smithy.api#required": {} - } - }, - "Size": { - "target": "com.amazonaws.opsworks#Integer", - "traits": { - "smithy.api#documentation": "

The volume size.

", - "smithy.api#required": {} - } - }, - "VolumeType": { - "target": "com.amazonaws.opsworks#String", - "traits": { - "smithy.api#documentation": "

The volume type. For more information, see \n Amazon EBS Volume Types.

\n " - } - }, - "Iops": { - "target": "com.amazonaws.opsworks#Integer", - "traits": { - "smithy.api#documentation": "

For PIOPS volumes, the IOPS per disk.

" - } - }, - "Encrypted": { - "target": "com.amazonaws.opsworks#Boolean", - "traits": { - "smithy.api#documentation": "

Specifies whether an Amazon EBS volume is encrypted. For more information, \n see Amazon EBS Encryption.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an Amazon EBS volume configuration.

" - } - }, - "com.amazonaws.opsworks#VolumeConfigurations": { - "type": "list", - "member": { - "target": "com.amazonaws.opsworks#VolumeConfiguration" - } - }, - "com.amazonaws.opsworks#VolumeType": { - "type": "enum", - "members": { - "gp2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "gp2" - } - }, - "io1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "io1" - } - }, - "standard": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "standard" - } - } - } - }, - "com.amazonaws.opsworks#Volumes": { - "type": "list", - "member": { - "target": "com.amazonaws.opsworks#Volume" - } - }, - "com.amazonaws.opsworks#WeeklyAutoScalingSchedule": { - "type": "structure", - "members": { - "Monday": { - "target": "com.amazonaws.opsworks#DailyAutoScalingSchedule", - "traits": { - "smithy.api#documentation": "

The schedule for Monday.

" - } - }, - "Tuesday": { - "target": "com.amazonaws.opsworks#DailyAutoScalingSchedule", - "traits": { - "smithy.api#documentation": "

The schedule for Tuesday.

" - } - }, - "Wednesday": { - "target": "com.amazonaws.opsworks#DailyAutoScalingSchedule", - "traits": { - "smithy.api#documentation": "

The schedule for Wednesday.

" - } - }, - "Thursday": { - "target": "com.amazonaws.opsworks#DailyAutoScalingSchedule", - "traits": { - "smithy.api#documentation": "

The schedule for Thursday.

" - } - }, - "Friday": { - "target": "com.amazonaws.opsworks#DailyAutoScalingSchedule", - "traits": { - "smithy.api#documentation": "

The schedule for Friday.

" - } - }, - "Saturday": { - "target": "com.amazonaws.opsworks#DailyAutoScalingSchedule", - "traits": { - "smithy.api#documentation": "

The schedule for Saturday.

" - } - }, - "Sunday": { - "target": "com.amazonaws.opsworks#DailyAutoScalingSchedule", - "traits": { - "smithy.api#documentation": "

The schedule for Sunday.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a time-based instance's auto scaling schedule. The schedule consists of a set of key-value pairs.

\n \n

The default setting for all time periods is off, so you use the following parameters primarily to specify the online periods. You don't have to explicitly specify offline periods unless you want to change an online period to an offline period.

\n

The following example specifies that the instance should be online for four hours, \n from UTC 1200 - 1600. It will be off for the remainder of the day.

\n

\n { \"12\":\"on\", \"13\":\"on\", \"14\":\"on\", \"15\":\"on\" } \n

" - } - } - } -} \ No newline at end of file diff --git a/models/opsworkscm/service/2016-11-01/opsworkscm-2016-11-01.json b/models/opsworkscm/service/2016-11-01/opsworkscm-2016-11-01.json deleted file mode 100644 index b106e93e..00000000 --- a/models/opsworkscm/service/2016-11-01/opsworkscm-2016-11-01.json +++ /dev/null @@ -1,3089 +0,0 @@ -{ - "smithy": "2.0", - "metadata": { - "suppressions": [ - { - "id": "HttpMethodSemantics", - "namespace": "*" - }, - { - "id": "HttpResponseCodeSemantics", - "namespace": "*" - }, - { - "id": "PaginatedTrait", - "namespace": "*" - }, - { - "id": "HttpHeaderTrait", - "namespace": "*" - }, - { - "id": "HttpUriConflict", - "namespace": "*" - }, - { - "id": "Service", - "namespace": "*" - } - ] - }, - "shapes": { - "com.amazonaws.opsworkscm#AWSOpsWorksCMResourceArn": { - "type": "string", - "traits": { - "smithy.api#pattern": "^arn:aws.*:opsworks-cm:.*:[0-9]{12}:" - } - }, - "com.amazonaws.opsworkscm#AccountAttribute": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.opsworkscm#String", - "traits": { - "smithy.api#documentation": "

\n The attribute name. The following are supported attribute names.\n

\n " - } - }, - "Maximum": { - "target": "com.amazonaws.opsworkscm#Integer", - "traits": { - "smithy.api#documentation": "

\n The maximum allowed value.\n

" - } - }, - "Used": { - "target": "com.amazonaws.opsworkscm#Integer", - "traits": { - "smithy.api#documentation": "

\n The current usage, such as the current number of servers that are associated with the account.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Stores account attributes.\n

" - } - }, - "com.amazonaws.opsworkscm#AccountAttributes": { - "type": "list", - "member": { - "target": "com.amazonaws.opsworkscm#AccountAttribute" - }, - "traits": { - "smithy.api#documentation": "

\n A list of individual account attributes.\n

" - } - }, - "com.amazonaws.opsworkscm#AssociateNode": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworkscm#AssociateNodeRequest" - }, - "output": { - "target": "com.amazonaws.opsworkscm#AssociateNodeResponse" - }, - "errors": [ - { - "target": "com.amazonaws.opsworkscm#InvalidStateException" - }, - { - "target": "com.amazonaws.opsworkscm#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworkscm#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Associates a new node with the server. For more information about how to disassociate a node, see DisassociateNode.

\n

\n On a Chef server: This command is an alternative to knife bootstrap.

\n

\n Example (Chef): aws opsworks-cm associate-node --server-name MyServer --node-name MyManagedNode --engine-attributes \"Name=CHEF_ORGANIZATION,Value=default\" \"Name=CHEF_AUTOMATE_NODE_PUBLIC_KEY,Value=public-key-pem\"\n

\n

\n On a Puppet server, this command is an alternative to the puppet cert sign command that signs a Puppet node CSR.\n

\n

\n Example (Puppet): aws opsworks-cm associate-node --server-name MyServer --node-name MyManagedNode --engine-attributes \"Name=PUPPET_NODE_CSR,Value=csr-pem\"\n

\n

\n A node can can only be associated with servers that are in a HEALTHY state. Otherwise, an InvalidStateException is thrown.\n A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are not valid.\n The AssociateNode API call can be integrated into Auto Scaling configurations, CloudFormation templates, or the user data \n of a server's instance.\n

" - } - }, - "com.amazonaws.opsworkscm#AssociateNodeRequest": { - "type": "structure", - "members": { - "ServerName": { - "target": "com.amazonaws.opsworkscm#ServerName", - "traits": { - "smithy.api#documentation": "

The name of the server with which to associate the node.\n

", - "smithy.api#required": {} - } - }, - "NodeName": { - "target": "com.amazonaws.opsworkscm#NodeName", - "traits": { - "smithy.api#documentation": "

The name of the node.\n

", - "smithy.api#required": {} - } - }, - "EngineAttributes": { - "target": "com.amazonaws.opsworkscm#EngineAttributes", - "traits": { - "smithy.api#documentation": "

Engine attributes used for associating the node.\n

\n

\n Attributes accepted in a AssociateNode request for Chef\n

\n \n

\n Attributes accepted in a AssociateNode request for Puppet\n

\n ", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworkscm#AssociateNodeResponse": { - "type": "structure", - "members": { - "NodeAssociationStatusToken": { - "target": "com.amazonaws.opsworkscm#NodeAssociationStatusToken", - "traits": { - "smithy.api#documentation": "

Contains a token which can be passed to the DescribeNodeAssociationStatus API call to get the status of the association request.\n

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.opsworkscm#AttributeName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - }, - "smithy.api#pattern": "^[A-Z][A-Z0-9_]*$" - } - }, - "com.amazonaws.opsworkscm#AttributeValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 10000 - }, - "smithy.api#pattern": "^(?s)" - } - }, - "com.amazonaws.opsworkscm#Backup": { - "type": "structure", - "members": { - "BackupArn": { - "target": "com.amazonaws.opsworkscm#String", - "traits": { - "smithy.api#documentation": "

The ARN of the backup.\n

" - } - }, - "BackupId": { - "target": "com.amazonaws.opsworkscm#BackupId", - "traits": { - "smithy.api#documentation": "

\n The generated ID of the backup. Example: myServerName-yyyyMMddHHmmssSSS\n

" - } - }, - "BackupType": { - "target": "com.amazonaws.opsworkscm#BackupType", - "traits": { - "smithy.api#documentation": "

\n The backup type. Valid values are automated or manual.\n

" - } - }, - "CreatedAt": { - "target": "com.amazonaws.opsworkscm#Timestamp", - "traits": { - "smithy.api#documentation": "

\n The time stamp when the backup was created in the database. Example: 2016-07-29T13:38:47.520Z\n

" - } - }, - "Description": { - "target": "com.amazonaws.opsworkscm#String", - "traits": { - "smithy.api#documentation": "

\n A user-provided description for a manual backup. This field is empty for automated backups.\n

" - } - }, - "Engine": { - "target": "com.amazonaws.opsworkscm#String", - "traits": { - "smithy.api#documentation": "

\n The engine type that is obtained from the server when the backup is created.\n

" - } - }, - "EngineModel": { - "target": "com.amazonaws.opsworkscm#String", - "traits": { - "smithy.api#documentation": "

\n The engine model that is obtained from the server when the backup is created.\n

" - } - }, - "EngineVersion": { - "target": "com.amazonaws.opsworkscm#String", - "traits": { - "smithy.api#documentation": "

\n The engine version that is obtained from the server when the backup is created.\n

" - } - }, - "InstanceProfileArn": { - "target": "com.amazonaws.opsworkscm#String", - "traits": { - "smithy.api#documentation": "

\n The EC2 instance profile ARN that is obtained from the server when the backup is created. Because this value is stored,\n you are not required to provide the InstanceProfileArn again if you restore a backup.\n

" - } - }, - "InstanceType": { - "target": "com.amazonaws.opsworkscm#String", - "traits": { - "smithy.api#documentation": "

\n The instance type that is obtained from the server when the backup is created.\n

" - } - }, - "KeyPair": { - "target": "com.amazonaws.opsworkscm#String", - "traits": { - "smithy.api#documentation": "

\n The key pair that is obtained from the server when the backup is created.\n

" - } - }, - "PreferredBackupWindow": { - "target": "com.amazonaws.opsworkscm#TimeWindowDefinition", - "traits": { - "smithy.api#documentation": "

\n The preferred backup period that is obtained from the server when the backup is created.\n

" - } - }, - "PreferredMaintenanceWindow": { - "target": "com.amazonaws.opsworkscm#TimeWindowDefinition", - "traits": { - "smithy.api#documentation": "

\n The preferred maintenance period that is obtained from the server when the backup is created.\n

" - } - }, - "S3DataSize": { - "target": "com.amazonaws.opsworkscm#Integer", - "traits": { - "smithy.api#deprecated": {}, - "smithy.api#documentation": "

\n This field is deprecated and is no longer used.\n

" - } - }, - "S3DataUrl": { - "target": "com.amazonaws.opsworkscm#String", - "traits": { - "smithy.api#deprecated": {}, - "smithy.api#documentation": "

\n This field is deprecated and is no longer used.\n

" - } - }, - "S3LogUrl": { - "target": "com.amazonaws.opsworkscm#String", - "traits": { - "smithy.api#documentation": "

\n The Amazon S3 URL of the backup's log file.\n

" - } - }, - "SecurityGroupIds": { - "target": "com.amazonaws.opsworkscm#Strings", - "traits": { - "smithy.api#documentation": "

\n The security group IDs that are obtained from the server when the backup is created.\n

" - } - }, - "ServerName": { - "target": "com.amazonaws.opsworkscm#ServerName", - "traits": { - "smithy.api#documentation": "

\n The name of the server from which the backup was made.\n

" - } - }, - "ServiceRoleArn": { - "target": "com.amazonaws.opsworkscm#String", - "traits": { - "smithy.api#documentation": "

\n The service role ARN that is obtained from the server when the backup is created.\n

" - } - }, - "Status": { - "target": "com.amazonaws.opsworkscm#BackupStatus", - "traits": { - "smithy.api#documentation": "

The status of a backup while in progress.\n

" - } - }, - "StatusDescription": { - "target": "com.amazonaws.opsworkscm#String", - "traits": { - "smithy.api#documentation": "

\n An informational message about backup status.\n

" - } - }, - "SubnetIds": { - "target": "com.amazonaws.opsworkscm#Strings", - "traits": { - "smithy.api#documentation": "

\n The subnet IDs that are obtained from the server when the backup is created.\n

" - } - }, - "ToolsVersion": { - "target": "com.amazonaws.opsworkscm#String", - "traits": { - "smithy.api#documentation": "

\n The version of OpsWorks CM-specific tools that is obtained from the server when the backup is created.\n

" - } - }, - "UserArn": { - "target": "com.amazonaws.opsworkscm#String", - "traits": { - "smithy.api#documentation": "

\n The user ARN of the requester for manual backups. This field is empty for automated backups.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a single backup.\n

" - } - }, - "com.amazonaws.opsworkscm#BackupId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 79 - }, - "smithy.api#pattern": "^[a-zA-Z][a-zA-Z0-9\\-\\.\\:]*$" - } - }, - "com.amazonaws.opsworkscm#BackupRetentionCountDefinition": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1 - } - } - }, - "com.amazonaws.opsworkscm#BackupStatus": { - "type": "enum", - "members": { - "IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IN_PROGRESS" - } - }, - "OK": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "OK" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - }, - "DELETING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETING" - } - } - } - }, - "com.amazonaws.opsworkscm#BackupType": { - "type": "enum", - "members": { - "AUTOMATED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AUTOMATED" - } - }, - "MANUAL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MANUAL" - } - } - } - }, - "com.amazonaws.opsworkscm#Backups": { - "type": "list", - "member": { - "target": "com.amazonaws.opsworkscm#Backup" - } - }, - "com.amazonaws.opsworkscm#Boolean": { - "type": "boolean" - }, - "com.amazonaws.opsworkscm#CreateBackup": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworkscm#CreateBackupRequest" - }, - "output": { - "target": "com.amazonaws.opsworkscm#CreateBackupResponse" - }, - "errors": [ - { - "target": "com.amazonaws.opsworkscm#InvalidStateException" - }, - { - "target": "com.amazonaws.opsworkscm#LimitExceededException" - }, - { - "target": "com.amazonaws.opsworkscm#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworkscm#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

\n Creates an application-level backup of a server. While the\n server is in the BACKING_UP state, the server cannot be\n changed, and no additional backup can be created.\n

\n

\n Backups can be created for servers in RUNNING, HEALTHY, and UNHEALTHY states. \n By default, you can create a maximum of 50\n manual backups.\n

\n

\n This operation is asynchronous.\n

\n

\n A LimitExceededException is thrown when the maximum number of manual backups is reached.\n An InvalidStateException is thrown when the server is not in any of the following states: RUNNING, HEALTHY, or UNHEALTHY.\n A ResourceNotFoundException is thrown when the server is not found.\n A ValidationException is thrown when parameters of the request are not valid.\n

" - } - }, - "com.amazonaws.opsworkscm#CreateBackupRequest": { - "type": "structure", - "members": { - "ServerName": { - "target": "com.amazonaws.opsworkscm#ServerName", - "traits": { - "smithy.api#documentation": "

The name of the server that you want to back up.\n

", - "smithy.api#required": {} - } - }, - "Description": { - "target": "com.amazonaws.opsworkscm#String", - "traits": { - "smithy.api#documentation": "

\n A user-defined description of the backup.\n

" - } - }, - "Tags": { - "target": "com.amazonaws.opsworkscm#TagList", - "traits": { - "smithy.api#documentation": "

A map that contains tag keys and tag values to attach to an OpsWorks CM server backup.

\n " - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworkscm#CreateBackupResponse": { - "type": "structure", - "members": { - "Backup": { - "target": "com.amazonaws.opsworkscm#Backup", - "traits": { - "smithy.api#documentation": "

Backup created by request.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.opsworkscm#CreateServer": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworkscm#CreateServerRequest" - }, - "output": { - "target": "com.amazonaws.opsworkscm#CreateServerResponse" - }, - "errors": [ - { - "target": "com.amazonaws.opsworkscm#LimitExceededException" - }, - { - "target": "com.amazonaws.opsworkscm#ResourceAlreadyExistsException" - }, - { - "target": "com.amazonaws.opsworkscm#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworkscm#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

\n Creates and immedately starts a new server. The server is ready to use when it is in the HEALTHY state. By \n default, you can create a maximum of 10 servers.\n

\n

\n This operation is asynchronous.\n

\n

\n A LimitExceededException is thrown when you have created the maximum number of servers (10). A \n ResourceAlreadyExistsException\n is thrown when a server with the same name already exists in the account. A ResourceNotFoundException is thrown when \n you\n specify a backup ID that is not valid or is for a backup that does not exist. A ValidationException is thrown when \n parameters\n of the request are not valid.\n

\n

\n If you do not specify a security group by adding the SecurityGroupIds parameter, OpsWorks creates a new \n security group.\n

\n

\n Chef Automate: The default security group opens the Chef server to the world on TCP port 443. If \n a KeyName is present, OpsWorks enables SSH access. SSH is also open to the world on TCP port 22.\n

\n

\n Puppet Enterprise: The default security group opens TCP ports 22, 443, 4433, 8140, 8142, 8143, and 8170. If a KeyName is present, OpsWorks enables SSH access. SSH is also open to the world on TCP port 22.\n

\n

By default, your server is accessible from any IP address. We\n recommend that you update your security group rules to allow\n access from known IP addresses and address ranges only. To edit security group rules, open Security Groups\n in the navigation pane of the EC2 management console.\n

\n

To specify your own domain for a server, and provide your own self-signed or CA-signed certificate and private key, \n specify values for CustomDomain, \n CustomCertificate, and CustomPrivateKey.

" - } - }, - "com.amazonaws.opsworkscm#CreateServerRequest": { - "type": "structure", - "members": { - "AssociatePublicIpAddress": { - "target": "com.amazonaws.opsworkscm#Boolean", - "traits": { - "smithy.api#documentation": "

\n Associate a public IP address with a server that you are launching. Valid values are true or false. The default value is true.\n

" - } - }, - "CustomDomain": { - "target": "com.amazonaws.opsworkscm#CustomDomain", - "traits": { - "smithy.api#documentation": "

An optional public endpoint of a server, such as https://aws.my-company.com. To access the server, create a CNAME DNS record in your preferred DNS service that points the custom \n domain to the endpoint that is generated when the server is created (the value of the CreateServer Endpoint attribute). You cannot access the server by using the \n generated Endpoint value if the server is using a custom domain. If you specify a custom domain, you must also specify values for CustomCertificate \n and CustomPrivateKey.

" - } - }, - "CustomCertificate": { - "target": "com.amazonaws.opsworkscm#CustomCertificate", - "traits": { - "smithy.api#documentation": "

A PEM-formatted HTTPS certificate. The value can be be a single, self-signed certificate, or a certificate chain. If you specify a \n custom certificate, you must also specify values for CustomDomain and CustomPrivateKey. The following are requirements for the CustomCertificate value:

\n " - } - }, - "CustomPrivateKey": { - "target": "com.amazonaws.opsworkscm#CustomPrivateKey", - "traits": { - "smithy.api#documentation": "

A private key in PEM format for connecting to the server by using HTTPS. The private key must not be encrypted; it cannot be protected by a password or passphrase. \n If you specify a custom private key, you must also specify values for CustomDomain and CustomCertificate.

" - } - }, - "DisableAutomatedBackup": { - "target": "com.amazonaws.opsworkscm#Boolean", - "traits": { - "smithy.api#documentation": "

\n Enable or disable scheduled backups. Valid values are true or false. The default value is true.\n

" - } - }, - "Engine": { - "target": "com.amazonaws.opsworkscm#String", - "traits": { - "smithy.api#documentation": "

\n The configuration management engine to use. Valid values include ChefAutomate and Puppet.\n

", - "smithy.api#required": {} - } - }, - "EngineModel": { - "target": "com.amazonaws.opsworkscm#String", - "traits": { - "smithy.api#documentation": "

\n The engine model of the server. Valid values in this release include Monolithic for Puppet and Single for Chef.\n

" - } - }, - "EngineVersion": { - "target": "com.amazonaws.opsworkscm#String", - "traits": { - "smithy.api#documentation": "

\n The major release version of the engine that you want to use. For a Chef server, the valid value for EngineVersion \n is currently 2. For a Puppet server, valid values are 2019 or 2017.\n

" - } - }, - "EngineAttributes": { - "target": "com.amazonaws.opsworkscm#EngineAttributes", - "traits": { - "smithy.api#documentation": "

Optional engine attributes on a specified server.\n

\n

\n Attributes accepted in a Chef createServer request:\n

\n \n

\n Attributes accepted in a Puppet createServer request:\n

\n " - } - }, - "BackupRetentionCount": { - "target": "com.amazonaws.opsworkscm#BackupRetentionCountDefinition", - "traits": { - "smithy.api#documentation": "

\n The number of automated backups that you want to keep. Whenever a new backup is created, OpsWorks CM deletes the oldest backups if this number is exceeded.\n The default value is 1.\n

" - } - }, - "ServerName": { - "target": "com.amazonaws.opsworkscm#ServerName", - "traits": { - "smithy.api#documentation": "

\n The name of the server. The server name must be unique within your Amazon Web Services account, within each region.\n Server names must start with a letter; then letters, numbers, or hyphens (-) are allowed, up to a maximum of 40 characters.\n

", - "smithy.api#required": {} - } - }, - "InstanceProfileArn": { - "target": "com.amazonaws.opsworkscm#InstanceProfileArn", - "traits": { - "smithy.api#documentation": "

\n The ARN of the instance profile that your Amazon EC2\n instances use. The OpsWorks console typically creates\n the instance profile for you

", - "smithy.api#required": {} - } - }, - "InstanceType": { - "target": "com.amazonaws.opsworkscm#String", - "traits": { - "smithy.api#documentation": "

\n The Amazon EC2 instance type to use. For example, m5.large.\n

", - "smithy.api#required": {} - } - }, - "KeyPair": { - "target": "com.amazonaws.opsworkscm#KeyPair", - "traits": { - "smithy.api#documentation": "

\n 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.\n

" - } - }, - "PreferredMaintenanceWindow": { - "target": "com.amazonaws.opsworkscm#TimeWindowDefinition", - "traits": { - "smithy.api#documentation": "

\n The start time for a one-hour period each week during which OpsWorks CM performs maintenance on the instance.\n Valid values must be specified in the following format: DDD:HH:MM. MM must be specified as 00. The specified time is in coordinated universal time (UTC).\n The default value is a random one-hour period on Tuesday, Wednesday, or Friday. See TimeWindowDefinition for more information.\n

\n

\n Example:\n Mon:08:00,\n which represents a start time of every Monday at 08:00 UTC. (8:00 a.m.)\n

" - } - }, - "PreferredBackupWindow": { - "target": "com.amazonaws.opsworkscm#TimeWindowDefinition", - "traits": { - "smithy.api#documentation": "

\n The start time for a one-hour period during which OpsWorks CM backs up application-level data on your server\n if automated backups are enabled. Valid values must be specified in one of the following formats:\n

\n \n

\n MM must be specified as 00. The specified time is in coordinated universal time (UTC). The default value is a random, daily start time.

\n

\n Example:\n 08:00, which represents a daily start time of 08:00 UTC.

\n

\n Example:\n Mon:08:00, which represents a start time of every Monday at 08:00 UTC. (8:00 a.m.)

" - } - }, - "SecurityGroupIds": { - "target": "com.amazonaws.opsworkscm#Strings", - "traits": { - "smithy.api#documentation": "

\n A list of security group IDs to attach to the Amazon EC2 instance. If you add this parameter, the specified security groups\n must be within the VPC that is specified by SubnetIds.\n

\n

\n If you do not specify this parameter, OpsWorks CM creates one new security group that uses TCP ports 22 and 443, open to\n 0.0.0.0/0 (everyone).\n

" - } - }, - "ServiceRoleArn": { - "target": "com.amazonaws.opsworkscm#ServiceRoleArn", - "traits": { - "smithy.api#documentation": "

\n The service role that the OpsWorks CM service backend uses to work with your account.

", - "smithy.api#required": {} - } - }, - "SubnetIds": { - "target": "com.amazonaws.opsworkscm#Strings", - "traits": { - "smithy.api#documentation": "

\n The IDs of subnets in which to launch the server EC2 instance.\n

\n

\n Amazon EC2-Classic customers: This field is required. All servers must run within a VPC. The VPC must have \"Auto Assign Public IP\" enabled.\n

\n

\n EC2-VPC customers: This field is optional. If you do not specify subnet IDs, your EC2 instances are created in a default subnet that \n is selected by Amazon EC2. If you specify subnet IDs, the VPC must have \"Auto Assign Public IP\" enabled.\n

\n

For more information about supported Amazon EC2 platforms, see\n Supported Platforms.

" - } - }, - "Tags": { - "target": "com.amazonaws.opsworkscm#TagList", - "traits": { - "smithy.api#documentation": "

A map that contains tag keys and tag values to attach to an OpsWorks for Chef Automate or OpsWorks for Puppet Enterprise server.

\n " - } - }, - "BackupId": { - "target": "com.amazonaws.opsworkscm#BackupId", - "traits": { - "smithy.api#documentation": "

\n If you specify this field, OpsWorks CM creates the server by using the backup represented by BackupId.\n

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworkscm#CreateServerResponse": { - "type": "structure", - "members": { - "Server": { - "target": "com.amazonaws.opsworkscm#Server", - "traits": { - "smithy.api#documentation": "

The server that is created by the request.\n

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.opsworkscm#CustomCertificate": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 2097152 - }, - "smithy.api#pattern": "^(?s)\\s*-----BEGIN CERTIFICATE-----.+-----END CERTIFICATE-----\\s*$" - } - }, - "com.amazonaws.opsworkscm#CustomDomain": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 253 - }, - "smithy.api#pattern": "^(((?!-)[A-Za-z0-9-]{0,62}[A-Za-z0-9])\\.)+((?!-)[A-Za-z0-9-]{1,62}[A-Za-z0-9])$" - } - }, - "com.amazonaws.opsworkscm#CustomPrivateKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 4096 - }, - "smithy.api#pattern": "^(?ms)\\s*^-----BEGIN (?-s:.*)PRIVATE KEY-----$.*?^-----END (?-s:.*)PRIVATE KEY-----$\\s*$", - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.opsworkscm#DeleteBackup": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworkscm#DeleteBackupRequest" - }, - "output": { - "target": "com.amazonaws.opsworkscm#DeleteBackupResponse" - }, - "errors": [ - { - "target": "com.amazonaws.opsworkscm#InvalidStateException" - }, - { - "target": "com.amazonaws.opsworkscm#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworkscm#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

\n Deletes a backup. You can delete both manual and automated backups. This operation is asynchronous.\n

\n

\n An InvalidStateException is thrown when a backup deletion is already in progress.\n A ResourceNotFoundException is thrown when the backup does not exist.\n A ValidationException is thrown when parameters of the request are not valid.\n

" - } - }, - "com.amazonaws.opsworkscm#DeleteBackupRequest": { - "type": "structure", - "members": { - "BackupId": { - "target": "com.amazonaws.opsworkscm#BackupId", - "traits": { - "smithy.api#documentation": "

The ID of the backup to delete. Run the DescribeBackups command to get a list of backup IDs.\n Backup IDs are in the format ServerName-yyyyMMddHHmmssSSS.\n

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworkscm#DeleteBackupResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.opsworkscm#DeleteServer": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworkscm#DeleteServerRequest" - }, - "output": { - "target": "com.amazonaws.opsworkscm#DeleteServerResponse" - }, - "errors": [ - { - "target": "com.amazonaws.opsworkscm#InvalidStateException" - }, - { - "target": "com.amazonaws.opsworkscm#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworkscm#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

\n Deletes the server and the underlying CloudFormation stacks\n (including the server's EC2 instance). When you run this command, the server state is updated\n to DELETING. After the server is deleted, it is no longer returned by\n DescribeServer requests. If the CloudFormation stack cannot be deleted, the server cannot be deleted.\n

\n

\n This operation is asynchronous.\n

\n

\n An InvalidStateException is thrown when a server deletion is already in progress.\n A ResourceNotFoundException is thrown when the server does not exist.\n A ValidationException is raised when parameters of the request are not valid.\n

\n

\n

" - } - }, - "com.amazonaws.opsworkscm#DeleteServerRequest": { - "type": "structure", - "members": { - "ServerName": { - "target": "com.amazonaws.opsworkscm#ServerName", - "traits": { - "smithy.api#documentation": "

The ID of the server to delete.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworkscm#DeleteServerResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.opsworkscm#DescribeAccountAttributes": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworkscm#DescribeAccountAttributesRequest" - }, - "output": { - "target": "com.amazonaws.opsworkscm#DescribeAccountAttributesResponse" - }, - "traits": { - "smithy.api#documentation": "

\n Describes your OpsWorks CM account attributes.\n

\n

\n This operation is synchronous.\n

" - } - }, - "com.amazonaws.opsworkscm#DescribeAccountAttributesRequest": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworkscm#DescribeAccountAttributesResponse": { - "type": "structure", - "members": { - "Attributes": { - "target": "com.amazonaws.opsworkscm#AccountAttributes", - "traits": { - "smithy.api#documentation": "

\n The attributes that are currently set for the account.\n

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.opsworkscm#DescribeBackups": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworkscm#DescribeBackupsRequest" - }, - "output": { - "target": "com.amazonaws.opsworkscm#DescribeBackupsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.opsworkscm#InvalidNextTokenException" - }, - { - "target": "com.amazonaws.opsworkscm#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworkscm#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

\n Describes backups. The results are ordered by time, with newest backups first.\n If you do not specify a BackupId or ServerName, the command returns all backups.\n

\n

\n This operation is synchronous.\n

\n

\n A ResourceNotFoundException is thrown when the backup does not exist.\n A ValidationException is raised when parameters of the request are not valid.\n

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "Backups", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.opsworkscm#DescribeBackupsRequest": { - "type": "structure", - "members": { - "BackupId": { - "target": "com.amazonaws.opsworkscm#BackupId", - "traits": { - "smithy.api#documentation": "

Describes a single backup.\n

" - } - }, - "ServerName": { - "target": "com.amazonaws.opsworkscm#ServerName", - "traits": { - "smithy.api#documentation": "

Returns backups for the server with the specified ServerName.\n

" - } - }, - "NextToken": { - "target": "com.amazonaws.opsworkscm#NextToken", - "traits": { - "smithy.api#documentation": "

This is not currently implemented for DescribeBackups requests.

" - } - }, - "MaxResults": { - "target": "com.amazonaws.opsworkscm#MaxResults", - "traits": { - "smithy.api#documentation": "

This is not currently implemented for DescribeBackups requests.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworkscm#DescribeBackupsResponse": { - "type": "structure", - "members": { - "Backups": { - "target": "com.amazonaws.opsworkscm#Backups", - "traits": { - "smithy.api#documentation": "

Contains the response to a DescribeBackups request.\n

" - } - }, - "NextToken": { - "target": "com.amazonaws.opsworkscm#String", - "traits": { - "smithy.api#documentation": "

This is not currently implemented for DescribeBackups requests.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.opsworkscm#DescribeEvents": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworkscm#DescribeEventsRequest" - }, - "output": { - "target": "com.amazonaws.opsworkscm#DescribeEventsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.opsworkscm#InvalidNextTokenException" - }, - { - "target": "com.amazonaws.opsworkscm#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworkscm#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

\n Describes events for a specified server. Results are ordered by time, with newest events first.\n

\n

\n This operation is synchronous.\n

\n

\n A ResourceNotFoundException is thrown when the server does not exist.\n A ValidationException is raised when parameters of the request are not valid.\n

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "ServerEvents", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.opsworkscm#DescribeEventsRequest": { - "type": "structure", - "members": { - "ServerName": { - "target": "com.amazonaws.opsworkscm#ServerName", - "traits": { - "smithy.api#documentation": "

The name of the server for which you want to view events.

", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.opsworkscm#NextToken", - "traits": { - "smithy.api#documentation": "

NextToken is a string that is returned in some command responses. It indicates that\n not all entries have been returned, and that you must run at least one more request to get remaining\n items. To get remaining results, call DescribeEvents again, and assign the token from the previous\n results as the value of the nextToken parameter. If there are no more results,\n the response object's nextToken parameter value is null.\n Setting a nextToken value that was not returned in\n your previous results causes an InvalidNextTokenException to occur.\n

" - } - }, - "MaxResults": { - "target": "com.amazonaws.opsworkscm#MaxResults", - "traits": { - "smithy.api#documentation": "

To receive a paginated response, use this parameter to specify the maximum number\n of results to be returned with a single call. If the number of available results exceeds\n this maximum, the response includes a NextToken value that you can assign to the NextToken\n request parameter to get the next set of results.\n

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworkscm#DescribeEventsResponse": { - "type": "structure", - "members": { - "ServerEvents": { - "target": "com.amazonaws.opsworkscm#ServerEvents", - "traits": { - "smithy.api#documentation": "

Contains the response to a DescribeEvents request.\n

" - } - }, - "NextToken": { - "target": "com.amazonaws.opsworkscm#String", - "traits": { - "smithy.api#documentation": "

NextToken is a string that is returned in some command responses. It indicates that\n not all entries have been returned, and that you must run at least one more request to get remaining\n items. To get remaining results, call DescribeEvents again, and assign the token from the previous\n results as the value of the nextToken parameter. If there are no more results,\n the response object's nextToken parameter value is null.\n Setting a nextToken value that was not returned in\n your previous results causes an InvalidNextTokenException to occur.\n

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.opsworkscm#DescribeNodeAssociationStatus": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworkscm#DescribeNodeAssociationStatusRequest" - }, - "output": { - "target": "com.amazonaws.opsworkscm#DescribeNodeAssociationStatusResponse" - }, - "errors": [ - { - "target": "com.amazonaws.opsworkscm#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworkscm#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

\n Returns the current status of an existing association or disassociation request.\n

\n

\n A ResourceNotFoundException is thrown when no recent association or disassociation request with the specified token is found,\n or when the server does not exist. A ValidationException is raised when parameters of the request are not valid.\n

", - "smithy.waiters#waitable": { - "NodeAssociated": { - "documentation": "Wait until node is associated or disassociated.", - "acceptors": [ - { - "state": "success", - "matcher": { - "output": { - "path": "NodeAssociationStatus", - "expected": "SUCCESS", - "comparator": "stringEquals" - } - } - }, - { - "state": "failure", - "matcher": { - "output": { - "path": "NodeAssociationStatus", - "expected": "FAILED", - "comparator": "stringEquals" - } - } - } - ], - "minDelay": 15 - } - } - } - }, - "com.amazonaws.opsworkscm#DescribeNodeAssociationStatusRequest": { - "type": "structure", - "members": { - "NodeAssociationStatusToken": { - "target": "com.amazonaws.opsworkscm#NodeAssociationStatusToken", - "traits": { - "smithy.api#documentation": "

The token returned in either the AssociateNodeResponse or the DisassociateNodeResponse.\n

", - "smithy.api#required": {} - } - }, - "ServerName": { - "target": "com.amazonaws.opsworkscm#ServerName", - "traits": { - "smithy.api#documentation": "

The name of the server from which to disassociate the node.\n

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworkscm#DescribeNodeAssociationStatusResponse": { - "type": "structure", - "members": { - "NodeAssociationStatus": { - "target": "com.amazonaws.opsworkscm#NodeAssociationStatus", - "traits": { - "smithy.api#documentation": "

The status of the association or disassociation request.\n

\n

\n Possible values:\n

\n " - } - }, - "EngineAttributes": { - "target": "com.amazonaws.opsworkscm#EngineAttributes", - "traits": { - "smithy.api#documentation": "

Attributes specific to the node association. \n In Puppet, the attribute PUPPET_NODE_CERT contains the signed certificate (the result of the CSR).\n

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.opsworkscm#DescribeServers": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworkscm#DescribeServersRequest" - }, - "output": { - "target": "com.amazonaws.opsworkscm#DescribeServersResponse" - }, - "errors": [ - { - "target": "com.amazonaws.opsworkscm#InvalidNextTokenException" - }, - { - "target": "com.amazonaws.opsworkscm#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworkscm#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

\n Lists all configuration management servers that are identified with your account.\n Only the stored results from Amazon DynamoDB\n are returned. OpsWorks CM does not query other services.\n

\n

\n This operation is synchronous.\n

\n

\n A ResourceNotFoundException is thrown when the server does not exist.\n A ValidationException is raised when parameters of the request are not valid.\n

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "Servers", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.opsworkscm#DescribeServersRequest": { - "type": "structure", - "members": { - "ServerName": { - "target": "com.amazonaws.opsworkscm#ServerName", - "traits": { - "smithy.api#documentation": "

Describes the server with the specified ServerName.

" - } - }, - "NextToken": { - "target": "com.amazonaws.opsworkscm#NextToken", - "traits": { - "smithy.api#documentation": "

This is not currently implemented for DescribeServers requests.\n

" - } - }, - "MaxResults": { - "target": "com.amazonaws.opsworkscm#MaxResults", - "traits": { - "smithy.api#documentation": "

This is not currently implemented for DescribeServers requests.\n

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworkscm#DescribeServersResponse": { - "type": "structure", - "members": { - "Servers": { - "target": "com.amazonaws.opsworkscm#Servers", - "traits": { - "smithy.api#documentation": "

Contains the response to a DescribeServers request.

\n

\n For Chef Automate servers: If DescribeServersResponse$Servers$EngineAttributes includes \n CHEF_MAJOR_UPGRADE_AVAILABLE, you can upgrade the Chef Automate server to Chef Automate 2. To be eligible for upgrade, a server running \n Chef Automate 1 must have had at least one successful maintenance run after November 1, 2019.

\n

\n For Puppet servers:\n DescribeServersResponse$Servers$EngineAttributes contains\n the following two responses:

\n " - } - }, - "NextToken": { - "target": "com.amazonaws.opsworkscm#String", - "traits": { - "smithy.api#documentation": "

This is not currently implemented for DescribeServers requests.\n

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.opsworkscm#DisassociateNode": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworkscm#DisassociateNodeRequest" - }, - "output": { - "target": "com.amazonaws.opsworkscm#DisassociateNodeResponse" - }, - "errors": [ - { - "target": "com.amazonaws.opsworkscm#InvalidStateException" - }, - { - "target": "com.amazonaws.opsworkscm#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworkscm#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

\n Disassociates a node from an OpsWorks CM server, and removes the node from the server's managed nodes. After a node is disassociated,\n 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.\n

\n

A node can can only be disassociated from a server that is in a HEALTHY state. Otherwise, an InvalidStateException is thrown.\n A ResourceNotFoundException is thrown when the server does not exist.\n A ValidationException is raised when parameters of the request are not valid.\n

" - } - }, - "com.amazonaws.opsworkscm#DisassociateNodeRequest": { - "type": "structure", - "members": { - "ServerName": { - "target": "com.amazonaws.opsworkscm#ServerName", - "traits": { - "smithy.api#documentation": "

The name of the server from which to disassociate the node.\n

", - "smithy.api#required": {} - } - }, - "NodeName": { - "target": "com.amazonaws.opsworkscm#NodeName", - "traits": { - "smithy.api#documentation": "

The name of the client node.\n

", - "smithy.api#required": {} - } - }, - "EngineAttributes": { - "target": "com.amazonaws.opsworkscm#EngineAttributes", - "traits": { - "smithy.api#documentation": "

Engine attributes that are used for disassociating the node. No attributes are required for Puppet.\n

\n

\n Attributes required in a DisassociateNode request for Chef\n

\n " - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworkscm#DisassociateNodeResponse": { - "type": "structure", - "members": { - "NodeAssociationStatusToken": { - "target": "com.amazonaws.opsworkscm#NodeAssociationStatusToken", - "traits": { - "smithy.api#documentation": "

Contains a token which can be passed to the\n DescribeNodeAssociationStatus API call to get the status of\n the disassociation request.\n

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.opsworkscm#EngineAttribute": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.opsworkscm#EngineAttributeName", - "traits": { - "smithy.api#documentation": "

The name of the engine attribute.\n

" - } - }, - "Value": { - "target": "com.amazonaws.opsworkscm#EngineAttributeValue", - "traits": { - "smithy.api#documentation": "

The value of the engine attribute.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A name and value pair that is specific to the engine of the server.\n

" - } - }, - "com.amazonaws.opsworkscm#EngineAttributeName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 10000 - }, - "smithy.api#pattern": "^(?s)" - } - }, - "com.amazonaws.opsworkscm#EngineAttributeValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 10000 - }, - "smithy.api#pattern": "^(?s)", - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.opsworkscm#EngineAttributes": { - "type": "list", - "member": { - "target": "com.amazonaws.opsworkscm#EngineAttribute" - } - }, - "com.amazonaws.opsworkscm#ExportServerEngineAttribute": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworkscm#ExportServerEngineAttributeRequest" - }, - "output": { - "target": "com.amazonaws.opsworkscm#ExportServerEngineAttributeResponse" - }, - "errors": [ - { - "target": "com.amazonaws.opsworkscm#InvalidStateException" - }, - { - "target": "com.amazonaws.opsworkscm#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworkscm#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

\n Exports a specified server engine attribute as a base64-encoded string. For example, you can export user data that you can \n use in EC2 to associate nodes with a server.\n

\n

\n This operation is synchronous.\n

\n

\n A ValidationException is raised when parameters of the request are not valid.\n A ResourceNotFoundException is thrown when the server does not exist.\n An InvalidStateException is thrown when the server is in any of the following states: CREATING, TERMINATED,\n FAILED or DELETING.\n

" - } - }, - "com.amazonaws.opsworkscm#ExportServerEngineAttributeRequest": { - "type": "structure", - "members": { - "ExportAttributeName": { - "target": "com.amazonaws.opsworkscm#String", - "traits": { - "smithy.api#documentation": "

The name of the export attribute. Currently, the supported export attribute is Userdata. \n This exports a user data script that includes parameters and values provided in the InputAttributes list.

", - "smithy.api#required": {} - } - }, - "ServerName": { - "target": "com.amazonaws.opsworkscm#ServerName", - "traits": { - "smithy.api#documentation": "

The name of the server from which you are exporting the attribute.

", - "smithy.api#required": {} - } - }, - "InputAttributes": { - "target": "com.amazonaws.opsworkscm#EngineAttributes", - "traits": { - "smithy.api#documentation": "

The list of engine attributes. The list type is EngineAttribute. An EngineAttribute list item \n is a pair that includes an attribute name and its value. For the Userdata ExportAttributeName, the following are \n supported engine attribute names.

\n " - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworkscm#ExportServerEngineAttributeResponse": { - "type": "structure", - "members": { - "EngineAttribute": { - "target": "com.amazonaws.opsworkscm#EngineAttribute", - "traits": { - "smithy.api#documentation": "

The requested engine attribute pair with attribute name and value.

" - } - }, - "ServerName": { - "target": "com.amazonaws.opsworkscm#ServerName", - "traits": { - "smithy.api#documentation": "

The server name used in the request.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.opsworkscm#InstanceProfileArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 10000 - }, - "smithy.api#pattern": "^arn:aws:iam::[0-9]{12}:instance-profile/" - } - }, - "com.amazonaws.opsworkscm#Integer": { - "type": "integer" - }, - "com.amazonaws.opsworkscm#InvalidNextTokenException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.opsworkscm#String", - "traits": { - "smithy.api#documentation": "

Error or informational message that can contain more detail about a nextToken failure.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

This occurs when the provided nextToken is not valid.\n

", - "smithy.api#error": "client" - } - }, - "com.amazonaws.opsworkscm#InvalidStateException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.opsworkscm#String", - "traits": { - "smithy.api#documentation": "

Error or informational message that provides more detail if a resource is\n in a state that is not valid for performing a specified action.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The resource is in a state that does not allow you to perform a specified action.\n

", - "smithy.api#error": "client" - } - }, - "com.amazonaws.opsworkscm#KeyPair": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 10000 - }, - "smithy.api#pattern": ".*" - } - }, - "com.amazonaws.opsworkscm#LimitExceededException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.opsworkscm#String", - "traits": { - "smithy.api#documentation": "

Error or informational message that the maximum allowed number of servers or backups has been exceeded.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The limit of servers or backups has been reached.\n

", - "smithy.api#error": "client" - } - }, - "com.amazonaws.opsworkscm#ListTagsForResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworkscm#ListTagsForResourceRequest" - }, - "output": { - "target": "com.amazonaws.opsworkscm#ListTagsForResourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.opsworkscm#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworkscm#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns a list of tags that are applied to the specified OpsWorks for Chef Automate or\n OpsWorks for Puppet Enterprise servers or backups.

", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "Tags", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.opsworkscm#ListTagsForResourceRequest": { - "type": "structure", - "members": { - "ResourceArn": { - "target": "com.amazonaws.opsworkscm#AWSOpsWorksCMResourceArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Number (ARN) of an OpsWorks for Chef Automate or OpsWorks for Puppet Enterprise server for which you want to show applied tags. For example, \n arn:aws:opsworks-cm:us-west-2:123456789012:server/test-owcm-server/EXAMPLE-66b0-4196-8274-d1a2bEXAMPLE.

", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.opsworkscm#NextToken", - "traits": { - "smithy.api#documentation": "

NextToken is a string that is returned in some command responses. It indicates that\n not all entries have been returned, and that you must run at least one more request to get remaining\n items. To get remaining results, call ListTagsForResource again, and assign the token from the previous\n results as the value of the nextToken parameter. If there are no more results,\n the response object's nextToken parameter value is null.\n Setting a nextToken value that was not returned in\n your previous results causes an InvalidNextTokenException to occur.

" - } - }, - "MaxResults": { - "target": "com.amazonaws.opsworkscm#MaxResults", - "traits": { - "smithy.api#documentation": "

To receive a paginated response, use this parameter to specify the maximum number\n of results to be returned with a single call. If the number of available results exceeds\n this maximum, the response includes a NextToken value that you can assign to the NextToken\n request parameter to get the next set of results.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworkscm#ListTagsForResourceResponse": { - "type": "structure", - "members": { - "Tags": { - "target": "com.amazonaws.opsworkscm#TagList", - "traits": { - "smithy.api#documentation": "

Tags that have been applied to the resource.

" - } - }, - "NextToken": { - "target": "com.amazonaws.opsworkscm#NextToken", - "traits": { - "smithy.api#documentation": "

A token that you can use as the value of NextToken in subsequent calls to the API to show more results.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.opsworkscm#MaintenanceStatus": { - "type": "enum", - "members": { - "SUCCESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SUCCESS" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - } - } - }, - "com.amazonaws.opsworkscm#MaxResults": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1 - } - } - }, - "com.amazonaws.opsworkscm#NextToken": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 10000 - }, - "smithy.api#pattern": "^(?s)" - } - }, - "com.amazonaws.opsworkscm#NodeAssociationStatus": { - "type": "enum", - "members": { - "SUCCESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SUCCESS" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - }, - "IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IN_PROGRESS" - } - } - }, - "traits": { - "smithy.api#documentation": "

The status of the association or disassociation request.\n

\n

\n Possible values:\n

\n " - } - }, - "com.amazonaws.opsworkscm#NodeAssociationStatusToken": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 10000 - }, - "smithy.api#pattern": "^(?s)" - } - }, - "com.amazonaws.opsworkscm#NodeName": { - "type": "string", - "traits": { - "smithy.api#documentation": "

The node name that is used by chef-client or puppet-agentfor a new node. We recommend to use a unique FQDN as hostname. For more information, see the\n Chef or \n Puppet documentation.\n

", - "smithy.api#length": { - "min": 0, - "max": 10000 - }, - "smithy.api#pattern": "^[\\-\\p{Alnum}_:.]+$" - } - }, - "com.amazonaws.opsworkscm#OpsWorksCM_V2016_11_01": { - "type": "service", - "version": "2016-11-01", - "operations": [ - { - "target": "com.amazonaws.opsworkscm#AssociateNode" - }, - { - "target": "com.amazonaws.opsworkscm#CreateBackup" - }, - { - "target": "com.amazonaws.opsworkscm#CreateServer" - }, - { - "target": "com.amazonaws.opsworkscm#DeleteBackup" - }, - { - "target": "com.amazonaws.opsworkscm#DeleteServer" - }, - { - "target": "com.amazonaws.opsworkscm#DescribeAccountAttributes" - }, - { - "target": "com.amazonaws.opsworkscm#DescribeBackups" - }, - { - "target": "com.amazonaws.opsworkscm#DescribeEvents" - }, - { - "target": "com.amazonaws.opsworkscm#DescribeNodeAssociationStatus" - }, - { - "target": "com.amazonaws.opsworkscm#DescribeServers" - }, - { - "target": "com.amazonaws.opsworkscm#DisassociateNode" - }, - { - "target": "com.amazonaws.opsworkscm#ExportServerEngineAttribute" - }, - { - "target": "com.amazonaws.opsworkscm#ListTagsForResource" - }, - { - "target": "com.amazonaws.opsworkscm#RestoreServer" - }, - { - "target": "com.amazonaws.opsworkscm#StartMaintenance" - }, - { - "target": "com.amazonaws.opsworkscm#TagResource" - }, - { - "target": "com.amazonaws.opsworkscm#UntagResource" - }, - { - "target": "com.amazonaws.opsworkscm#UpdateServer" - }, - { - "target": "com.amazonaws.opsworkscm#UpdateServerEngineAttributes" - } - ], - "traits": { - "aws.api#service": { - "sdkId": "OpsWorksCM", - "arnNamespace": "opsworks-cm", - "cloudFormationName": "OpsWorksCM", - "cloudTrailEventSource": "opsworkscm.amazonaws.com", - "endpointPrefix": "opsworks-cm" - }, - "aws.auth#sigv4": { - "name": "opsworks-cm" - }, - "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "OpsWorks CM\n \n

The OpsWorks services have reached end of life and have been disabled for both new and existing customers. \n We strongly recommend customers migrate their workloads to other solutions as soon as possible. If you have questions about migration, reach out to the Amazon Web ServicesSupport Team on Amazon Web Services re:Post or through Amazon Web Services Premium Support.

\n \n

OpsWorks CM is a service that runs and manages\n configuration management servers. You can use OpsWorks CM to create and manage OpsWorks for Chef Automate and \n OpsWorks for Puppet Enterprise servers, and add or remove\n nodes for the servers to manage.

\n

\n Glossary of terms\n

\n \n

\n Endpoints\n

\n

OpsWorks CM supports the following endpoints, all HTTPS. You must connect to one of the following endpoints. \n Your servers\n can only be accessed or managed within the endpoint in which they are created.

\n \n

For more information, see OpsWorks endpoints and quotas in the Amazon Web Services General Reference.

\n

\n Throttling limits\n

\n

All API operations allow for five requests per second with a burst of 10 requests per second.

", - "smithy.api#title": "AWS OpsWorks CM", - "smithy.api#xmlNamespace": { - "uri": "http://opsworks-cm.amazonaws.com/doc/2016-11-01/" - }, - "smithy.rules#endpointRuleSet": { - "version": "1.0", - "parameters": { - "Region": { - "builtIn": "AWS::Region", - "required": false, - "documentation": "The AWS region used to dispatch the request.", - "type": "String" - }, - "UseDualStack": { - "builtIn": "AWS::UseDualStack", - "required": true, - "default": false, - "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", - "type": "Boolean" - }, - "UseFIPS": { - "builtIn": "AWS::UseFIPS", - "required": true, - "default": false, - "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", - "type": "Boolean" - }, - "Endpoint": { - "builtIn": "SDK::Endpoint", - "required": false, - "documentation": "Override the endpoint used to send this request", - "type": "String" - } - }, - "rules": [ - { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Endpoint" - } - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "error": "Invalid Configuration: FIPS and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" - }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Region" - } - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "aws.partition", - "argv": [ - { - "ref": "Region" - } - ], - "assign": "PartitionResult" - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - }, - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://opsworks-cm-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - }, - true - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://opsworks-cm-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://opsworks-cm.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [], - "endpoint": { - "url": "https://opsworks-cm.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" - } - ] - }, - "smithy.rules#endpointTests": { - "testCases": [ - { - "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://opsworks-cm.ap-northeast-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-northeast-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://opsworks-cm.ap-southeast-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-southeast-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://opsworks-cm.ap-southeast-2.amazonaws.com" - } - }, - "params": { - "Region": "ap-southeast-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://opsworks-cm.eu-central-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-central-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://opsworks-cm.eu-west-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-west-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://opsworks-cm.us-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://opsworks-cm.us-east-2.amazonaws.com" - } - }, - "params": { - "Region": "us-east-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://opsworks-cm.us-west-1.amazonaws.com" - } - }, - "params": { - "Region": "us-west-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://opsworks-cm.us-west-2.amazonaws.com" - } - }, - "params": { - "Region": "us-west-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://opsworks-cm-fips.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://opsworks-cm-fips.us-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://opsworks-cm.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://opsworks-cm-fips.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://opsworks-cm-fips.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://opsworks-cm.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://opsworks-cm.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://opsworks-cm-fips.us-gov-east-1.api.aws" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://opsworks-cm-fips.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://opsworks-cm.us-gov-east-1.api.aws" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://opsworks-cm.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://opsworks-cm-fips.us-iso-east-1.c2s.ic.gov" - } - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://opsworks-cm.us-iso-east-1.c2s.ic.gov" - } - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://opsworks-cm-fips.us-isob-east-1.sc2s.sgov.gov" - } - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://opsworks-cm.us-isob-east-1.sc2s.sgov.gov" - } - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": false, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": false, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "For custom endpoint with fips enabled and dualstack disabled", - "expect": { - "error": "Invalid Configuration: FIPS and custom endpoint are not supported" - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": false, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "For custom endpoint with fips disabled and dualstack enabled", - "expect": { - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": true, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "Missing region", - "expect": { - "error": "Invalid Configuration: Missing Region" - } - } - ], - "version": "1.0" - } - } - }, - "com.amazonaws.opsworkscm#ResourceAlreadyExistsException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.opsworkscm#String", - "traits": { - "smithy.api#documentation": "

Error or informational message in response to a CreateServer request that a resource cannot be created because it already exists.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The requested resource cannot be created because it already exists.\n

", - "smithy.api#error": "client" - } - }, - "com.amazonaws.opsworkscm#ResourceNotFoundException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.opsworkscm#String", - "traits": { - "smithy.api#documentation": "

Error or informational message that can contain more detail about problems locating or accessing a resource.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The requested resource does not exist, or access was denied.\n

", - "smithy.api#error": "client" - } - }, - "com.amazonaws.opsworkscm#RestoreServer": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworkscm#RestoreServerRequest" - }, - "output": { - "target": "com.amazonaws.opsworkscm#RestoreServerResponse" - }, - "errors": [ - { - "target": "com.amazonaws.opsworkscm#InvalidStateException" - }, - { - "target": "com.amazonaws.opsworkscm#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworkscm#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

\n Restores a backup to a server that is in a CONNECTION_LOST, HEALTHY, RUNNING, UNHEALTHY, or TERMINATED state.\n When you run RestoreServer, the server's EC2 instance is deleted, and a new EC2 instance is configured. RestoreServer maintains\n the existing server endpoint, so configuration management of the server's client devices (nodes) should continue to work.\n

\n

Restoring from a backup is performed by creating a new EC2 instance. If restoration is successful, and the server is in a HEALTHY state, \n OpsWorks CM switches traffic over to the new instance. After restoration is finished, the old EC2 instance is maintained in a \n Running or Stopped state, but is eventually terminated.

\n

\n This operation is asynchronous.\n

\n

\n An InvalidStateException is thrown when the server is not in a valid state. A ResourceNotFoundException is thrown\n when the server does not exist. A ValidationException is raised when parameters of the request are not valid.\n

" - } - }, - "com.amazonaws.opsworkscm#RestoreServerRequest": { - "type": "structure", - "members": { - "BackupId": { - "target": "com.amazonaws.opsworkscm#BackupId", - "traits": { - "smithy.api#documentation": "

The ID of the backup that you want to use to restore a server.\n

", - "smithy.api#required": {} - } - }, - "ServerName": { - "target": "com.amazonaws.opsworkscm#ServerName", - "traits": { - "smithy.api#documentation": "

The name of the server that you want to restore.\n

", - "smithy.api#required": {} - } - }, - "InstanceType": { - "target": "com.amazonaws.opsworkscm#String", - "traits": { - "smithy.api#documentation": "

The type of instance to restore. Valid values must be specified in the following format: ^([cm][34]|t2).*\n For example, m5.large. Valid values are m5.large, r5.xlarge, and r5.2xlarge. If you do not specify this parameter,\n RestoreServer uses the instance type from the specified backup.\n

" - } - }, - "KeyPair": { - "target": "com.amazonaws.opsworkscm#KeyPair", - "traits": { - "smithy.api#documentation": "

The name of the key pair to set on the new EC2 instance. This can be helpful\n if the administrator no longer has the SSH key.\n

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworkscm#RestoreServerResponse": { - "type": "structure", - "members": { - "Server": { - "target": "com.amazonaws.opsworkscm#Server" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.opsworkscm#Server": { - "type": "structure", - "members": { - "AssociatePublicIpAddress": { - "target": "com.amazonaws.opsworkscm#Boolean", - "traits": { - "smithy.api#documentation": "

Associate a public IP address with a server that you are launching.\n

" - } - }, - "BackupRetentionCount": { - "target": "com.amazonaws.opsworkscm#Integer", - "traits": { - "smithy.api#documentation": "

The number of automated backups to keep.\n

" - } - }, - "ServerName": { - "target": "com.amazonaws.opsworkscm#String", - "traits": { - "smithy.api#documentation": "

The name of the server.\n

" - } - }, - "CreatedAt": { - "target": "com.amazonaws.opsworkscm#Timestamp", - "traits": { - "smithy.api#documentation": "

Time stamp of server creation. Example 2016-07-29T13:38:47.520Z\n

" - } - }, - "CloudFormationStackArn": { - "target": "com.amazonaws.opsworkscm#String", - "traits": { - "smithy.api#documentation": "

The ARN of the CloudFormation stack that was used to create the server.\n

" - } - }, - "CustomDomain": { - "target": "com.amazonaws.opsworkscm#CustomDomain", - "traits": { - "smithy.api#documentation": "

An optional public endpoint of a server, such as https://aws.my-company.com. \n You cannot access the server by using the Endpoint value if the server has a CustomDomain specified.

" - } - }, - "DisableAutomatedBackup": { - "target": "com.amazonaws.opsworkscm#Boolean", - "traits": { - "smithy.api#documentation": "

Disables automated backups. The number of stored backups is dependent on the value of PreferredBackupCount.\n

" - } - }, - "Endpoint": { - "target": "com.amazonaws.opsworkscm#String", - "traits": { - "smithy.api#documentation": "

\n A DNS name that can be used to access the engine. Example: myserver-asdfghjkl.us-east-1.opsworks.io. \n You cannot access the server by using the Endpoint value if the server has a CustomDomain specified.\n

" - } - }, - "Engine": { - "target": "com.amazonaws.opsworkscm#String", - "traits": { - "smithy.api#documentation": "

The engine type of the server. Valid values in this release include ChefAutomate and Puppet.\n

" - } - }, - "EngineModel": { - "target": "com.amazonaws.opsworkscm#String", - "traits": { - "smithy.api#documentation": "

The engine model of the server. Valid values in this release include Monolithic for Puppet and Single for Chef.\n

" - } - }, - "EngineAttributes": { - "target": "com.amazonaws.opsworkscm#EngineAttributes", - "traits": { - "smithy.api#documentation": "

The response of a createServer() request returns the master\n credential to access the server in EngineAttributes. These\n credentials are not stored by OpsWorks CM; they are returned only as part of the result of createServer().\n

\n

\n Attributes returned in a createServer response for Chef\n

\n \n

\n Attributes returned in a createServer response for Puppet\n

\n " - } - }, - "EngineVersion": { - "target": "com.amazonaws.opsworkscm#String", - "traits": { - "smithy.api#documentation": "

The engine version of the server. For a Chef server, the valid value for EngineVersion is \n currently 2. For a Puppet server, specify either 2019 or 2017.\n

" - } - }, - "InstanceProfileArn": { - "target": "com.amazonaws.opsworkscm#String", - "traits": { - "smithy.api#documentation": "

The instance profile ARN of the server.\n

" - } - }, - "InstanceType": { - "target": "com.amazonaws.opsworkscm#String", - "traits": { - "smithy.api#documentation": "

\n The instance type for the server, as specified in the CloudFormation stack. This might not be the same instance type \n that is shown in the EC2 console.\n

" - } - }, - "KeyPair": { - "target": "com.amazonaws.opsworkscm#String", - "traits": { - "smithy.api#documentation": "

The key pair associated with the server.\n

" - } - }, - "MaintenanceStatus": { - "target": "com.amazonaws.opsworkscm#MaintenanceStatus", - "traits": { - "smithy.api#documentation": "

The status of the most recent server maintenance run. Shows SUCCESS or FAILED.\n

" - } - }, - "PreferredMaintenanceWindow": { - "target": "com.amazonaws.opsworkscm#TimeWindowDefinition", - "traits": { - "smithy.api#documentation": "

The preferred maintenance period specified for the server.\n

" - } - }, - "PreferredBackupWindow": { - "target": "com.amazonaws.opsworkscm#TimeWindowDefinition", - "traits": { - "smithy.api#documentation": "

The preferred backup period specified for the server.\n

" - } - }, - "SecurityGroupIds": { - "target": "com.amazonaws.opsworkscm#Strings", - "traits": { - "smithy.api#documentation": "

\n The security group IDs for the server, as specified in the CloudFormation stack.\n These might not be the same security groups that are shown in the EC2 console.\n

" - } - }, - "ServiceRoleArn": { - "target": "com.amazonaws.opsworkscm#String", - "traits": { - "smithy.api#documentation": "

The service role ARN used to create the server.\n

" - } - }, - "Status": { - "target": "com.amazonaws.opsworkscm#ServerStatus", - "traits": { - "smithy.api#documentation": "

\n The server's status. This field displays the states of actions in progress, such as creating, running, or backing up the server,\n as well as the server's health state.\n

" - } - }, - "StatusReason": { - "target": "com.amazonaws.opsworkscm#String", - "traits": { - "smithy.api#documentation": "

\n Depending on the server status, this field has either a human-readable\n message (such as a create or backup error), or an escaped block of JSON (used for health check results).\n

" - } - }, - "SubnetIds": { - "target": "com.amazonaws.opsworkscm#Strings", - "traits": { - "smithy.api#documentation": "

\n The subnet IDs specified in a CreateServer request.\n

" - } - }, - "ServerArn": { - "target": "com.amazonaws.opsworkscm#String", - "traits": { - "smithy.api#documentation": "

The ARN of the server.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a configuration management server.\n

" - } - }, - "com.amazonaws.opsworkscm#ServerEvent": { - "type": "structure", - "members": { - "CreatedAt": { - "target": "com.amazonaws.opsworkscm#Timestamp", - "traits": { - "smithy.api#documentation": "

The time when the event occurred.\n

" - } - }, - "ServerName": { - "target": "com.amazonaws.opsworkscm#String", - "traits": { - "smithy.api#documentation": "

The name of the server on or for which the event occurred.\n

" - } - }, - "Message": { - "target": "com.amazonaws.opsworkscm#String", - "traits": { - "smithy.api#documentation": "

A human-readable informational or status message.

" - } - }, - "LogUrl": { - "target": "com.amazonaws.opsworkscm#String", - "traits": { - "smithy.api#documentation": "

The Amazon S3 URL of the event's log file.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An event that is related to the server, such as the start of maintenance or backup.\n

" - } - }, - "com.amazonaws.opsworkscm#ServerEvents": { - "type": "list", - "member": { - "target": "com.amazonaws.opsworkscm#ServerEvent" - } - }, - "com.amazonaws.opsworkscm#ServerName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 40 - }, - "smithy.api#pattern": "^[a-zA-Z][a-zA-Z0-9\\-]*$" - } - }, - "com.amazonaws.opsworkscm#ServerStatus": { - "type": "enum", - "members": { - "BACKING_UP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BACKING_UP" - } - }, - "CONNECTION_LOST": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CONNECTION_LOST" - } - }, - "CREATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATING" - } - }, - "DELETING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETING" - } - }, - "MODIFYING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MODIFYING" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - }, - "HEALTHY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HEALTHY" - } - }, - "RUNNING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RUNNING" - } - }, - "RESTORING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RESTORING" - } - }, - "SETUP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SETUP" - } - }, - "UNDER_MAINTENANCE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UNDER_MAINTENANCE" - } - }, - "UNHEALTHY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UNHEALTHY" - } - }, - "TERMINATED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TERMINATED" - } - } - } - }, - "com.amazonaws.opsworkscm#Servers": { - "type": "list", - "member": { - "target": "com.amazonaws.opsworkscm#Server" - } - }, - "com.amazonaws.opsworkscm#ServiceRoleArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 10000 - }, - "smithy.api#pattern": "^arn:aws:iam::[0-9]{12}:role/" - } - }, - "com.amazonaws.opsworkscm#StartMaintenance": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworkscm#StartMaintenanceRequest" - }, - "output": { - "target": "com.amazonaws.opsworkscm#StartMaintenanceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.opsworkscm#InvalidStateException" - }, - { - "target": "com.amazonaws.opsworkscm#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworkscm#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

\n Manually starts server maintenance. This command can be useful if an earlier maintenance attempt failed, and the underlying\n cause of maintenance failure has been resolved. The server is in an UNDER_MAINTENANCE state while maintenance is in progress.\n

\n

\n Maintenance can only be started on servers in HEALTHY and UNHEALTHY states. Otherwise, an InvalidStateException is thrown.\n A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are not valid.\n

" - } - }, - "com.amazonaws.opsworkscm#StartMaintenanceRequest": { - "type": "structure", - "members": { - "ServerName": { - "target": "com.amazonaws.opsworkscm#ServerName", - "traits": { - "smithy.api#documentation": "

The name of the server on which to run maintenance.\n

", - "smithy.api#required": {} - } - }, - "EngineAttributes": { - "target": "com.amazonaws.opsworkscm#EngineAttributes", - "traits": { - "smithy.api#documentation": "

Engine attributes that are specific to the server on which you want to run maintenance.

\n

\n Attributes accepted in a StartMaintenance request for Chef\n

\n " - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworkscm#StartMaintenanceResponse": { - "type": "structure", - "members": { - "Server": { - "target": "com.amazonaws.opsworkscm#Server", - "traits": { - "smithy.api#documentation": "

Contains the response to a StartMaintenance request.\n

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.opsworkscm#String": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 10000 - }, - "smithy.api#pattern": "^(?s)" - } - }, - "com.amazonaws.opsworkscm#Strings": { - "type": "list", - "member": { - "target": "com.amazonaws.opsworkscm#String" - } - }, - "com.amazonaws.opsworkscm#Tag": { - "type": "structure", - "members": { - "Key": { - "target": "com.amazonaws.opsworkscm#TagKey", - "traits": { - "smithy.api#documentation": "

A tag key, such as Stage or Name. A tag key cannot be empty. The key can be a maximum of 127 characters, \n and can contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : /\n

", - "smithy.api#required": {} - } - }, - "Value": { - "target": "com.amazonaws.opsworkscm#TagValue", - "traits": { - "smithy.api#documentation": "

An optional tag value, such as Production or test-owcm-server. The value can be a maximum of 255 characters, \n and contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : /\n

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A map that contains tag keys and tag values to attach to an OpsWorks for Chef Automate \n or OpsWorks for Puppet Enterprise server. Leading and trailing spaces are trimmed from both the key and value. \n A maximum of 50 user-applied tags is allowed for tag-supported OpsWorks CM resources.

" - } - }, - "com.amazonaws.opsworkscm#TagKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - }, - "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" - } - }, - "com.amazonaws.opsworkscm#TagKeyList": { - "type": "list", - "member": { - "target": "com.amazonaws.opsworkscm#TagKey" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 200 - } - } - }, - "com.amazonaws.opsworkscm#TagList": { - "type": "list", - "member": { - "target": "com.amazonaws.opsworkscm#Tag" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 200 - } - } - }, - "com.amazonaws.opsworkscm#TagResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworkscm#TagResourceRequest" - }, - "output": { - "target": "com.amazonaws.opsworkscm#TagResourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.opsworkscm#InvalidStateException" - }, - { - "target": "com.amazonaws.opsworkscm#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworkscm#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Applies tags to an OpsWorks for Chef Automate or OpsWorks for Puppet Enterprise server, or to server backups.

" - } - }, - "com.amazonaws.opsworkscm#TagResourceRequest": { - "type": "structure", - "members": { - "ResourceArn": { - "target": "com.amazonaws.opsworkscm#AWSOpsWorksCMResourceArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Number (ARN) of a resource to which you want to apply tags. For example, \n arn:aws:opsworks-cm:us-west-2:123456789012:server/test-owcm-server/EXAMPLE-66b0-4196-8274-d1a2bEXAMPLE.

", - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.opsworkscm#TagList", - "traits": { - "smithy.api#documentation": "

A map that contains tag keys and tag values to attach to OpsWorks CM servers or backups.

\n ", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworkscm#TagResourceResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.opsworkscm#TagValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - }, - "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" - } - }, - "com.amazonaws.opsworkscm#TimeWindowDefinition": { - "type": "string", - "traits": { - "smithy.api#documentation": "

\n DDD:HH:MM (weekly start time) or\n HH:MM (daily start time).\n

\n

\n Time windows always use coordinated universal time (UTC). Valid strings for day of week (DDD) are: Mon, Tue, Wed,\n Thr, Fri, Sat, or Sun.

", - "smithy.api#length": { - "min": 0, - "max": 10000 - }, - "smithy.api#pattern": "^((Mon|Tue|Wed|Thu|Fri|Sat|Sun):)?([0-1][0-9]|2[0-3]):[0-5][0-9]$" - } - }, - "com.amazonaws.opsworkscm#Timestamp": { - "type": "timestamp" - }, - "com.amazonaws.opsworkscm#UntagResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworkscm#UntagResourceRequest" - }, - "output": { - "target": "com.amazonaws.opsworkscm#UntagResourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.opsworkscm#InvalidStateException" - }, - { - "target": "com.amazonaws.opsworkscm#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworkscm#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Removes specified tags from an OpsWorks CM server or backup.

" - } - }, - "com.amazonaws.opsworkscm#UntagResourceRequest": { - "type": "structure", - "members": { - "ResourceArn": { - "target": "com.amazonaws.opsworkscm#AWSOpsWorksCMResourceArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Number (ARN) of a resource from which you want to remove tags. For example, \n arn:aws:opsworks-cm:us-west-2:123456789012:server/test-owcm-server/EXAMPLE-66b0-4196-8274-d1a2bEXAMPLE.

", - "smithy.api#required": {} - } - }, - "TagKeys": { - "target": "com.amazonaws.opsworkscm#TagKeyList", - "traits": { - "smithy.api#documentation": "

The keys of tags that you want to remove.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworkscm#UntagResourceResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.opsworkscm#UpdateServer": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworkscm#UpdateServerRequest" - }, - "output": { - "target": "com.amazonaws.opsworkscm#UpdateServerResponse" - }, - "errors": [ - { - "target": "com.amazonaws.opsworkscm#InvalidStateException" - }, - { - "target": "com.amazonaws.opsworkscm#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworkscm#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

\n Updates settings for a server.\n

\n

\n This operation is synchronous.\n

" - } - }, - "com.amazonaws.opsworkscm#UpdateServerEngineAttributes": { - "type": "operation", - "input": { - "target": "com.amazonaws.opsworkscm#UpdateServerEngineAttributesRequest" - }, - "output": { - "target": "com.amazonaws.opsworkscm#UpdateServerEngineAttributesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.opsworkscm#InvalidStateException" - }, - { - "target": "com.amazonaws.opsworkscm#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.opsworkscm#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

\n Updates engine-specific attributes on a specified server. The server\n enters the MODIFYING state when this operation\n is in progress. Only one update can occur at a time.\n You can use this command to reset a Chef server's public key (CHEF_PIVOTAL_KEY) or a Puppet server's \n admin password (PUPPET_ADMIN_PASSWORD).\n

\n

\n This operation is asynchronous.\n

\n

\n This operation can only be called for servers in HEALTHY or UNHEALTHY states. \n Otherwise, an InvalidStateException is raised.\n A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is \n raised when parameters of the request are not valid.\n

" - } - }, - "com.amazonaws.opsworkscm#UpdateServerEngineAttributesRequest": { - "type": "structure", - "members": { - "ServerName": { - "target": "com.amazonaws.opsworkscm#ServerName", - "traits": { - "smithy.api#documentation": "

The name of the server to update.\n

", - "smithy.api#required": {} - } - }, - "AttributeName": { - "target": "com.amazonaws.opsworkscm#AttributeName", - "traits": { - "smithy.api#documentation": "

The name of the engine attribute to update.\n

", - "smithy.api#required": {} - } - }, - "AttributeValue": { - "target": "com.amazonaws.opsworkscm#AttributeValue", - "traits": { - "smithy.api#documentation": "

The value to set for the attribute.\n

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworkscm#UpdateServerEngineAttributesResponse": { - "type": "structure", - "members": { - "Server": { - "target": "com.amazonaws.opsworkscm#Server", - "traits": { - "smithy.api#documentation": "

Contains the response to an UpdateServerEngineAttributes request.\n

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.opsworkscm#UpdateServerRequest": { - "type": "structure", - "members": { - "DisableAutomatedBackup": { - "target": "com.amazonaws.opsworkscm#Boolean", - "traits": { - "smithy.api#documentation": "

Setting DisableAutomatedBackup to true disables automated or scheduled backups. \n Automated backups are enabled by default.\n

" - } - }, - "BackupRetentionCount": { - "target": "com.amazonaws.opsworkscm#Integer", - "traits": { - "smithy.api#documentation": "

Sets the number of automated backups that you want to keep.\n

" - } - }, - "ServerName": { - "target": "com.amazonaws.opsworkscm#ServerName", - "traits": { - "smithy.api#documentation": "

The name of the server to update.\n

", - "smithy.api#required": {} - } - }, - "PreferredMaintenanceWindow": { - "target": "com.amazonaws.opsworkscm#TimeWindowDefinition" - }, - "PreferredBackupWindow": { - "target": "com.amazonaws.opsworkscm#TimeWindowDefinition" - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.opsworkscm#UpdateServerResponse": { - "type": "structure", - "members": { - "Server": { - "target": "com.amazonaws.opsworkscm#Server", - "traits": { - "smithy.api#documentation": "

Contains the response to a UpdateServer request.\n

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.opsworkscm#ValidationException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.opsworkscm#String", - "traits": { - "smithy.api#documentation": "

Error or informational message that can contain more detail about a validation failure.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

One or more of the provided request parameters are not valid.\n

", - "smithy.api#error": "client" - } - } - } -} \ No newline at end of file diff --git a/models/privatenetworks/service/2021-12-03/privatenetworks-2021-12-03.json b/models/privatenetworks/service/2021-12-03/privatenetworks-2021-12-03.json deleted file mode 100644 index 507a3f29..00000000 --- a/models/privatenetworks/service/2021-12-03/privatenetworks-2021-12-03.json +++ /dev/null @@ -1,3948 +0,0 @@ -{ - "smithy": "2.0", - "shapes": { - "com.amazonaws.privatenetworks#AccessDeniedException": { - "type": "structure", - "members": { - "message": { - "target": "smithy.api#String" - } - }, - "traits": { - "smithy.api#documentation": "

You do not have permission to perform this operation.

", - "smithy.api#error": "client", - "smithy.api#httpError": 403 - } - }, - "com.amazonaws.privatenetworks#AcknowledgeOrderReceipt": { - "type": "operation", - "input": { - "target": "com.amazonaws.privatenetworks#AcknowledgeOrderReceiptRequest" - }, - "output": { - "target": "com.amazonaws.privatenetworks#AcknowledgeOrderReceiptResponse" - }, - "errors": [ - { - "target": "com.amazonaws.privatenetworks#InternalServerException" - }, - { - "target": "com.amazonaws.privatenetworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.privatenetworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Acknowledges that the specified network order was received.

", - "smithy.api#http": { - "uri": "/v1/orders/acknowledge", - "method": "POST", - "code": 200 - } - } - }, - "com.amazonaws.privatenetworks#AcknowledgeOrderReceiptRequest": { - "type": "structure", - "members": { - "orderArn": { - "target": "com.amazonaws.privatenetworks#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the order.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.privatenetworks#AcknowledgeOrderReceiptResponse": { - "type": "structure", - "members": { - "order": { - "target": "com.amazonaws.privatenetworks#Order", - "traits": { - "smithy.api#documentation": "

Information about the order.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.privatenetworks#AcknowledgmentStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ACKNOWLEDGING", - "name": "ACKNOWLEDGING" - }, - { - "value": "ACKNOWLEDGED", - "name": "ACKNOWLEDGED" - }, - { - "value": "UNACKNOWLEDGED", - "name": "UNACKNOWLEDGED" - } - ] - } - }, - "com.amazonaws.privatenetworks#ActivateDeviceIdentifier": { - "type": "operation", - "input": { - "target": "com.amazonaws.privatenetworks#ActivateDeviceIdentifierRequest" - }, - "output": { - "target": "com.amazonaws.privatenetworks#ActivateDeviceIdentifierResponse" - }, - "errors": [ - { - "target": "com.amazonaws.privatenetworks#InternalServerException" - }, - { - "target": "com.amazonaws.privatenetworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.privatenetworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Activates the specified device identifier.

", - "smithy.api#http": { - "uri": "/v1/device-identifiers/activate", - "method": "POST", - "code": 200 - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.privatenetworks#ActivateDeviceIdentifierRequest": { - "type": "structure", - "members": { - "deviceIdentifierArn": { - "target": "com.amazonaws.privatenetworks#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the device identifier.

", - "smithy.api#required": {} - } - }, - "clientToken": { - "target": "com.amazonaws.privatenetworks#ClientToken", - "traits": { - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. For more information, see How to ensure\n idempotency.

" - } - } - } - }, - "com.amazonaws.privatenetworks#ActivateDeviceIdentifierResponse": { - "type": "structure", - "members": { - "deviceIdentifier": { - "target": "com.amazonaws.privatenetworks#DeviceIdentifier", - "traits": { - "smithy.api#documentation": "

Information about the device identifier.

", - "smithy.api#required": {} - } - }, - "tags": { - "target": "com.amazonaws.privatenetworks#TagMap", - "traits": { - "smithy.api#documentation": "

The tags on the device identifier.

" - } - } - } - }, - "com.amazonaws.privatenetworks#ActivateNetworkSite": { - "type": "operation", - "input": { - "target": "com.amazonaws.privatenetworks#ActivateNetworkSiteRequest" - }, - "output": { - "target": "com.amazonaws.privatenetworks#ActivateNetworkSiteResponse" - }, - "errors": [ - { - "target": "com.amazonaws.privatenetworks#InternalServerException" - }, - { - "target": "com.amazonaws.privatenetworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.privatenetworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Activates the specified network site.

", - "smithy.api#http": { - "uri": "/v1/network-sites/activate", - "method": "POST", - "code": 200 - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.privatenetworks#ActivateNetworkSiteRequest": { - "type": "structure", - "members": { - "networkSiteArn": { - "target": "com.amazonaws.privatenetworks#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the network site.

", - "smithy.api#required": {} - } - }, - "shippingAddress": { - "target": "com.amazonaws.privatenetworks#Address", - "traits": { - "smithy.api#documentation": "

The shipping address of the network site.

", - "smithy.api#required": {} - } - }, - "clientToken": { - "target": "com.amazonaws.privatenetworks#ClientToken", - "traits": { - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. For more information, see How to ensure\n idempotency.

" - } - }, - "commitmentConfiguration": { - "target": "com.amazonaws.privatenetworks#CommitmentConfiguration", - "traits": { - "smithy.api#documentation": "

Determines the duration and renewal status of the commitment period for all pending radio\n units.

\n

If you include commitmentConfiguration in the\n ActivateNetworkSiteRequest action, you must specify the\n following:

\n \n

For pricing, see Amazon Web Services Private 5G\n Pricing.

\n

If you do not include commitmentConfiguration in the\n ActivateNetworkSiteRequest action, the commitment period is set to\n 60-days.

" - } - } - } - }, - "com.amazonaws.privatenetworks#ActivateNetworkSiteResponse": { - "type": "structure", - "members": { - "networkSite": { - "target": "com.amazonaws.privatenetworks#NetworkSite", - "traits": { - "smithy.api#documentation": "

Information about the network site.

" - } - } - } - }, - "com.amazonaws.privatenetworks#Address": { - "type": "structure", - "members": { - "city": { - "target": "com.amazonaws.privatenetworks#AddressContent", - "traits": { - "smithy.api#documentation": "

The city for this address.

", - "smithy.api#required": {} - } - }, - "company": { - "target": "com.amazonaws.privatenetworks#AddressContent", - "traits": { - "smithy.api#documentation": "

The company name for this address.

" - } - }, - "country": { - "target": "com.amazonaws.privatenetworks#AddressContent", - "traits": { - "smithy.api#documentation": "

The country for this address.

", - "smithy.api#required": {} - } - }, - "name": { - "target": "com.amazonaws.privatenetworks#AddressContent", - "traits": { - "smithy.api#documentation": "

The recipient's name for this address.

", - "smithy.api#required": {} - } - }, - "phoneNumber": { - "target": "com.amazonaws.privatenetworks#AddressContent", - "traits": { - "smithy.api#documentation": "

The recipient's phone number.

" - } - }, - "postalCode": { - "target": "com.amazonaws.privatenetworks#AddressContent", - "traits": { - "smithy.api#documentation": "

The postal code for this address.

", - "smithy.api#required": {} - } - }, - "stateOrProvince": { - "target": "com.amazonaws.privatenetworks#AddressContent", - "traits": { - "smithy.api#documentation": "

The state or province for this address.

", - "smithy.api#required": {} - } - }, - "street1": { - "target": "com.amazonaws.privatenetworks#AddressContent", - "traits": { - "smithy.api#documentation": "

The first line of the street address.

", - "smithy.api#required": {} - } - }, - "street2": { - "target": "com.amazonaws.privatenetworks#AddressContent", - "traits": { - "smithy.api#documentation": "

The second line of the street address.

" - } - }, - "street3": { - "target": "com.amazonaws.privatenetworks#AddressContent", - "traits": { - "smithy.api#documentation": "

The third line of the street address.

" - } - }, - "emailAddress": { - "target": "com.amazonaws.privatenetworks#AddressContent", - "traits": { - "smithy.api#documentation": "

The recipient's email address.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about an address.

" - } - }, - "com.amazonaws.privatenetworks#AddressContent": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - }, - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.privatenetworks#Arn": { - "type": "string", - "traits": { - "smithy.api#pattern": "^arn:aws:private-networks:[a-z0-9-]+:[^:]*:.*$" - } - }, - "com.amazonaws.privatenetworks#ClientToken": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.privatenetworks#CommitmentConfiguration": { - "type": "structure", - "members": { - "commitmentLength": { - "target": "com.amazonaws.privatenetworks#CommitmentLength", - "traits": { - "smithy.api#documentation": "

The duration of the commitment period for the radio unit. You can choose a 60-day, 1-year, or 3-year\n period.

", - "smithy.api#required": {} - } - }, - "automaticRenewal": { - "target": "smithy.api#Boolean", - "traits": { - "smithy.api#documentation": "

Determines whether the commitment period for a radio unit is set to automatically\n renew for an additional 1 year after your current commitment period expires.

\n

Set to True, if you want your commitment period to automatically renew.\n Set to False if you do not want your commitment to automatically renew.

\n

You can do the following:

\n \n

You cannot use the automatic-renewal option for a 60-day\n commitment.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Determines the duration and renewal status of the commitment period for a radio\n unit.

\n

For pricing, see Amazon Web Services Private 5G\n Pricing.

" - } - }, - "com.amazonaws.privatenetworks#CommitmentInformation": { - "type": "structure", - "members": { - "commitmentConfiguration": { - "target": "com.amazonaws.privatenetworks#CommitmentConfiguration", - "traits": { - "smithy.api#documentation": "

The duration and renewal status of the commitment period for the radio unit.

", - "smithy.api#required": {} - } - }, - "startAt": { - "target": "com.amazonaws.privatenetworks#Timestamp", - "traits": { - "smithy.api#documentation": "

The date and time that the commitment period started.

" - } - }, - "expiresOn": { - "target": "com.amazonaws.privatenetworks#Timestamp", - "traits": { - "smithy.api#documentation": "

The date and time that the commitment period ends. If you do not cancel or renew the\n commitment before the expiration date, you will be billed at the 60-day-commitment\n rate.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Shows the duration, the date and time that the contract started and ends, and the\n renewal status of the commitment period for the radio unit.

" - } - }, - "com.amazonaws.privatenetworks#CommitmentLength": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "name": "SIXTY_DAYS", - "value": "SIXTY_DAYS" - }, - { - "name": "ONE_YEAR", - "value": "ONE_YEAR" - }, - { - "name": "THREE_YEARS", - "value": "THREE_YEARS" - } - ] - } - }, - "com.amazonaws.privatenetworks#ConfigureAccessPoint": { - "type": "operation", - "input": { - "target": "com.amazonaws.privatenetworks#ConfigureAccessPointRequest" - }, - "output": { - "target": "com.amazonaws.privatenetworks#ConfigureAccessPointResponse" - }, - "errors": [ - { - "target": "com.amazonaws.privatenetworks#InternalServerException" - }, - { - "target": "com.amazonaws.privatenetworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.privatenetworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Configures the specified network resource.

\n

Use this action to specify the geographic position of the hardware. You must provide\n Certified Professional Installer (CPI) credentials in the request so that we can obtain\n spectrum grants. For more information, see Radio units in the\n Amazon Web Services Private 5G User Guide.

", - "smithy.api#http": { - "uri": "/v1/network-resources/configure", - "method": "POST", - "code": 200 - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.privatenetworks#ConfigureAccessPointRequest": { - "type": "structure", - "members": { - "accessPointArn": { - "target": "com.amazonaws.privatenetworks#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the network resource.

", - "smithy.api#required": {} - } - }, - "position": { - "target": "com.amazonaws.privatenetworks#Position", - "traits": { - "smithy.api#documentation": "

The position of the network resource.

" - } - }, - "cpiUsername": { - "target": "com.amazonaws.privatenetworks#SensitiveString", - "traits": { - "smithy.api#documentation": "

The CPI user name of the CPI user who is certifying the coordinates of the radio\n unit.

", - "smithy.api#length": { - "min": 1, - "max": 4096 - } - } - }, - "cpiUserId": { - "target": "com.amazonaws.privatenetworks#SensitiveString", - "traits": { - "smithy.api#documentation": "

The CPI user ID of the CPI user who is certifying the coordinates of the network\n resource.

", - "smithy.api#length": { - "min": 1, - "max": 4096 - } - } - }, - "cpiUserPassword": { - "target": "com.amazonaws.privatenetworks#SensitiveString", - "traits": { - "smithy.api#documentation": "

The CPI password associated with the CPI certificate in\n cpiSecretKey.

", - "smithy.api#length": { - "min": 1, - "max": 4096 - } - } - }, - "cpiSecretKey": { - "target": "com.amazonaws.privatenetworks#SensitiveString", - "traits": { - "smithy.api#documentation": "

A Base64 encoded string of the CPI certificate associated with the CPI user who is\n certifying the coordinates of the network resource.

", - "smithy.api#length": { - "min": 1, - "max": 100000 - } - } - } - } - }, - "com.amazonaws.privatenetworks#ConfigureAccessPointResponse": { - "type": "structure", - "members": { - "accessPoint": { - "target": "com.amazonaws.privatenetworks#NetworkResource", - "traits": { - "smithy.api#documentation": "

Information about the network resource.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.privatenetworks#CreateNetwork": { - "type": "operation", - "input": { - "target": "com.amazonaws.privatenetworks#CreateNetworkRequest" - }, - "output": { - "target": "com.amazonaws.privatenetworks#CreateNetworkResponse" - }, - "errors": [ - { - "target": "com.amazonaws.privatenetworks#InternalServerException" - }, - { - "target": "com.amazonaws.privatenetworks#LimitExceededException" - }, - { - "target": "com.amazonaws.privatenetworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a network.

", - "smithy.api#http": { - "uri": "/v1/networks", - "method": "POST", - "code": 200 - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.privatenetworks#CreateNetworkRequest": { - "type": "structure", - "members": { - "networkName": { - "target": "com.amazonaws.privatenetworks#Name", - "traits": { - "smithy.api#documentation": "

The name of the network. You can't change the name after you create the\n network.

", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.privatenetworks#Description", - "traits": { - "smithy.api#documentation": "

The description of the network.

" - } - }, - "clientToken": { - "target": "com.amazonaws.privatenetworks#ClientToken", - "traits": { - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. For more information, see How to ensure\n idempotency.

" - } - }, - "tags": { - "target": "com.amazonaws.privatenetworks#TagMap", - "traits": { - "smithy.api#documentation": "

The tags to apply to the network.

" - } - } - } - }, - "com.amazonaws.privatenetworks#CreateNetworkResponse": { - "type": "structure", - "members": { - "network": { - "target": "com.amazonaws.privatenetworks#Network", - "traits": { - "smithy.api#documentation": "

Information about the network.

", - "smithy.api#required": {} - } - }, - "tags": { - "target": "com.amazonaws.privatenetworks#TagMap", - "traits": { - "smithy.api#documentation": "

The network tags.

" - } - } - } - }, - "com.amazonaws.privatenetworks#CreateNetworkSite": { - "type": "operation", - "input": { - "target": "com.amazonaws.privatenetworks#CreateNetworkSiteRequest" - }, - "output": { - "target": "com.amazonaws.privatenetworks#CreateNetworkSiteResponse" - }, - "errors": [ - { - "target": "com.amazonaws.privatenetworks#InternalServerException" - }, - { - "target": "com.amazonaws.privatenetworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.privatenetworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a network site.

", - "smithy.api#http": { - "uri": "/v1/network-sites", - "method": "POST", - "code": 200 - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.privatenetworks#CreateNetworkSiteRequest": { - "type": "structure", - "members": { - "networkSiteName": { - "target": "com.amazonaws.privatenetworks#Name", - "traits": { - "smithy.api#documentation": "

The name of the site. You can't change the name after you create the site.

", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.privatenetworks#Description", - "traits": { - "smithy.api#documentation": "

The description of the site.

" - } - }, - "networkArn": { - "target": "com.amazonaws.privatenetworks#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the network.

", - "smithy.api#required": {} - } - }, - "pendingPlan": { - "target": "com.amazonaws.privatenetworks#SitePlan", - "traits": { - "smithy.api#documentation": "

Information about the pending plan for this site.

" - } - }, - "clientToken": { - "target": "com.amazonaws.privatenetworks#ClientToken", - "traits": { - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. For more information, see How to ensure\n idempotency.

" - } - }, - "availabilityZone": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

The Availability Zone that is the parent of this site. You can't change the\n Availability Zone after you create the site.

" - } - }, - "availabilityZoneId": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

The ID of the Availability Zone that is the parent of this site. You can't change the\n Availability Zone after you create the site.

" - } - }, - "tags": { - "target": "com.amazonaws.privatenetworks#TagMap", - "traits": { - "smithy.api#documentation": "

The tags to apply to the network site.

" - } - } - } - }, - "com.amazonaws.privatenetworks#CreateNetworkSiteResponse": { - "type": "structure", - "members": { - "networkSite": { - "target": "com.amazonaws.privatenetworks#NetworkSite", - "traits": { - "smithy.api#documentation": "

Information about the network site.

" - } - }, - "tags": { - "target": "com.amazonaws.privatenetworks#TagMap", - "traits": { - "smithy.api#documentation": "

The network site tags.

" - } - } - } - }, - "com.amazonaws.privatenetworks#DeactivateDeviceIdentifier": { - "type": "operation", - "input": { - "target": "com.amazonaws.privatenetworks#DeactivateDeviceIdentifierRequest" - }, - "output": { - "target": "com.amazonaws.privatenetworks#DeactivateDeviceIdentifierResponse" - }, - "errors": [ - { - "target": "com.amazonaws.privatenetworks#InternalServerException" - }, - { - "target": "com.amazonaws.privatenetworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.privatenetworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Deactivates the specified device identifier.

", - "smithy.api#http": { - "uri": "/v1/device-identifiers/deactivate", - "method": "POST", - "code": 200 - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.privatenetworks#DeactivateDeviceIdentifierRequest": { - "type": "structure", - "members": { - "deviceIdentifierArn": { - "target": "com.amazonaws.privatenetworks#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the device identifier.

", - "smithy.api#required": {} - } - }, - "clientToken": { - "target": "com.amazonaws.privatenetworks#ClientToken", - "traits": { - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. For more information, see How to ensure\n idempotency.

" - } - } - } - }, - "com.amazonaws.privatenetworks#DeactivateDeviceIdentifierResponse": { - "type": "structure", - "members": { - "deviceIdentifier": { - "target": "com.amazonaws.privatenetworks#DeviceIdentifier", - "traits": { - "smithy.api#documentation": "

Information about the device identifier.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.privatenetworks#DeleteNetwork": { - "type": "operation", - "input": { - "target": "com.amazonaws.privatenetworks#DeleteNetworkRequest" - }, - "output": { - "target": "com.amazonaws.privatenetworks#DeleteNetworkResponse" - }, - "errors": [ - { - "target": "com.amazonaws.privatenetworks#AccessDeniedException" - }, - { - "target": "com.amazonaws.privatenetworks#InternalServerException" - }, - { - "target": "com.amazonaws.privatenetworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.privatenetworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes the specified network. You must delete network sites before you delete the\n network. For more information, see DeleteNetworkSite in the API Reference for Amazon Web Services Private\n 5G.

", - "smithy.api#http": { - "uri": "/v1/networks/{networkArn}", - "method": "DELETE", - "code": 200 - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.privatenetworks#DeleteNetworkRequest": { - "type": "structure", - "members": { - "networkArn": { - "target": "com.amazonaws.privatenetworks#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the network.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "clientToken": { - "target": "com.amazonaws.privatenetworks#ClientToken", - "traits": { - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. For more information, see How to ensure\n idempotency.

", - "smithy.api#httpQuery": "clientToken" - } - } - } - }, - "com.amazonaws.privatenetworks#DeleteNetworkResponse": { - "type": "structure", - "members": { - "network": { - "target": "com.amazonaws.privatenetworks#Network", - "traits": { - "smithy.api#documentation": "

Information about the network.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.privatenetworks#DeleteNetworkSite": { - "type": "operation", - "input": { - "target": "com.amazonaws.privatenetworks#DeleteNetworkSiteRequest" - }, - "output": { - "target": "com.amazonaws.privatenetworks#DeleteNetworkSiteResponse" - }, - "errors": [ - { - "target": "com.amazonaws.privatenetworks#AccessDeniedException" - }, - { - "target": "com.amazonaws.privatenetworks#InternalServerException" - }, - { - "target": "com.amazonaws.privatenetworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.privatenetworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes the specified network site. Return the hardware after you delete the network\n site. You are responsible for minimum charges. For more information, see Hardware\n returns in the Amazon Web Services Private 5G User\n Guide.

", - "smithy.api#http": { - "uri": "/v1/network-sites/{networkSiteArn}", - "method": "DELETE", - "code": 200 - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.privatenetworks#DeleteNetworkSiteRequest": { - "type": "structure", - "members": { - "networkSiteArn": { - "target": "com.amazonaws.privatenetworks#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the network site.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "clientToken": { - "target": "com.amazonaws.privatenetworks#ClientToken", - "traits": { - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. For more information, see How to ensure\n idempotency.

", - "smithy.api#httpQuery": "clientToken" - } - } - } - }, - "com.amazonaws.privatenetworks#DeleteNetworkSiteResponse": { - "type": "structure", - "members": { - "networkSite": { - "target": "com.amazonaws.privatenetworks#NetworkSite", - "traits": { - "smithy.api#documentation": "

Information about the network site.

" - } - } - } - }, - "com.amazonaws.privatenetworks#Description": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.privatenetworks#DeviceIdentifier": { - "type": "structure", - "members": { - "deviceIdentifierArn": { - "target": "com.amazonaws.privatenetworks#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the device identifier.

" - } - }, - "trafficGroupArn": { - "target": "com.amazonaws.privatenetworks#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the traffic group to which the device identifier\n belongs.

" - } - }, - "networkArn": { - "target": "com.amazonaws.privatenetworks#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the network on which the device identifier\n appears.

" - } - }, - "imsi": { - "target": "com.amazonaws.privatenetworks#SensitiveString", - "traits": { - "smithy.api#documentation": "

The International Mobile Subscriber Identity of the device identifier.

", - "smithy.api#pattern": "^[0-9]{15}$" - } - }, - "iccid": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

The Integrated Circuit Card Identifier of the device identifier.

" - } - }, - "vendor": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

The vendor of the device identifier.

" - } - }, - "status": { - "target": "com.amazonaws.privatenetworks#DeviceIdentifierStatus", - "traits": { - "smithy.api#documentation": "

The status of the device identifier.

" - } - }, - "orderArn": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the order used to purchase the device\n identifier.

" - } - }, - "createdAt": { - "target": "com.amazonaws.privatenetworks#Timestamp", - "traits": { - "smithy.api#documentation": "

The creation time of this device identifier.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about a subscriber of a device that can use a network.

" - } - }, - "com.amazonaws.privatenetworks#DeviceIdentifierFilterKeys": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "name": "STATUS", - "value": "STATUS" - }, - { - "name": "ORDER", - "value": "ORDER" - }, - { - "name": "TRAFFIC_GROUP", - "value": "TRAFFIC_GROUP" - } - ] - } - }, - "com.amazonaws.privatenetworks#DeviceIdentifierFilterValues": { - "type": "list", - "member": { - "target": "smithy.api#String" - } - }, - "com.amazonaws.privatenetworks#DeviceIdentifierFilters": { - "type": "map", - "key": { - "target": "com.amazonaws.privatenetworks#DeviceIdentifierFilterKeys" - }, - "value": { - "target": "com.amazonaws.privatenetworks#DeviceIdentifierFilterValues" - } - }, - "com.amazonaws.privatenetworks#DeviceIdentifierList": { - "type": "list", - "member": { - "target": "com.amazonaws.privatenetworks#DeviceIdentifier" - } - }, - "com.amazonaws.privatenetworks#DeviceIdentifierStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ACTIVE", - "name": "ACTIVE" - }, - { - "value": "INACTIVE", - "name": "INACTIVE" - } - ] - } - }, - "com.amazonaws.privatenetworks#E5GNetworkControllerLambda": { - "type": "service", - "version": "2021-12-03", - "operations": [ - { - "target": "com.amazonaws.privatenetworks#AcknowledgeOrderReceipt" - }, - { - "target": "com.amazonaws.privatenetworks#ActivateDeviceIdentifier" - }, - { - "target": "com.amazonaws.privatenetworks#ActivateNetworkSite" - }, - { - "target": "com.amazonaws.privatenetworks#ConfigureAccessPoint" - }, - { - "target": "com.amazonaws.privatenetworks#CreateNetwork" - }, - { - "target": "com.amazonaws.privatenetworks#CreateNetworkSite" - }, - { - "target": "com.amazonaws.privatenetworks#DeactivateDeviceIdentifier" - }, - { - "target": "com.amazonaws.privatenetworks#DeleteNetwork" - }, - { - "target": "com.amazonaws.privatenetworks#DeleteNetworkSite" - }, - { - "target": "com.amazonaws.privatenetworks#GetDeviceIdentifier" - }, - { - "target": "com.amazonaws.privatenetworks#GetNetwork" - }, - { - "target": "com.amazonaws.privatenetworks#GetNetworkResource" - }, - { - "target": "com.amazonaws.privatenetworks#GetNetworkSite" - }, - { - "target": "com.amazonaws.privatenetworks#GetOrder" - }, - { - "target": "com.amazonaws.privatenetworks#ListDeviceIdentifiers" - }, - { - "target": "com.amazonaws.privatenetworks#ListNetworkResources" - }, - { - "target": "com.amazonaws.privatenetworks#ListNetworks" - }, - { - "target": "com.amazonaws.privatenetworks#ListNetworkSites" - }, - { - "target": "com.amazonaws.privatenetworks#ListOrders" - }, - { - "target": "com.amazonaws.privatenetworks#ListTagsForResource" - }, - { - "target": "com.amazonaws.privatenetworks#Ping" - }, - { - "target": "com.amazonaws.privatenetworks#StartNetworkResourceUpdate" - }, - { - "target": "com.amazonaws.privatenetworks#TagResource" - }, - { - "target": "com.amazonaws.privatenetworks#UntagResource" - }, - { - "target": "com.amazonaws.privatenetworks#UpdateNetworkSite" - }, - { - "target": "com.amazonaws.privatenetworks#UpdateNetworkSitePlan" - } - ], - "traits": { - "aws.api#service": { - "sdkId": "PrivateNetworks", - "arnNamespace": "private-networks" - }, - "aws.auth#sigv4": { - "name": "private-networks" - }, - "aws.protocols#restJson1": {}, - "smithy.api#cors": { - "additionalAllowedHeaders": [ - "*", - "content-type", - "x-amz-content-sha256", - "x-amz-user-agent", - "x-amzn-platform-id", - "x-amzn-trace-id" - ], - "additionalExposedHeaders": [ - "x-amzn-errortype", - "x-amzn-requestid", - "x-amzn-trace-id" - ], - "maxAge": 86400 - }, - "smithy.api#documentation": "

Amazon Web Services Private 5G is a managed service that makes it easy to deploy, operate, and scale\n your own private mobile network at your on-premises location. Private 5G provides the\n pre-configured hardware and software for mobile networks, helps automate setup, and\n scales capacity on demand to support additional devices as needed.

", - "smithy.api#title": "AWS Private 5G", - "smithy.rules#endpointRuleSet": { - "version": "1.0", - "parameters": { - "Region": { - "builtIn": "AWS::Region", - "required": false, - "documentation": "The AWS region used to dispatch the request.", - "type": "String" - }, - "UseDualStack": { - "builtIn": "AWS::UseDualStack", - "required": true, - "default": false, - "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", - "type": "Boolean" - }, - "UseFIPS": { - "builtIn": "AWS::UseFIPS", - "required": true, - "default": false, - "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", - "type": "Boolean" - }, - "Endpoint": { - "builtIn": "SDK::Endpoint", - "required": false, - "documentation": "Override the endpoint used to send this request", - "type": "String" - } - }, - "rules": [ - { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Endpoint" - } - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "error": "Invalid Configuration: FIPS and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" - }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Region" - } - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "aws.partition", - "argv": [ - { - "ref": "Region" - } - ], - "assign": "PartitionResult" - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - }, - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://private-networks-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - }, - true - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://private-networks-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://private-networks.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [], - "endpoint": { - "url": "https://private-networks.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" - } - ] - }, - "smithy.rules#endpointTests": { - "testCases": [ - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://private-networks-fips.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://private-networks-fips.us-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://private-networks.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://private-networks.us-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://private-networks-fips.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://private-networks-fips.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://private-networks.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://private-networks.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://private-networks-fips.us-gov-east-1.api.aws" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://private-networks-fips.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://private-networks.us-gov-east-1.api.aws" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://private-networks.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://private-networks-fips.us-iso-east-1.c2s.ic.gov" - } - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://private-networks.us-iso-east-1.c2s.ic.gov" - } - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://private-networks-fips.us-isob-east-1.sc2s.sgov.gov" - } - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://private-networks.us-isob-east-1.sc2s.sgov.gov" - } - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": false, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": false, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "For custom endpoint with fips enabled and dualstack disabled", - "expect": { - "error": "Invalid Configuration: FIPS and custom endpoint are not supported" - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": false, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "For custom endpoint with fips disabled and dualstack enabled", - "expect": { - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": true, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "Missing region", - "expect": { - "error": "Invalid Configuration: Missing Region" - } - } - ], - "version": "1.0" - } - } - }, - "com.amazonaws.privatenetworks#ElevationReference": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "AGL", - "name": "AGL" - }, - { - "value": "AMSL", - "name": "AMSL" - } - ] - } - }, - "com.amazonaws.privatenetworks#ElevationUnit": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "FEET", - "name": "FEET", - "documentation": "Feet." - } - ] - } - }, - "com.amazonaws.privatenetworks#GetDeviceIdentifier": { - "type": "operation", - "input": { - "target": "com.amazonaws.privatenetworks#GetDeviceIdentifierRequest" - }, - "output": { - "target": "com.amazonaws.privatenetworks#GetDeviceIdentifierResponse" - }, - "errors": [ - { - "target": "com.amazonaws.privatenetworks#InternalServerException" - }, - { - "target": "com.amazonaws.privatenetworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.privatenetworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Gets the specified device identifier.

", - "smithy.api#http": { - "uri": "/v1/device-identifiers/{deviceIdentifierArn}", - "method": "GET", - "code": 200 - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.privatenetworks#GetDeviceIdentifierRequest": { - "type": "structure", - "members": { - "deviceIdentifierArn": { - "target": "com.amazonaws.privatenetworks#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the device identifier.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.privatenetworks#GetDeviceIdentifierResponse": { - "type": "structure", - "members": { - "deviceIdentifier": { - "target": "com.amazonaws.privatenetworks#DeviceIdentifier", - "traits": { - "smithy.api#documentation": "

Information about the device identifier.

" - } - }, - "tags": { - "target": "com.amazonaws.privatenetworks#TagMap", - "traits": { - "smithy.api#documentation": "

The device identifier tags.

" - } - } - } - }, - "com.amazonaws.privatenetworks#GetNetwork": { - "type": "operation", - "input": { - "target": "com.amazonaws.privatenetworks#GetNetworkRequest" - }, - "output": { - "target": "com.amazonaws.privatenetworks#GetNetworkResponse" - }, - "errors": [ - { - "target": "com.amazonaws.privatenetworks#InternalServerException" - }, - { - "target": "com.amazonaws.privatenetworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.privatenetworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Gets the specified network.

", - "smithy.api#http": { - "uri": "/v1/networks/{networkArn}", - "method": "GET", - "code": 200 - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.privatenetworks#GetNetworkRequest": { - "type": "structure", - "members": { - "networkArn": { - "target": "com.amazonaws.privatenetworks#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the network.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.privatenetworks#GetNetworkResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.privatenetworks#GetNetworkResourceRequest" - }, - "output": { - "target": "com.amazonaws.privatenetworks#GetNetworkResourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.privatenetworks#InternalServerException" - }, - { - "target": "com.amazonaws.privatenetworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.privatenetworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Gets the specified network resource.

", - "smithy.api#http": { - "uri": "/v1/network-resources/{networkResourceArn}", - "method": "GET", - "code": 200 - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.privatenetworks#GetNetworkResourceRequest": { - "type": "structure", - "members": { - "networkResourceArn": { - "target": "com.amazonaws.privatenetworks#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the network resource.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.privatenetworks#GetNetworkResourceResponse": { - "type": "structure", - "members": { - "networkResource": { - "target": "com.amazonaws.privatenetworks#NetworkResource", - "traits": { - "smithy.api#documentation": "

Information about the network resource.

", - "smithy.api#required": {} - } - }, - "tags": { - "target": "com.amazonaws.privatenetworks#TagMap", - "traits": { - "smithy.api#documentation": "

The network resource tags.

" - } - } - } - }, - "com.amazonaws.privatenetworks#GetNetworkResponse": { - "type": "structure", - "members": { - "network": { - "target": "com.amazonaws.privatenetworks#Network", - "traits": { - "smithy.api#documentation": "

Information about the network.

", - "smithy.api#required": {} - } - }, - "tags": { - "target": "com.amazonaws.privatenetworks#TagMap", - "traits": { - "smithy.api#documentation": "

The network tags.

" - } - } - } - }, - "com.amazonaws.privatenetworks#GetNetworkSite": { - "type": "operation", - "input": { - "target": "com.amazonaws.privatenetworks#GetNetworkSiteRequest" - }, - "output": { - "target": "com.amazonaws.privatenetworks#GetNetworkSiteResponse" - }, - "errors": [ - { - "target": "com.amazonaws.privatenetworks#InternalServerException" - }, - { - "target": "com.amazonaws.privatenetworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.privatenetworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Gets the specified network site.

", - "smithy.api#http": { - "uri": "/v1/network-sites/{networkSiteArn}", - "method": "GET", - "code": 200 - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.privatenetworks#GetNetworkSiteRequest": { - "type": "structure", - "members": { - "networkSiteArn": { - "target": "com.amazonaws.privatenetworks#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the network site.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.privatenetworks#GetNetworkSiteResponse": { - "type": "structure", - "members": { - "networkSite": { - "target": "com.amazonaws.privatenetworks#NetworkSite", - "traits": { - "smithy.api#documentation": "

Information about the network site.

" - } - }, - "tags": { - "target": "com.amazonaws.privatenetworks#TagMap", - "traits": { - "smithy.api#documentation": "

The network site tags.

" - } - } - } - }, - "com.amazonaws.privatenetworks#GetOrder": { - "type": "operation", - "input": { - "target": "com.amazonaws.privatenetworks#GetOrderRequest" - }, - "output": { - "target": "com.amazonaws.privatenetworks#GetOrderResponse" - }, - "errors": [ - { - "target": "com.amazonaws.privatenetworks#InternalServerException" - }, - { - "target": "com.amazonaws.privatenetworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.privatenetworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Gets the specified order.

", - "smithy.api#http": { - "uri": "/v1/orders/{orderArn}", - "method": "GET", - "code": 200 - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.privatenetworks#GetOrderRequest": { - "type": "structure", - "members": { - "orderArn": { - "target": "com.amazonaws.privatenetworks#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the order.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.privatenetworks#GetOrderResponse": { - "type": "structure", - "members": { - "order": { - "target": "com.amazonaws.privatenetworks#Order", - "traits": { - "smithy.api#documentation": "

Information about the order.

", - "smithy.api#required": {} - } - }, - "tags": { - "target": "com.amazonaws.privatenetworks#TagMap", - "traits": { - "smithy.api#documentation": "

The order tags.

" - } - } - } - }, - "com.amazonaws.privatenetworks#HealthStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "INITIAL", - "name": "INITIAL" - }, - { - "value": "HEALTHY", - "name": "HEALTHY" - }, - { - "value": "UNHEALTHY", - "name": "UNHEALTHY" - } - ] - } - }, - "com.amazonaws.privatenetworks#InternalServerException": { - "type": "structure", - "members": { - "message": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "Description of the error.", - "smithy.api#required": {} - } - }, - "retryAfterSeconds": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "Advice to clients on when the call can be safely retried.", - "smithy.api#httpHeader": "Retry-After" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about an internal error.

", - "smithy.api#error": "server", - "smithy.api#httpError": 500, - "smithy.api#retryable": {} - } - }, - "com.amazonaws.privatenetworks#LimitExceededException": { - "type": "structure", - "members": { - "message": { - "target": "smithy.api#String", - "traits": { - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The limit was exceeded.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.privatenetworks#ListDeviceIdentifiers": { - "type": "operation", - "input": { - "target": "com.amazonaws.privatenetworks#ListDeviceIdentifiersRequest" - }, - "output": { - "target": "com.amazonaws.privatenetworks#ListDeviceIdentifiersResponse" - }, - "errors": [ - { - "target": "com.amazonaws.privatenetworks#InternalServerException" - }, - { - "target": "com.amazonaws.privatenetworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.privatenetworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists device identifiers. Add filters to your request to return a more specific list\n of results. Use filters to match the Amazon Resource Name (ARN) of an order, the status\n of device identifiers, or the ARN of the traffic group.

\n

If you specify multiple filters, filters are joined with an OR, and the request\nreturns results that match all of the specified filters.

", - "smithy.api#http": { - "uri": "/v1/device-identifiers/list", - "method": "POST", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "startToken", - "outputToken": "nextToken", - "pageSize": "maxResults", - "items": "deviceIdentifiers" - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.privatenetworks#ListDeviceIdentifiersRequest": { - "type": "structure", - "members": { - "filters": { - "target": "com.amazonaws.privatenetworks#DeviceIdentifierFilters", - "traits": { - "smithy.api#documentation": "

The filters.

\n \n

Filter values are case sensitive. If you specify multiple \n values for a filter, the values are joined with an OR, and the request returns \n all results that match any of the specified values.

" - } - }, - "networkArn": { - "target": "com.amazonaws.privatenetworks#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the network.

", - "smithy.api#required": {} - } - }, - "startToken": { - "target": "com.amazonaws.privatenetworks#PaginationToken", - "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" - } - }, - "maxResults": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The maximum number of results to return.

", - "smithy.api#range": { - "min": 1, - "max": 20 - } - } - } - } - }, - "com.amazonaws.privatenetworks#ListDeviceIdentifiersResponse": { - "type": "structure", - "members": { - "deviceIdentifiers": { - "target": "com.amazonaws.privatenetworks#DeviceIdentifierList", - "traits": { - "smithy.api#documentation": "

Information about the device identifiers.

" - } - }, - "nextToken": { - "target": "com.amazonaws.privatenetworks#PaginationToken", - "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" - } - } - } - }, - "com.amazonaws.privatenetworks#ListNetworkResources": { - "type": "operation", - "input": { - "target": "com.amazonaws.privatenetworks#ListNetworkResourcesRequest" - }, - "output": { - "target": "com.amazonaws.privatenetworks#ListNetworkResourcesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.privatenetworks#InternalServerException" - }, - { - "target": "com.amazonaws.privatenetworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.privatenetworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists network resources. Add filters to your request to return a more specific list of\n results. Use filters to match the Amazon Resource Name (ARN) of an order or the status\n of network resources.

\n

If you specify multiple filters, filters are joined with an OR, and the request\nreturns results that match all of the specified filters.

", - "smithy.api#http": { - "uri": "/v1/network-resources", - "method": "POST", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "startToken", - "outputToken": "nextToken", - "pageSize": "maxResults", - "items": "networkResources" - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.privatenetworks#ListNetworkResourcesRequest": { - "type": "structure", - "members": { - "filters": { - "target": "com.amazonaws.privatenetworks#NetworkResourceFilters", - "traits": { - "smithy.api#documentation": "

The filters.

\n \n

Filter values are case sensitive. If you specify multiple \n values for a filter, the values are joined with an OR, and the request returns \n all results that match any of the specified values.

" - } - }, - "networkArn": { - "target": "com.amazonaws.privatenetworks#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the network.

", - "smithy.api#required": {} - } - }, - "startToken": { - "target": "com.amazonaws.privatenetworks#PaginationToken", - "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" - } - }, - "maxResults": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The maximum number of results to return.

", - "smithy.api#range": { - "min": 1, - "max": 20 - } - } - } - } - }, - "com.amazonaws.privatenetworks#ListNetworkResourcesResponse": { - "type": "structure", - "members": { - "networkResources": { - "target": "com.amazonaws.privatenetworks#NetworkResourceList", - "traits": { - "smithy.api#documentation": "

Information about network resources.

" - } - }, - "nextToken": { - "target": "com.amazonaws.privatenetworks#PaginationToken", - "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" - } - } - } - }, - "com.amazonaws.privatenetworks#ListNetworkSites": { - "type": "operation", - "input": { - "target": "com.amazonaws.privatenetworks#ListNetworkSitesRequest" - }, - "output": { - "target": "com.amazonaws.privatenetworks#ListNetworkSitesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.privatenetworks#InternalServerException" - }, - { - "target": "com.amazonaws.privatenetworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.privatenetworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists network sites. Add filters to your request to return a more specific list of\n results. Use filters to match the status of the network site.

", - "smithy.api#http": { - "uri": "/v1/network-sites/list", - "method": "POST", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "startToken", - "outputToken": "nextToken", - "pageSize": "maxResults", - "items": "networkSites" - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.privatenetworks#ListNetworkSitesRequest": { - "type": "structure", - "members": { - "filters": { - "target": "com.amazonaws.privatenetworks#NetworkSiteFilters", - "traits": { - "smithy.api#documentation": "

The filters. Add filters to your request to return a more specific list of results.\n Use filters to match the status of the network sites.

\n \n

Filter values are case sensitive. If you specify multiple \n values for a filter, the values are joined with an OR, and the request returns \n all results that match any of the specified values.

" - } - }, - "networkArn": { - "target": "com.amazonaws.privatenetworks#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the network.

", - "smithy.api#required": {} - } - }, - "startToken": { - "target": "com.amazonaws.privatenetworks#PaginationToken", - "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" - } - }, - "maxResults": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The maximum number of results to return.

", - "smithy.api#range": { - "min": 1, - "max": 20 - } - } - } - } - }, - "com.amazonaws.privatenetworks#ListNetworkSitesResponse": { - "type": "structure", - "members": { - "networkSites": { - "target": "com.amazonaws.privatenetworks#NetworkSiteList", - "traits": { - "smithy.api#documentation": "

Information about the network sites.

" - } - }, - "nextToken": { - "target": "com.amazonaws.privatenetworks#PaginationToken", - "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" - } - } - } - }, - "com.amazonaws.privatenetworks#ListNetworks": { - "type": "operation", - "input": { - "target": "com.amazonaws.privatenetworks#ListNetworksRequest" - }, - "output": { - "target": "com.amazonaws.privatenetworks#ListNetworksResponse" - }, - "errors": [ - { - "target": "com.amazonaws.privatenetworks#InternalServerException" - }, - { - "target": "com.amazonaws.privatenetworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.privatenetworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists networks. Add filters to your request to return a more specific list of results.\n Use filters to match the status of the network.

", - "smithy.api#http": { - "uri": "/v1/networks/list", - "method": "POST", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "startToken", - "outputToken": "nextToken", - "pageSize": "maxResults", - "items": "networks" - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.privatenetworks#ListNetworksRequest": { - "type": "structure", - "members": { - "filters": { - "target": "com.amazonaws.privatenetworks#NetworkFilters", - "traits": { - "smithy.api#documentation": "

The filters.

\n \n

Filter values are case sensitive. If you specify multiple \n values for a filter, the values are joined with an OR, and the request returns \n all results that match any of the specified values.

" - } - }, - "startToken": { - "target": "com.amazonaws.privatenetworks#PaginationToken", - "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" - } - }, - "maxResults": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The maximum number of results to return.

", - "smithy.api#range": { - "min": 1, - "max": 20 - } - } - } - } - }, - "com.amazonaws.privatenetworks#ListNetworksResponse": { - "type": "structure", - "members": { - "networks": { - "target": "com.amazonaws.privatenetworks#NetworkList", - "traits": { - "smithy.api#documentation": "

The networks.

" - } - }, - "nextToken": { - "target": "com.amazonaws.privatenetworks#PaginationToken", - "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" - } - } - } - }, - "com.amazonaws.privatenetworks#ListOrders": { - "type": "operation", - "input": { - "target": "com.amazonaws.privatenetworks#ListOrdersRequest" - }, - "output": { - "target": "com.amazonaws.privatenetworks#ListOrdersResponse" - }, - "errors": [ - { - "target": "com.amazonaws.privatenetworks#InternalServerException" - }, - { - "target": "com.amazonaws.privatenetworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.privatenetworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists orders. Add filters to your request to return a more specific list of results.\n Use filters to match the Amazon Resource Name (ARN) of the network site or the status of\n the order.

\n

If you specify multiple filters, filters are joined with an OR, and the request\nreturns results that match all of the specified filters.

", - "smithy.api#http": { - "uri": "/v1/orders/list", - "method": "POST", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "startToken", - "outputToken": "nextToken", - "pageSize": "maxResults", - "items": "orders" - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.privatenetworks#ListOrdersRequest": { - "type": "structure", - "members": { - "networkArn": { - "target": "com.amazonaws.privatenetworks#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the network.

", - "smithy.api#required": {} - } - }, - "startToken": { - "target": "com.amazonaws.privatenetworks#PaginationToken", - "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" - } - }, - "maxResults": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The maximum number of results to return.

", - "smithy.api#range": { - "min": 1, - "max": 20 - } - } - }, - "filters": { - "target": "com.amazonaws.privatenetworks#OrderFilters", - "traits": { - "smithy.api#documentation": "

The filters.

\n \n

Filter values are case sensitive. If you specify multiple \n values for a filter, the values are joined with an OR, and the request returns \n all results that match any of the specified values.

" - } - } - } - }, - "com.amazonaws.privatenetworks#ListOrdersResponse": { - "type": "structure", - "members": { - "orders": { - "target": "com.amazonaws.privatenetworks#OrderList", - "traits": { - "smithy.api#documentation": "

Information about the orders.

" - } - }, - "nextToken": { - "target": "com.amazonaws.privatenetworks#PaginationToken", - "traits": { - "smithy.api#documentation": "

The token for the next page of results.

" - } - } - } - }, - "com.amazonaws.privatenetworks#ListTagsForResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.privatenetworks#ListTagsForResourceRequest" - }, - "output": { - "target": "com.amazonaws.privatenetworks#ListTagsForResourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.privatenetworks#AccessDeniedException" - }, - { - "target": "com.amazonaws.privatenetworks#InternalServerException" - }, - { - "target": "com.amazonaws.privatenetworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.privatenetworks#ThrottlingException" - }, - { - "target": "com.amazonaws.privatenetworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists the tags for the specified resource.

", - "smithy.api#http": { - "method": "GET", - "uri": "/tags/{resourceArn}", - "code": 200 - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.privatenetworks#ListTagsForResourceRequest": { - "type": "structure", - "members": { - "resourceArn": { - "target": "com.amazonaws.privatenetworks#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.privatenetworks#ListTagsForResourceResponse": { - "type": "structure", - "members": { - "tags": { - "target": "com.amazonaws.privatenetworks#TagMap", - "traits": { - "smithy.api#documentation": "

The resource tags.

" - } - } - } - }, - "com.amazonaws.privatenetworks#Name": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - }, - "smithy.api#pattern": "^[0-9a-zA-Z-]*$" - } - }, - "com.amazonaws.privatenetworks#NameValuePair": { - "type": "structure", - "members": { - "name": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

The name of the pair.

", - "smithy.api#required": {} - } - }, - "value": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

The value of the pair.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about a name/value pair.

" - } - }, - "com.amazonaws.privatenetworks#NameValuePairs": { - "type": "list", - "member": { - "target": "com.amazonaws.privatenetworks#NameValuePair" - } - }, - "com.amazonaws.privatenetworks#Network": { - "type": "structure", - "members": { - "networkArn": { - "target": "com.amazonaws.privatenetworks#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the network.

", - "smithy.api#required": {} - } - }, - "networkName": { - "target": "com.amazonaws.privatenetworks#Name", - "traits": { - "smithy.api#documentation": "

The name of the network.

", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.privatenetworks#Description", - "traits": { - "smithy.api#documentation": "

The description of the network.

" - } - }, - "status": { - "target": "com.amazonaws.privatenetworks#NetworkStatus", - "traits": { - "smithy.api#documentation": "

The status of the network.

", - "smithy.api#required": {} - } - }, - "statusReason": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

The status reason of the network.

" - } - }, - "createdAt": { - "target": "com.amazonaws.privatenetworks#Timestamp", - "traits": { - "smithy.api#documentation": "

The creation time of the network.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about a network.

" - } - }, - "com.amazonaws.privatenetworks#NetworkFilterKeys": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "name": "STATUS", - "value": "STATUS" - } - ] - } - }, - "com.amazonaws.privatenetworks#NetworkFilterValues": { - "type": "list", - "member": { - "target": "smithy.api#String" - } - }, - "com.amazonaws.privatenetworks#NetworkFilters": { - "type": "map", - "key": { - "target": "com.amazonaws.privatenetworks#NetworkFilterKeys" - }, - "value": { - "target": "com.amazonaws.privatenetworks#NetworkFilterValues" - } - }, - "com.amazonaws.privatenetworks#NetworkList": { - "type": "list", - "member": { - "target": "com.amazonaws.privatenetworks#Network" - } - }, - "com.amazonaws.privatenetworks#NetworkResource": { - "type": "structure", - "members": { - "networkResourceArn": { - "target": "com.amazonaws.privatenetworks#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the network resource.

" - } - }, - "description": { - "target": "com.amazonaws.privatenetworks#Description", - "traits": { - "smithy.api#documentation": "

The description of the network resource.

" - } - }, - "type": { - "target": "com.amazonaws.privatenetworks#NetworkResourceType", - "traits": { - "smithy.api#documentation": "

The type of the network resource.

" - } - }, - "status": { - "target": "com.amazonaws.privatenetworks#NetworkResourceStatus", - "traits": { - "smithy.api#documentation": "

The status of the network resource.

" - } - }, - "statusReason": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

The status reason of the network resource.

" - } - }, - "vendor": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

The vendor of the network resource.

" - } - }, - "model": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

The model of the network resource.

" - } - }, - "serialNumber": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

The serial number of the network resource.

" - } - }, - "health": { - "target": "com.amazonaws.privatenetworks#HealthStatus", - "traits": { - "smithy.api#documentation": "

The health of the network resource.

" - } - }, - "networkArn": { - "target": "com.amazonaws.privatenetworks#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the network on which this network resource\n appears.

" - } - }, - "networkSiteArn": { - "target": "com.amazonaws.privatenetworks#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the network site on which this network resource\n appears.

" - } - }, - "orderArn": { - "target": "com.amazonaws.privatenetworks#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the order used to purchase this network\n resource.

" - } - }, - "attributes": { - "target": "com.amazonaws.privatenetworks#NameValuePairs", - "traits": { - "smithy.api#documentation": "

The attributes of the network resource.

" - } - }, - "position": { - "target": "com.amazonaws.privatenetworks#Position", - "traits": { - "smithy.api#documentation": "

The position of the network resource.

" - } - }, - "createdAt": { - "target": "com.amazonaws.privatenetworks#Timestamp", - "traits": { - "smithy.api#documentation": "

The creation time of the network resource.

" - } - }, - "returnInformation": { - "target": "com.amazonaws.privatenetworks#ReturnInformation", - "traits": { - "smithy.api#documentation": "

Information about a request to return the network resource.

" - } - }, - "commitmentInformation": { - "target": "com.amazonaws.privatenetworks#CommitmentInformation", - "traits": { - "smithy.api#documentation": "

Information about the commitment period for the radio unit. Shows the duration, the\n date and time that the contract started and ends, and the renewal status of the\n commitment period.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about a network resource.

" - } - }, - "com.amazonaws.privatenetworks#NetworkResourceDefinition": { - "type": "structure", - "members": { - "type": { - "target": "com.amazonaws.privatenetworks#NetworkResourceDefinitionType", - "traits": { - "smithy.api#documentation": "

The type in the network resource definition.

", - "smithy.api#required": {} - } - }, - "options": { - "target": "com.amazonaws.privatenetworks#Options", - "traits": { - "smithy.api#documentation": "

The options in the network resource definition.

" - } - }, - "count": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "

The count in the network resource definition.

", - "smithy.api#range": { - "min": 0 - }, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about a network resource definition.

" - } - }, - "com.amazonaws.privatenetworks#NetworkResourceDefinitionType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "RADIO_UNIT", - "name": "RADIO_UNIT" - }, - { - "value": "DEVICE_IDENTIFIER", - "name": "DEVICE_IDENTIFIER" - } - ] - } - }, - "com.amazonaws.privatenetworks#NetworkResourceDefinitions": { - "type": "list", - "member": { - "target": "com.amazonaws.privatenetworks#NetworkResourceDefinition" - } - }, - "com.amazonaws.privatenetworks#NetworkResourceFilterKeys": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "name": "ORDER", - "value": "ORDER" - }, - { - "name": "STATUS", - "value": "STATUS" - } - ] - } - }, - "com.amazonaws.privatenetworks#NetworkResourceFilterValues": { - "type": "list", - "member": { - "target": "smithy.api#String" - } - }, - "com.amazonaws.privatenetworks#NetworkResourceFilters": { - "type": "map", - "key": { - "target": "com.amazonaws.privatenetworks#NetworkResourceFilterKeys" - }, - "value": { - "target": "com.amazonaws.privatenetworks#NetworkResourceFilterValues" - } - }, - "com.amazonaws.privatenetworks#NetworkResourceList": { - "type": "list", - "member": { - "target": "com.amazonaws.privatenetworks#NetworkResource" - } - }, - "com.amazonaws.privatenetworks#NetworkResourceStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "PENDING", - "name": "PENDING" - }, - { - "value": "SHIPPED", - "name": "SHIPPED" - }, - { - "value": "PROVISIONING", - "name": "PROVISIONING" - }, - { - "value": "PROVISIONED", - "name": "PROVISIONED" - }, - { - "value": "AVAILABLE", - "name": "AVAILABLE" - }, - { - "value": "DELETING", - "name": "DELETING" - }, - { - "value": "PENDING_RETURN", - "name": "PENDING_RETURN" - }, - { - "value": "DELETED", - "name": "DELETED" - }, - { - "value": "CREATING_SHIPPING_LABEL", - "name": "CREATING_SHIPPING_LABEL" - } - ] - } - }, - "com.amazonaws.privatenetworks#NetworkResourceType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "RADIO_UNIT", - "name": "RADIO_UNIT" - } - ] - } - }, - "com.amazonaws.privatenetworks#NetworkSite": { - "type": "structure", - "members": { - "networkSiteArn": { - "target": "com.amazonaws.privatenetworks#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the network site.

", - "smithy.api#required": {} - } - }, - "networkSiteName": { - "target": "com.amazonaws.privatenetworks#Name", - "traits": { - "smithy.api#documentation": "

The name of the network site.

", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.privatenetworks#Description", - "traits": { - "smithy.api#documentation": "

The description of the network site.

" - } - }, - "status": { - "target": "com.amazonaws.privatenetworks#NetworkSiteStatus", - "traits": { - "smithy.api#documentation": "

The status of the network site.

", - "smithy.api#required": {} - } - }, - "statusReason": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

The status reason of the network site.

" - } - }, - "networkArn": { - "target": "com.amazonaws.privatenetworks#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the network to which the network site\n belongs.

", - "smithy.api#required": {} - } - }, - "pendingPlan": { - "target": "com.amazonaws.privatenetworks#SitePlan", - "traits": { - "smithy.api#documentation": "

The pending plan of the network site.

" - } - }, - "currentPlan": { - "target": "com.amazonaws.privatenetworks#SitePlan", - "traits": { - "smithy.api#documentation": "

The current plan of the network site.

" - } - }, - "createdAt": { - "target": "com.amazonaws.privatenetworks#Timestamp", - "traits": { - "smithy.api#documentation": "

The creation time of the network site.

" - } - }, - "availabilityZone": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

The parent Availability Zone for the network site.

" - } - }, - "availabilityZoneId": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

The parent Availability Zone ID for the network site.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about a network site.

" - } - }, - "com.amazonaws.privatenetworks#NetworkSiteFilterKeys": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "name": "STATUS", - "value": "STATUS" - } - ] - } - }, - "com.amazonaws.privatenetworks#NetworkSiteFilterValues": { - "type": "list", - "member": { - "target": "smithy.api#String" - } - }, - "com.amazonaws.privatenetworks#NetworkSiteFilters": { - "type": "map", - "key": { - "target": "com.amazonaws.privatenetworks#NetworkSiteFilterKeys" - }, - "value": { - "target": "com.amazonaws.privatenetworks#NetworkSiteFilterValues" - } - }, - "com.amazonaws.privatenetworks#NetworkSiteList": { - "type": "list", - "member": { - "target": "com.amazonaws.privatenetworks#NetworkSite" - } - }, - "com.amazonaws.privatenetworks#NetworkSiteStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CREATED", - "name": "CREATED" - }, - { - "value": "PROVISIONING", - "name": "PROVISIONING" - }, - { - "value": "AVAILABLE", - "name": "AVAILABLE" - }, - { - "value": "DEPROVISIONING", - "name": "DEPROVISIONING" - }, - { - "value": "DELETED", - "name": "DELETED" - } - ] - } - }, - "com.amazonaws.privatenetworks#NetworkStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CREATED", - "name": "CREATED" - }, - { - "value": "PROVISIONING", - "name": "PROVISIONING" - }, - { - "value": "AVAILABLE", - "name": "AVAILABLE" - }, - { - "value": "DEPROVISIONING", - "name": "DEPROVISIONING" - }, - { - "value": "DELETED", - "name": "DELETED" - } - ] - } - }, - "com.amazonaws.privatenetworks#Options": { - "type": "list", - "member": { - "target": "com.amazonaws.privatenetworks#NameValuePair" - } - }, - "com.amazonaws.privatenetworks#Order": { - "type": "structure", - "members": { - "orderArn": { - "target": "com.amazonaws.privatenetworks#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the order.

" - } - }, - "shippingAddress": { - "target": "com.amazonaws.privatenetworks#Address", - "traits": { - "smithy.api#documentation": "

The shipping address of the order.

" - } - }, - "networkArn": { - "target": "com.amazonaws.privatenetworks#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the network associated with this order.

" - } - }, - "networkSiteArn": { - "target": "com.amazonaws.privatenetworks#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the network site associated with this order.

" - } - }, - "trackingInformation": { - "target": "com.amazonaws.privatenetworks#TrackingInformationList", - "traits": { - "smithy.api#documentation": "

The tracking information of the order.

" - } - }, - "acknowledgmentStatus": { - "target": "com.amazonaws.privatenetworks#AcknowledgmentStatus", - "traits": { - "smithy.api#documentation": "

The acknowledgement status of the order.

" - } - }, - "createdAt": { - "target": "com.amazonaws.privatenetworks#Timestamp", - "traits": { - "smithy.api#documentation": "

The creation time of the order.

" - } - }, - "orderedResources": { - "target": "com.amazonaws.privatenetworks#OrderedResourceDefinitions", - "traits": { - "smithy.api#documentation": "

A list of the network resources placed in the order.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about an order.

" - } - }, - "com.amazonaws.privatenetworks#OrderFilterKeys": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "name": "STATUS", - "value": "STATUS" - }, - { - "name": "NETWORK_SITE", - "value": "NETWORK_SITE" - } - ] - } - }, - "com.amazonaws.privatenetworks#OrderFilterValues": { - "type": "list", - "member": { - "target": "smithy.api#String" - } - }, - "com.amazonaws.privatenetworks#OrderFilters": { - "type": "map", - "key": { - "target": "com.amazonaws.privatenetworks#OrderFilterKeys" - }, - "value": { - "target": "com.amazonaws.privatenetworks#OrderFilterValues" - } - }, - "com.amazonaws.privatenetworks#OrderList": { - "type": "list", - "member": { - "target": "com.amazonaws.privatenetworks#Order" - } - }, - "com.amazonaws.privatenetworks#OrderedResourceDefinition": { - "type": "structure", - "members": { - "type": { - "target": "com.amazonaws.privatenetworks#NetworkResourceDefinitionType", - "traits": { - "smithy.api#documentation": "

The type of network resource in the order.

", - "smithy.api#required": {} - } - }, - "count": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "

The number of network resources in the order.

", - "smithy.api#range": { - "min": 0 - }, - "smithy.api#required": {} - } - }, - "commitmentConfiguration": { - "target": "com.amazonaws.privatenetworks#CommitmentConfiguration", - "traits": { - "smithy.api#documentation": "

The duration and renewal status of the commitment period for each radio unit in the\n order. Does not show details if the resource type is DEVICE_IDENTIFIER.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Details of the network resources in the order.

" - } - }, - "com.amazonaws.privatenetworks#OrderedResourceDefinitions": { - "type": "list", - "member": { - "target": "com.amazonaws.privatenetworks#OrderedResourceDefinition" - } - }, - "com.amazonaws.privatenetworks#PaginationToken": { - "type": "string" - }, - "com.amazonaws.privatenetworks#Ping": { - "type": "operation", - "input": { - "target": "smithy.api#Unit" - }, - "output": { - "target": "com.amazonaws.privatenetworks#PingResponse" - }, - "errors": [ - { - "target": "com.amazonaws.privatenetworks#InternalServerException" - } - ], - "traits": { - "smithy.api#documentation": "

Checks the health of the service.

", - "smithy.api#http": { - "uri": "/ping", - "method": "GET", - "code": 200 - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.privatenetworks#PingResponse": { - "type": "structure", - "members": { - "status": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

Information about the health of the service.

" - } - } - } - }, - "com.amazonaws.privatenetworks#Position": { - "type": "structure", - "members": { - "latitude": { - "target": "smithy.api#Double", - "traits": { - "smithy.api#documentation": "

The latitude of the position.

" - } - }, - "longitude": { - "target": "smithy.api#Double", - "traits": { - "smithy.api#documentation": "

The longitude of the position.

" - } - }, - "elevation": { - "target": "smithy.api#Double", - "traits": { - "smithy.api#documentation": "

The elevation of the equipment at this position.

" - } - }, - "elevationUnit": { - "target": "com.amazonaws.privatenetworks#ElevationUnit", - "traits": { - "smithy.api#documentation": "

The units used to measure the elevation of the position.

" - } - }, - "elevationReference": { - "target": "com.amazonaws.privatenetworks#ElevationReference", - "traits": { - "smithy.api#documentation": "

The reference point from which elevation is reported.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about a position.

" - } - }, - "com.amazonaws.privatenetworks#ResourceNotFoundException": { - "type": "structure", - "members": { - "message": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "Description of the error.", - "smithy.api#required": {} - } - }, - "resourceId": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "Identifier of the affected resource.", - "smithy.api#required": {} - } - }, - "resourceType": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "Type of the affected resource.", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The resource was not found.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.privatenetworks#ReturnInformation": { - "type": "structure", - "members": { - "shippingAddress": { - "target": "com.amazonaws.privatenetworks#Address", - "traits": { - "smithy.api#documentation": "

The shipping address.

" - } - }, - "returnReason": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

The reason for the return. If the return request did not include a reason for the\n return, this value is null.

" - } - }, - "replacementOrderArn": { - "target": "com.amazonaws.privatenetworks#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the replacement order.

" - } - }, - "shippingLabel": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

The URL of the shipping label. The shipping label is available for download only if\n the status of the network resource is PENDING_RETURN. For more information,\n see Return a\n radio unit.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about a request to return a network resource.

" - } - }, - "com.amazonaws.privatenetworks#SensitiveString": { - "type": "string", - "traits": { - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.privatenetworks#SitePlan": { - "type": "structure", - "members": { - "resourceDefinitions": { - "target": "com.amazonaws.privatenetworks#NetworkResourceDefinitions", - "traits": { - "smithy.api#documentation": "

The resource definitions of the plan.

" - } - }, - "options": { - "target": "com.amazonaws.privatenetworks#Options", - "traits": { - "smithy.api#documentation": "

The options of the plan.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about a site plan.

" - } - }, - "com.amazonaws.privatenetworks#StartNetworkResourceUpdate": { - "type": "operation", - "input": { - "target": "com.amazonaws.privatenetworks#StartNetworkResourceUpdateRequest" - }, - "output": { - "target": "com.amazonaws.privatenetworks#StartNetworkResourceUpdateResponse" - }, - "errors": [ - { - "target": "com.amazonaws.privatenetworks#InternalServerException" - }, - { - "target": "com.amazonaws.privatenetworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.privatenetworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Use this action to do the following tasks:

\n \n

After you submit a request to replace or return a network resource, the status of the\n network resource changes to CREATING_SHIPPING_LABEL. The shipping label is\n available when the status of the network resource is PENDING_RETURN. After\n the network resource is successfully returned, its status changes to\n DELETED. For more information, see Return a radio unit.

", - "smithy.api#http": { - "uri": "/v1/network-resources/update", - "method": "POST", - "code": 200 - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.privatenetworks#StartNetworkResourceUpdateRequest": { - "type": "structure", - "members": { - "networkResourceArn": { - "target": "com.amazonaws.privatenetworks#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the network resource.

", - "smithy.api#required": {} - } - }, - "updateType": { - "target": "com.amazonaws.privatenetworks#UpdateType", - "traits": { - "smithy.api#documentation": "

The update type.

\n ", - "smithy.api#required": {} - } - }, - "shippingAddress": { - "target": "com.amazonaws.privatenetworks#Address", - "traits": { - "smithy.api#documentation": "

The shipping address. If you don't provide a shipping address when replacing or\n returning a network resource, we use the address from the original order for the network\n resource.

" - } - }, - "returnReason": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

The reason for the return. Providing a reason for a return is optional.

", - "smithy.api#length": { - "min": 0, - "max": 1000 - } - } - }, - "commitmentConfiguration": { - "target": "com.amazonaws.privatenetworks#CommitmentConfiguration", - "traits": { - "smithy.api#documentation": "

Use this action to extend and automatically renew the commitment period for the radio\n unit. You can do the following:

\n \n

For pricing, see Amazon Web Services Private 5G\n Pricing.

" - } - } - } - }, - "com.amazonaws.privatenetworks#StartNetworkResourceUpdateResponse": { - "type": "structure", - "members": { - "networkResource": { - "target": "com.amazonaws.privatenetworks#NetworkResource", - "traits": { - "smithy.api#documentation": "

The network resource.

" - } - } - } - }, - "com.amazonaws.privatenetworks#TagKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - }, - "smithy.api#pattern": "^(?!aws:)[^\\x00-\\x1f\\x22]+$" - } - }, - "com.amazonaws.privatenetworks#TagKeyList": { - "type": "list", - "member": { - "target": "com.amazonaws.privatenetworks#TagKey" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - }, - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.privatenetworks#TagMap": { - "type": "map", - "key": { - "target": "com.amazonaws.privatenetworks#TagKey" - }, - "value": { - "target": "com.amazonaws.privatenetworks#TagValue" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - }, - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.privatenetworks#TagResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.privatenetworks#TagResourceRequest" - }, - "output": { - "target": "com.amazonaws.privatenetworks#TagResourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.privatenetworks#AccessDeniedException" - }, - { - "target": "com.amazonaws.privatenetworks#InternalServerException" - }, - { - "target": "com.amazonaws.privatenetworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.privatenetworks#ThrottlingException" - }, - { - "target": "com.amazonaws.privatenetworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Adds tags to the specified resource.

", - "smithy.api#http": { - "method": "POST", - "uri": "/tags/{resourceArn}", - "code": 200 - } - } - }, - "com.amazonaws.privatenetworks#TagResourceRequest": { - "type": "structure", - "members": { - "resourceArn": { - "target": "com.amazonaws.privatenetworks#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "tags": { - "target": "com.amazonaws.privatenetworks#TagMap", - "traits": { - "smithy.api#documentation": "

The tags to add to the resource.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.privatenetworks#TagResourceResponse": { - "type": "structure", - "members": {} - }, - "com.amazonaws.privatenetworks#TagValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - }, - "smithy.api#pattern": "^[^\\x00-\\x1f\\x22]*$" - } - }, - "com.amazonaws.privatenetworks#ThrottlingException": { - "type": "structure", - "members": { - "message": { - "target": "smithy.api#String" - } - }, - "traits": { - "smithy.api#documentation": "

The request was denied due to request throttling.

", - "smithy.api#error": "client", - "smithy.api#httpError": 429, - "smithy.api#retryable": { - "throttling": true - } - } - }, - "com.amazonaws.privatenetworks#Timestamp": { - "type": "timestamp", - "traits": { - "smithy.api#timestampFormat": "date-time" - } - }, - "com.amazonaws.privatenetworks#TrackingInformation": { - "type": "structure", - "members": { - "trackingNumber": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

The tracking number of the shipment.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about tracking a shipment.

" - } - }, - "com.amazonaws.privatenetworks#TrackingInformationList": { - "type": "list", - "member": { - "target": "com.amazonaws.privatenetworks#TrackingInformation" - } - }, - "com.amazonaws.privatenetworks#UntagResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.privatenetworks#UntagResourceRequest" - }, - "output": { - "target": "com.amazonaws.privatenetworks#UntagResourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.privatenetworks#AccessDeniedException" - }, - { - "target": "com.amazonaws.privatenetworks#InternalServerException" - }, - { - "target": "com.amazonaws.privatenetworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.privatenetworks#ThrottlingException" - }, - { - "target": "com.amazonaws.privatenetworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Removes tags from the specified resource.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/tags/{resourceArn}", - "code": 200 - } - } - }, - "com.amazonaws.privatenetworks#UntagResourceRequest": { - "type": "structure", - "members": { - "resourceArn": { - "target": "com.amazonaws.privatenetworks#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "tagKeys": { - "target": "com.amazonaws.privatenetworks#TagKeyList", - "traits": { - "smithy.api#documentation": "

The tag keys.

", - "smithy.api#httpQuery": "tagKeys", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.privatenetworks#UntagResourceResponse": { - "type": "structure", - "members": {} - }, - "com.amazonaws.privatenetworks#UpdateNetworkSite": { - "type": "operation", - "input": { - "target": "com.amazonaws.privatenetworks#UpdateNetworkSiteRequest" - }, - "output": { - "target": "com.amazonaws.privatenetworks#UpdateNetworkSiteResponse" - }, - "errors": [ - { - "target": "com.amazonaws.privatenetworks#InternalServerException" - }, - { - "target": "com.amazonaws.privatenetworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.privatenetworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates the specified network site.

", - "smithy.api#http": { - "uri": "/v1/network-sites/site", - "method": "PUT", - "code": 200 - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.privatenetworks#UpdateNetworkSitePlan": { - "type": "operation", - "input": { - "target": "com.amazonaws.privatenetworks#UpdateNetworkSitePlanRequest" - }, - "output": { - "target": "com.amazonaws.privatenetworks#UpdateNetworkSiteResponse" - }, - "errors": [ - { - "target": "com.amazonaws.privatenetworks#InternalServerException" - }, - { - "target": "com.amazonaws.privatenetworks#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.privatenetworks#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates the specified network site plan.

", - "smithy.api#http": { - "uri": "/v1/network-sites/plan", - "method": "PUT", - "code": 200 - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.privatenetworks#UpdateNetworkSitePlanRequest": { - "type": "structure", - "members": { - "networkSiteArn": { - "target": "com.amazonaws.privatenetworks#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the network site.

", - "smithy.api#required": {} - } - }, - "pendingPlan": { - "target": "com.amazonaws.privatenetworks#SitePlan", - "traits": { - "smithy.api#documentation": "

The pending plan.

", - "smithy.api#required": {} - } - }, - "clientToken": { - "target": "com.amazonaws.privatenetworks#ClientToken", - "traits": { - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. For more information, see How to ensure\n idempotency.

" - } - } - } - }, - "com.amazonaws.privatenetworks#UpdateNetworkSiteRequest": { - "type": "structure", - "members": { - "networkSiteArn": { - "target": "com.amazonaws.privatenetworks#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the network site.

", - "smithy.api#required": {} - } - }, - "clientToken": { - "target": "com.amazonaws.privatenetworks#ClientToken", - "traits": { - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. For more information, see How to ensure\n idempotency.

" - } - }, - "description": { - "target": "com.amazonaws.privatenetworks#Description", - "traits": { - "smithy.api#documentation": "

The description.

" - } - } - } - }, - "com.amazonaws.privatenetworks#UpdateNetworkSiteResponse": { - "type": "structure", - "members": { - "networkSite": { - "target": "com.amazonaws.privatenetworks#NetworkSite", - "traits": { - "smithy.api#documentation": "

Information about the network site.

" - } - }, - "tags": { - "target": "com.amazonaws.privatenetworks#TagMap", - "traits": { - "smithy.api#documentation": "

The network site tags.

" - } - } - } - }, - "com.amazonaws.privatenetworks#UpdateType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "REPLACE", - "name": "REPLACE" - }, - { - "value": "RETURN", - "name": "RETURN" - }, - { - "value": "COMMITMENT", - "name": "COMMITMENT" - } - ] - } - }, - "com.amazonaws.privatenetworks#ValidationException": { - "type": "structure", - "members": { - "message": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "Description of the error.", - "smithy.api#required": {} - } - }, - "reason": { - "target": "com.amazonaws.privatenetworks#ValidationExceptionReason", - "traits": { - "smithy.api#documentation": "Reason the request failed validation.", - "smithy.api#required": {} - } - }, - "fieldList": { - "target": "com.amazonaws.privatenetworks#ValidationExceptionFieldList", - "traits": { - "smithy.api#documentation": "The list of fields that caused the error, if applicable." - } - } - }, - "traits": { - "smithy.api#documentation": "

The request failed validation.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.privatenetworks#ValidationExceptionField": { - "type": "structure", - "members": { - "name": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

The field name that failed validation.

", - "smithy.api#required": {} - } - }, - "message": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

The message about the validation failure.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about a field that failed validation.

" - } - }, - "com.amazonaws.privatenetworks#ValidationExceptionFieldList": { - "type": "list", - "member": { - "target": "com.amazonaws.privatenetworks#ValidationExceptionField" - } - }, - "com.amazonaws.privatenetworks#ValidationExceptionReason": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "UNKNOWN_OPERATION", - "name": "UNKNOWN_OPERATION" - }, - { - "value": "CANNOT_PARSE", - "name": "CANNOT_PARSE" - }, - { - "value": "CANNOT_ASSUME_ROLE", - "name": "CANNOT_ASSUME_ROLE" - }, - { - "value": "FIELD_VALIDATION_FAILED", - "name": "FIELD_VALIDATION_FAILED" - }, - { - "value": "OTHER", - "name": "OTHER" - } - ] - } - } - } -} \ No newline at end of file