From 778fc07ceaef85f0ce5602153f0acecc880f8616 Mon Sep 17 00:00:00 2001 From: awstools Date: Thu, 23 May 2024 18:06:30 +0000 Subject: [PATCH] chore(models): update API models --- .../aws-models/emr-serverless.json | 7247 +++--- codegen/sdk-codegen/aws-models/opsworks.json | 18932 ++++++++-------- 2 files changed, 13111 insertions(+), 13068 deletions(-) diff --git a/codegen/sdk-codegen/aws-models/emr-serverless.json b/codegen/sdk-codegen/aws-models/emr-serverless.json index aab6836c975b..f247780feeb8 100644 --- a/codegen/sdk-codegen/aws-models/emr-serverless.json +++ b/codegen/sdk-codegen/aws-models/emr-serverless.json @@ -1,3649 +1,3692 @@ { - "smithy": "2.0", - "shapes": { - "com.amazonaws.emrserverless#Application": { - "type": "structure", - "members": { - "applicationId": { - "target": "com.amazonaws.emrserverless#ApplicationId", - "traits": { - "smithy.api#documentation": "

The ID of the application.

", - "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "applicationId" - } - }, - "name": { - "target": "com.amazonaws.emrserverless#ApplicationName", - "traits": { - "smithy.api#documentation": "

The name of the application.

" - } - }, - "arn": { - "target": "com.amazonaws.emrserverless#ApplicationArn", - "traits": { - "smithy.api#documentation": "

The ARN of the application.

", - "smithy.api#required": {} - } - }, - "releaseLabel": { - "target": "com.amazonaws.emrserverless#ReleaseLabel", - "traits": { - "smithy.api#documentation": "

The Amazon EMR release associated with the application.

", - "smithy.api#required": {} - } - }, - "type": { - "target": "com.amazonaws.emrserverless#EngineType", - "traits": { - "smithy.api#documentation": "

The type of application, such as Spark or Hive.

", - "smithy.api#required": {} - } - }, - "state": { - "target": "com.amazonaws.emrserverless#ApplicationState", - "traits": { - "smithy.api#documentation": "

The state of the application.

", - "smithy.api#required": {} - } - }, - "stateDetails": { - "target": "com.amazonaws.emrserverless#String256", - "traits": { - "smithy.api#documentation": "

The state details of the application.

" - } - }, - "initialCapacity": { - "target": "com.amazonaws.emrserverless#InitialCapacityConfigMap", - "traits": { - "smithy.api#documentation": "

The initial capacity of the application.

" - } - }, - "maximumCapacity": { - "target": "com.amazonaws.emrserverless#MaximumAllowedResources", - "traits": { - "smithy.api#documentation": "

The maximum capacity of the application. This is cumulative across all workers at any\n given point in time during the lifespan of the application is created. No new resources\n will be created once any one of the defined limits is hit.

" - } - }, - "createdAt": { - "target": "com.amazonaws.emrserverless#Date", - "traits": { - "smithy.api#documentation": "

The date and time when the application run was created.

", - "smithy.api#required": {} - } - }, - "updatedAt": { - "target": "com.amazonaws.emrserverless#Date", - "traits": { - "smithy.api#documentation": "

The date and time when the application run was last updated.

", - "smithy.api#required": {} - } - }, - "tags": { - "target": "com.amazonaws.emrserverless#TagMap", - "traits": { - "smithy.api#documentation": "

The tags assigned to the application.

" - } - }, - "autoStartConfiguration": { - "target": "com.amazonaws.emrserverless#AutoStartConfig", - "traits": { - "smithy.api#documentation": "

The configuration for an application to automatically start on job submission.

" - } - }, - "autoStopConfiguration": { - "target": "com.amazonaws.emrserverless#AutoStopConfig", - "traits": { - "smithy.api#documentation": "

The configuration for an application to automatically stop after a certain amount of\n time being idle.

" - } - }, - "networkConfiguration": { - "target": "com.amazonaws.emrserverless#NetworkConfiguration", - "traits": { - "smithy.api#documentation": "

The network configuration for customer VPC connectivity for the application.

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

The CPU architecture of an application.

" - } - }, - "imageConfiguration": { - "target": "com.amazonaws.emrserverless#ImageConfiguration", - "traits": { - "smithy.api#documentation": "

The image configuration applied to all worker types.

" - } - }, - "workerTypeSpecifications": { - "target": "com.amazonaws.emrserverless#WorkerTypeSpecificationMap", - "traits": { - "smithy.api#documentation": "

The specification applied to each worker type.

" - } - }, - "runtimeConfiguration": { - "target": "com.amazonaws.emrserverless#ConfigurationList", - "traits": { - "smithy.api#documentation": "

The Configuration \n specifications of an application. Each configuration consists of a classification and properties. You use this \n parameter when creating or updating an application. To see the runtimeConfiguration object of an application,\n run the GetApplication API operation.

" - } - }, - "monitoringConfiguration": { - "target": "com.amazonaws.emrserverless#MonitoringConfiguration" - } - }, - "traits": { - "smithy.api#documentation": "

Information about an application. Amazon EMR Serverless uses applications to run\n jobs.

" - } - }, - "com.amazonaws.emrserverless#ApplicationArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 60, - "max": 1024 - }, - "smithy.api#pattern": "^arn:(aws[a-zA-Z0-9-]*):emr-serverless:.+:(\\d{12}):\\/applications\\/[0-9a-zA-Z]+$" - } - }, - "com.amazonaws.emrserverless#ApplicationId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - }, - "smithy.api#pattern": "^[0-9a-z]+$" - } - }, - "com.amazonaws.emrserverless#ApplicationList": { - "type": "list", - "member": { - "target": "com.amazonaws.emrserverless#ApplicationSummary" - } - }, - "com.amazonaws.emrserverless#ApplicationName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - }, - "smithy.api#pattern": "^[A-Za-z0-9._/#-]+$" - } - }, - "com.amazonaws.emrserverless#ApplicationResource": { - "type": "resource", - "identifiers": { - "applicationId": { - "target": "com.amazonaws.emrserverless#ApplicationId" - } - }, - "create": { - "target": "com.amazonaws.emrserverless#CreateApplication" - }, - "read": { - "target": "com.amazonaws.emrserverless#GetApplication" - }, - "update": { - "target": "com.amazonaws.emrserverless#UpdateApplication" - }, - "delete": { - "target": "com.amazonaws.emrserverless#DeleteApplication" - }, - "list": { - "target": "com.amazonaws.emrserverless#ListApplications" - }, - "operations": [ - { - "target": "com.amazonaws.emrserverless#StartApplication" - }, - { - "target": "com.amazonaws.emrserverless#StopApplication" - } - ], - "traits": { - "aws.cloudformation#cfnResource": { - "name": "Application" - } - } - }, - "com.amazonaws.emrserverless#ApplicationState": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "CREATING", - "name": "CREATING" - }, - { - "value": "CREATED", - "name": "CREATED" - }, - { - "value": "STARTING", - "name": "STARTING" - }, - { - "value": "STARTED", - "name": "STARTED" - }, - { - "value": "STOPPING", - "name": "STOPPING" - }, - { - "value": "STOPPED", - "name": "STOPPED" - }, - { - "value": "TERMINATED", - "name": "TERMINATED" - } - ] - } - }, - "com.amazonaws.emrserverless#ApplicationStateSet": { - "type": "list", - "member": { - "target": "com.amazonaws.emrserverless#ApplicationState" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 7 - }, - "smithy.api#uniqueItems": {} - } - }, - "com.amazonaws.emrserverless#ApplicationSummary": { - "type": "structure", - "members": { - "id": { - "target": "com.amazonaws.emrserverless#ApplicationId", - "traits": { - "smithy.api#documentation": "

The ID of the application.

", - "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "applicationId" - } - }, - "name": { - "target": "com.amazonaws.emrserverless#ApplicationName", - "traits": { - "smithy.api#documentation": "

The name of the application.

" - } - }, - "arn": { - "target": "com.amazonaws.emrserverless#ApplicationArn", - "traits": { - "smithy.api#documentation": "

The ARN of the application.

", - "smithy.api#required": {} - } - }, - "releaseLabel": { - "target": "com.amazonaws.emrserverless#ReleaseLabel", - "traits": { - "smithy.api#documentation": "

The Amazon EMR release associated with the application.

", - "smithy.api#required": {} - } - }, - "type": { - "target": "com.amazonaws.emrserverless#EngineType", - "traits": { - "smithy.api#documentation": "

The type of application, such as Spark or Hive.

", - "smithy.api#required": {} - } - }, - "state": { - "target": "com.amazonaws.emrserverless#ApplicationState", - "traits": { - "smithy.api#documentation": "

The state of the application.

", - "smithy.api#required": {} - } - }, - "stateDetails": { - "target": "com.amazonaws.emrserverless#String256", - "traits": { - "smithy.api#documentation": "

The state details of the application.

" - } - }, - "createdAt": { - "target": "com.amazonaws.emrserverless#Date", - "traits": { - "smithy.api#documentation": "

The date and time when the application was created.

", - "smithy.api#required": {} - } - }, - "updatedAt": { - "target": "com.amazonaws.emrserverless#Date", - "traits": { - "smithy.api#documentation": "

The date and time when the application was last updated.

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

The CPU architecture of an application.

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

The summary of attributes associated with an application.

" - } - }, - "com.amazonaws.emrserverless#Architecture": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "ARM64", - "name": "ARM64" - }, - { - "value": "X86_64", - "name": "X86_64" - } - ] - } - }, - "com.amazonaws.emrserverless#AutoStartConfig": { - "type": "structure", - "members": { - "enabled": { - "target": "smithy.api#Boolean", - "traits": { - "smithy.api#documentation": "

Enables the application to automatically start on job submission. Defaults to\n true.

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

The configuration for an application to automatically start on job submission.

" - } - }, - "com.amazonaws.emrserverless#AutoStopConfig": { - "type": "structure", - "members": { - "enabled": { - "target": "smithy.api#Boolean", - "traits": { - "smithy.api#documentation": "

Enables the application to automatically stop after a certain amount of time being idle.\n Defaults to true.

" - } - }, - "idleTimeoutMinutes": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The amount of idle time in minutes after which your application will automatically stop.\n Defaults to 15 minutes.

", - "smithy.api#range": { - "min": 1, - "max": 10080 - } - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration for an application to automatically stop after a certain amount of\n time being idle.

" - } - }, - "com.amazonaws.emrserverless#AwsToledoWebService": { - "type": "service", - "version": "2021-07-13", - "operations": [ - { - "target": "com.amazonaws.emrserverless#ListTagsForResource" - }, - { - "target": "com.amazonaws.emrserverless#TagResource" - }, - { - "target": "com.amazonaws.emrserverless#UntagResource" - } - ], - "resources": [ - { - "target": "com.amazonaws.emrserverless#ApplicationResource" - }, - { - "target": "com.amazonaws.emrserverless#JobRunResource" - } - ], - "traits": { - "aws.api#service": { - "sdkId": "EMR Serverless", - "arnNamespace": "emr-serverless", - "cloudFormationName": "EMRServerless" - }, - "aws.auth#sigv4": { - "name": "emr-serverless" - }, - "aws.protocols#restJson1": {}, - "smithy.api#cors": { - "additionalAllowedHeaders": [ - "*", - "Authorization", - "Date", - "X-Amz-Date", - "X-Amz-Security-Token", - "X-Amz-Target", - "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", "x-amz-apigw-id"] - }, - "smithy.api#documentation": "

Amazon EMR Serverless is a new deployment option for Amazon EMR. Amazon EMR Serverless provides a serverless runtime environment that simplifies running\n analytics applications using the latest open source frameworks such as Apache Spark and\n Apache Hive. With Amazon EMR Serverless, you don’t have to configure, optimize,\n secure, or operate clusters to run applications with these frameworks.

\n

The API reference to Amazon EMR Serverless is emr-serverless. The\n emr-serverless prefix is used in the following scenarios:

\n ", - "smithy.api#title": "EMR Serverless", - "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" + "smithy": "2.0", + "shapes": { + "com.amazonaws.emrserverless#Application": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.emrserverless#ApplicationId", + "traits": { + "smithy.api#documentation": "

The ID of the application.

", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "applicationId" + } + }, + "name": { + "target": "com.amazonaws.emrserverless#ApplicationName", + "traits": { + "smithy.api#documentation": "

The name of the application.

" + } + }, + "arn": { + "target": "com.amazonaws.emrserverless#ApplicationArn", + "traits": { + "smithy.api#documentation": "

The ARN of the application.

", + "smithy.api#required": {} + } + }, + "releaseLabel": { + "target": "com.amazonaws.emrserverless#ReleaseLabel", + "traits": { + "smithy.api#documentation": "

The Amazon EMR release associated with the application.

", + "smithy.api#required": {} + } + }, + "type": { + "target": "com.amazonaws.emrserverless#EngineType", + "traits": { + "smithy.api#documentation": "

The type of application, such as Spark or Hive.

", + "smithy.api#required": {} + } + }, + "state": { + "target": "com.amazonaws.emrserverless#ApplicationState", + "traits": { + "smithy.api#documentation": "

The state of the application.

", + "smithy.api#required": {} + } + }, + "stateDetails": { + "target": "com.amazonaws.emrserverless#String256", + "traits": { + "smithy.api#documentation": "

The state details of the application.

" + } + }, + "initialCapacity": { + "target": "com.amazonaws.emrserverless#InitialCapacityConfigMap", + "traits": { + "smithy.api#documentation": "

The initial capacity of the application.

" + } + }, + "maximumCapacity": { + "target": "com.amazonaws.emrserverless#MaximumAllowedResources", + "traits": { + "smithy.api#documentation": "

The maximum capacity of the application. This is cumulative across all workers at any\n given point in time during the lifespan of the application is created. No new resources\n will be created once any one of the defined limits is hit.

" + } + }, + "createdAt": { + "target": "com.amazonaws.emrserverless#Date", + "traits": { + "smithy.api#documentation": "

The date and time when the application run was created.

", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.emrserverless#Date", + "traits": { + "smithy.api#documentation": "

The date and time when the application run was last updated.

", + "smithy.api#required": {} } - ] + }, + "tags": { + "target": "com.amazonaws.emrserverless#TagMap", + "traits": { + "smithy.api#documentation": "

The tags assigned to the application.

" + } + }, + "autoStartConfiguration": { + "target": "com.amazonaws.emrserverless#AutoStartConfig", + "traits": { + "smithy.api#documentation": "

The configuration for an application to automatically start on job submission.

" + } + }, + "autoStopConfiguration": { + "target": "com.amazonaws.emrserverless#AutoStopConfig", + "traits": { + "smithy.api#documentation": "

The configuration for an application to automatically stop after a certain amount of\n time being idle.

" + } + }, + "networkConfiguration": { + "target": "com.amazonaws.emrserverless#NetworkConfiguration", + "traits": { + "smithy.api#documentation": "

The network configuration for customer VPC connectivity for the application.

" + } + }, + "architecture": { + "target": "com.amazonaws.emrserverless#Architecture", + "traits": { + "smithy.api#documentation": "

The CPU architecture of an application.

" + } + }, + "imageConfiguration": { + "target": "com.amazonaws.emrserverless#ImageConfiguration", + "traits": { + "smithy.api#documentation": "

The image configuration applied to all worker types.

" + } + }, + "workerTypeSpecifications": { + "target": "com.amazonaws.emrserverless#WorkerTypeSpecificationMap", + "traits": { + "smithy.api#documentation": "

The specification applied to each worker type.

" + } + }, + "runtimeConfiguration": { + "target": "com.amazonaws.emrserverless#ConfigurationList", + "traits": { + "smithy.api#documentation": "

The Configuration \n specifications of an application. Each configuration consists of a classification and properties. You use this \n parameter when creating or updating an application. To see the runtimeConfiguration object of an application,\n run the GetApplication API operation.

" + } + }, + "monitoringConfiguration": { + "target": "com.amazonaws.emrserverless#MonitoringConfiguration" + }, + "interactiveConfiguration": { + "target": "com.amazonaws.emrserverless#InteractiveConfiguration", + "traits": { + "smithy.api#documentation": "

The interactive configuration object that enables the interactive use cases for an application.

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

Information about an application. Amazon EMR Serverless uses applications to run\n jobs.

" + } + }, + "com.amazonaws.emrserverless#ApplicationArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 60, + "max": 1024 + }, + "smithy.api#pattern": "^arn:(aws[a-zA-Z0-9-]*):emr-serverless:.+:(\\d{12}):\\/applications\\/[0-9a-zA-Z]+$" + } + }, + "com.amazonaws.emrserverless#ApplicationId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[0-9a-z]+$" + } + }, + "com.amazonaws.emrserverless#ApplicationList": { + "type": "list", + "member": { + "target": "com.amazonaws.emrserverless#ApplicationSummary" + } + }, + "com.amazonaws.emrserverless#ApplicationName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[A-Za-z0-9._/#-]+$" + } + }, + "com.amazonaws.emrserverless#ApplicationResource": { + "type": "resource", + "identifiers": { + "applicationId": { + "target": "com.amazonaws.emrserverless#ApplicationId" } - ], - "rules": [ + }, + "create": { + "target": "com.amazonaws.emrserverless#CreateApplication" + }, + "read": { + "target": "com.amazonaws.emrserverless#GetApplication" + }, + "update": { + "target": "com.amazonaws.emrserverless#UpdateApplication" + }, + "delete": { + "target": "com.amazonaws.emrserverless#DeleteApplication" + }, + "list": { + "target": "com.amazonaws.emrserverless#ListApplications" + }, + "operations": [ { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "error": "Invalid Configuration: FIPS and custom endpoint are not supported", - "type": "error" + "target": "com.amazonaws.emrserverless#StartApplication" }, { - "conditions": [ + "target": "com.amazonaws.emrserverless#StopApplication" + } + ], + "traits": { + "aws.cloudformation#cfnResource": { + "name": "Application" + } + } + }, + "com.amazonaws.emrserverless#ApplicationState": { + "type": "string", + "traits": { + "smithy.api#enum": [ { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] + "value": "CREATING", + "name": "CREATING" + }, + { + "value": "CREATED", + "name": "CREATED" + }, + { + "value": "STARTING", + "name": "STARTING" + }, + { + "value": "STARTED", + "name": "STARTED" + }, + { + "value": "STOPPING", + "name": "STOPPING" + }, + { + "value": "STOPPED", + "name": "STOPPED" + }, + { + "value": "TERMINATED", + "name": "TERMINATED" + } + ] + } + }, + "com.amazonaws.emrserverless#ApplicationStateSet": { + "type": "list", + "member": { + "target": "com.amazonaws.emrserverless#ApplicationState" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 7 + }, + "smithy.api#uniqueItems": {} + } + }, + "com.amazonaws.emrserverless#ApplicationSummary": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.emrserverless#ApplicationId", + "traits": { + "smithy.api#documentation": "

The ID of the application.

", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "applicationId" } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" - }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" + "name": { + "target": "com.amazonaws.emrserverless#ApplicationName", + "traits": { + "smithy.api#documentation": "

The name of the application.

" + } + }, + "arn": { + "target": "com.amazonaws.emrserverless#ApplicationArn", + "traits": { + "smithy.api#documentation": "

The ARN of the application.

", + "smithy.api#required": {} + } + }, + "releaseLabel": { + "target": "com.amazonaws.emrserverless#ReleaseLabel", + "traits": { + "smithy.api#documentation": "

The Amazon EMR release associated with the application.

", + "smithy.api#required": {} + } + }, + "type": { + "target": "com.amazonaws.emrserverless#EngineType", + "traits": { + "smithy.api#documentation": "

The type of application, such as Spark or Hive.

", + "smithy.api#required": {} + } + }, + "state": { + "target": "com.amazonaws.emrserverless#ApplicationState", + "traits": { + "smithy.api#documentation": "

The state of the application.

", + "smithy.api#required": {} + } + }, + "stateDetails": { + "target": "com.amazonaws.emrserverless#String256", + "traits": { + "smithy.api#documentation": "

The state details of the application.

" + } + }, + "createdAt": { + "target": "com.amazonaws.emrserverless#Date", + "traits": { + "smithy.api#documentation": "

The date and time when the application was created.

", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.emrserverless#Date", + "traits": { + "smithy.api#documentation": "

The date and time when the application was last updated.

", + "smithy.api#required": {} + } + }, + "architecture": { + "target": "com.amazonaws.emrserverless#Architecture", + "traits": { + "smithy.api#documentation": "

The CPU architecture of an application.

" + } } - ], - "type": "tree" }, - { - "conditions": [ - { - "fn": "isSet", - "argv": [ + "traits": { + "smithy.api#documentation": "

The summary of attributes associated with an application.

" + } + }, + "com.amazonaws.emrserverless#Architecture": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ARM64", + "name": "ARM64" + }, { - "ref": "Region" + "value": "X86_64", + "name": "X86_64" + } + ] + } + }, + "com.amazonaws.emrserverless#AutoStartConfig": { + "type": "structure", + "members": { + "enabled": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Enables the application to automatically start on job submission. Defaults to\n true.

" } - ] } - ], - "rules": [ + }, + "traits": { + "smithy.api#documentation": "

The configuration for an application to automatically start on job submission.

" + } + }, + "com.amazonaws.emrserverless#AutoStopConfig": { + "type": "structure", + "members": { + "enabled": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Enables the application to automatically stop after a certain amount of time being idle.\n Defaults to true.

" + } + }, + "idleTimeoutMinutes": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The amount of idle time in minutes after which your application will automatically stop.\n Defaults to 15 minutes.

", + "smithy.api#range": { + "min": 1, + "max": 10080 + } + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration for an application to automatically stop after a certain amount of\n time being idle.

" + } + }, + "com.amazonaws.emrserverless#AwsToledoWebService": { + "type": "service", + "version": "2021-07-13", + "operations": [ { - "conditions": [ - { - "fn": "aws.partition", - "argv": [ + "target": "com.amazonaws.emrserverless#ListTagsForResource" + }, + { + "target": "com.amazonaws.emrserverless#TagResource" + }, + { + "target": "com.amazonaws.emrserverless#UntagResource" + } + ], + "resources": [ + { + "target": "com.amazonaws.emrserverless#ApplicationResource" + }, + { + "target": "com.amazonaws.emrserverless#JobRunResource" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "EMR Serverless", + "arnNamespace": "emr-serverless", + "cloudFormationName": "EMRServerless" + }, + "aws.auth#sigv4": { + "name": "emr-serverless" + }, + "aws.protocols#restJson1": {}, + "smithy.api#cors": { + "additionalAllowedHeaders": [ + "*", + "Authorization", + "Date", + "X-Amz-Date", + "X-Amz-Security-Token", + "X-Amz-Target", + "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", + "x-amz-apigw-id" + ] + }, + "smithy.api#documentation": "

Amazon EMR Serverless is a new deployment option for Amazon EMR. Amazon EMR Serverless provides a serverless runtime environment that simplifies running\n analytics applications using the latest open source frameworks such as Apache Spark and\n Apache Hive. With Amazon EMR Serverless, you don’t have to configure, optimize,\n secure, or operate clusters to run applications with these frameworks.

\n

The API reference to Amazon EMR Serverless is emr-serverless. The\n emr-serverless prefix is used in the following scenarios:

\n ", + "smithy.api#title": "EMR Serverless", + "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" + }, { - "ref": "Region" + "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://emr-serverless-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://emr-serverless-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://emr-serverless.{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://emr-serverless.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" } - ], - "assign": "PartitionResult" - } - ], - "rules": [ - { - "conditions": [ + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless.ap-northeast-1.amazonaws.com" + } }, - true - ] + "params": { + "Region": "ap-northeast-1", + "UseFIPS": false, + "UseDualStack": false + } }, { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" + "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless.eu-west-1.amazonaws.com" + } }, - true - ] - } - ], - "rules": [ + "params": { + "Region": "eu-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless.us-east-1.amazonaws.com" } - ] }, - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless-fips.us-east-1.amazonaws.com" } - ] + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://emr-serverless-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless.us-west-2.amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "UseFIPS": false, + "UseDualStack": false } - ], - "type": "tree" }, { - "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [ + "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless-fips.us-west-2.amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "UseFIPS": true, + "UseDualStack": false + } + }, { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless-fips.us-east-1.api.aws" + } }, - true - ] - } - ], - "rules": [ + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - }, - true - ] + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://emr-serverless-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": true } - ], - "type": "tree" }, { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [ + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": false + } + }, { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless.cn-north-1.api.amazonwebservices.com.cn" + } }, - true - ] - } - ], - "rules": [ + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": true + } + }, { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless.cn-north-1.amazonaws.com.cn" } - ] + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": false } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://emr-serverless.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": true } - ], - "type": "tree" }, { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [], - "endpoint": { - "url": "https://emr-serverless.{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://emr-serverless.ap-northeast-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-northeast-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://emr-serverless.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://emr-serverless.us-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://emr-serverless-fips.us-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://emr-serverless.us-west-2.amazonaws.com" - } - }, - "params": { - "Region": "us-west-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://emr-serverless-fips.us-west-2.amazonaws.com" - } - }, - "params": { - "Region": "us-west-2", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://emr-serverless-fips.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://emr-serverless.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://emr-serverless-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://emr-serverless-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://emr-serverless.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://emr-serverless.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://emr-serverless-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://emr-serverless-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://emr-serverless.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://emr-serverless.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://emr-serverless-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://emr-serverless.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://emr-serverless-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://emr-serverless.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.emrserverless#CancelJobRun": { - "type": "operation", - "input": { - "target": "com.amazonaws.emrserverless#CancelJobRunRequest" - }, - "output": { - "target": "com.amazonaws.emrserverless#CancelJobRunResponse" - }, - "errors": [ - { - "target": "com.amazonaws.emrserverless#InternalServerException" - }, - { - "target": "com.amazonaws.emrserverless#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.emrserverless#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Cancels a job run.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/applications/{applicationId}/jobruns/{jobRunId}" - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.emrserverless#CancelJobRunRequest": { - "type": "structure", - "members": { - "applicationId": { - "target": "com.amazonaws.emrserverless#ApplicationId", - "traits": { - "smithy.api#documentation": "

The ID of the application on which the job run will be canceled.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "applicationId" - } - }, - "jobRunId": { - "target": "com.amazonaws.emrserverless#JobRunId", - "traits": { - "smithy.api#documentation": "

The ID of the job run to cancel.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "jobRunId" - } - } - } - }, - "com.amazonaws.emrserverless#CancelJobRunResponse": { - "type": "structure", - "members": { - "applicationId": { - "target": "com.amazonaws.emrserverless#ApplicationId", - "traits": { - "smithy.api#documentation": "

The output contains the application ID on which the job run is cancelled.

", - "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "applicationId" - } - }, - "jobRunId": { - "target": "com.amazonaws.emrserverless#JobRunId", - "traits": { - "smithy.api#documentation": "

The output contains the ID of the cancelled job run.

", - "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "jobRunId" - } - } - } - }, - "com.amazonaws.emrserverless#ClientToken": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - }, - "smithy.api#pattern": "^[A-Za-z0-9._-]+$" - } - }, - "com.amazonaws.emrserverless#CloudWatchLoggingConfiguration": { - "type": "structure", - "members": { - "enabled": { - "target": "smithy.api#Boolean", - "traits": { - "smithy.api#documentation": "

Enables CloudWatch logging.

", - "smithy.api#required": {} - } - }, - "logGroupName": { - "target": "com.amazonaws.emrserverless#LogGroupName", - "traits": { - "smithy.api#documentation": "

The name of the log group in Amazon CloudWatch Logs where you want to publish your\n logs.

" - } - }, - "logStreamNamePrefix": { - "target": "com.amazonaws.emrserverless#LogStreamNamePrefix", - "traits": { - "smithy.api#documentation": "

Prefix for the CloudWatch log stream name.

" - } - }, - "encryptionKeyArn": { - "target": "com.amazonaws.emrserverless#EncryptionKeyArn", - "traits": { - "smithy.api#documentation": "

The Key Management Service (KMS) key ARN to encrypt the logs that you store in CloudWatch Logs.

" - } - }, - "logTypes": { - "target": "com.amazonaws.emrserverless#LogTypeMap", - "traits": { - "smithy.api#documentation": "

The types of logs that you want to publish to CloudWatch. If you don't specify\n any log types, driver STDOUT and STDERR logs will be published to CloudWatch Logs by\n default. For more information including the supported worker types for Hive and Spark, see\n Logging for\n EMR Serverless with CloudWatch.

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

The Amazon CloudWatch configuration for monitoring logs. You can configure your jobs\n to send log information to CloudWatch.

" - } - }, - "com.amazonaws.emrserverless#Configuration": { - "type": "structure", - "members": { - "classification": { - "target": "com.amazonaws.emrserverless#String1024", - "traits": { - "smithy.api#documentation": "

The classification within a configuration.

", - "smithy.api#required": {} - } - }, - "properties": { - "target": "com.amazonaws.emrserverless#SensitivePropertiesMap", - "traits": { - "smithy.api#documentation": "

A set of properties specified within a configuration classification.

" - } - }, - "configurations": { - "target": "com.amazonaws.emrserverless#ConfigurationList", - "traits": { - "smithy.api#documentation": "

A list of additional configurations to apply within a configuration object.

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

A configuration specification to be used when provisioning an application. A\n configuration consists of a classification, properties, and optional nested configurations.\n A classification refers to an application-specific configuration file. Properties are the\n settings you want to change in that file.

" - } - }, - "com.amazonaws.emrserverless#ConfigurationList": { - "type": "list", - "member": { - "target": "com.amazonaws.emrserverless#Configuration" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.emrserverless#ConfigurationOverrides": { - "type": "structure", - "members": { - "applicationConfiguration": { - "target": "com.amazonaws.emrserverless#ConfigurationList", - "traits": { - "smithy.api#documentation": "

The override configurations for the application.

" - } - }, - "monitoringConfiguration": { - "target": "com.amazonaws.emrserverless#MonitoringConfiguration", - "traits": { - "smithy.api#documentation": "

The override configurations for monitoring.

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

A configuration specification to be used to override existing configurations.

" - } - }, - "com.amazonaws.emrserverless#ConfigurationPropertyKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - }, - "smithy.api#pattern": "^.*\\S.*$" - } - }, - "com.amazonaws.emrserverless#ConfigurationPropertyValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1024 - }, - "smithy.api#pattern": "^.*\\S.*$" - } - }, - "com.amazonaws.emrserverless#ConflictException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.emrserverless#String1024", - "traits": { - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The request could not be processed because of conflict in the current state of the\n resource.

", - "smithy.api#error": "client", - "smithy.api#httpError": 409 - } - }, - "com.amazonaws.emrserverless#CpuSize": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 15 - }, - "smithy.api#pattern": "^[1-9][0-9]*(\\s)?(vCPU|vcpu|VCPU)?$" - } - }, - "com.amazonaws.emrserverless#CreateApplication": { - "type": "operation", - "input": { - "target": "com.amazonaws.emrserverless#CreateApplicationRequest" - }, - "output": { - "target": "com.amazonaws.emrserverless#CreateApplicationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.emrserverless#ConflictException" - }, - { - "target": "com.amazonaws.emrserverless#InternalServerException" - }, - { - "target": "com.amazonaws.emrserverless#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.emrserverless#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates an application.

", - "smithy.api#http": { - "method": "POST", - "uri": "/applications" - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.emrserverless#CreateApplicationRequest": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.emrserverless#ApplicationName", - "traits": { - "smithy.api#documentation": "

The name of the application.

" - } - }, - "releaseLabel": { - "target": "com.amazonaws.emrserverless#ReleaseLabel", - "traits": { - "smithy.api#documentation": "

The Amazon EMR release associated with the application.

", - "smithy.api#required": {} - } - }, - "type": { - "target": "com.amazonaws.emrserverless#EngineType", - "traits": { - "smithy.api#documentation": "

The type of application you want to start, such as Spark or Hive.

", - "smithy.api#required": {} - } - }, - "clientToken": { - "target": "com.amazonaws.emrserverless#ClientToken", - "traits": { - "smithy.api#documentation": "

The client idempotency token of the application to create. Its value must be unique for\n each request.

", - "smithy.api#idempotencyToken": {}, - "smithy.api#required": {} - } - }, - "initialCapacity": { - "target": "com.amazonaws.emrserverless#InitialCapacityConfigMap", - "traits": { - "smithy.api#documentation": "

The capacity to initialize when the application is created.

" - } - }, - "maximumCapacity": { - "target": "com.amazonaws.emrserverless#MaximumAllowedResources", - "traits": { - "smithy.api#documentation": "

The maximum capacity to allocate when the application is created. This is cumulative\n across all workers at any given point in time, not just when an application is created. No\n new resources will be created once any one of the defined limits is hit.

" - } - }, - "tags": { - "target": "com.amazonaws.emrserverless#TagMap", - "traits": { - "smithy.api#documentation": "

The tags assigned to the application.

" - } - }, - "autoStartConfiguration": { - "target": "com.amazonaws.emrserverless#AutoStartConfig", - "traits": { - "smithy.api#documentation": "

The configuration for an application to automatically start on job submission.

" - } - }, - "autoStopConfiguration": { - "target": "com.amazonaws.emrserverless#AutoStopConfig", - "traits": { - "smithy.api#documentation": "

The configuration for an application to automatically stop after a certain amount of\n time being idle.

" - } - }, - "networkConfiguration": { - "target": "com.amazonaws.emrserverless#NetworkConfiguration", - "traits": { - "smithy.api#documentation": "

The network configuration for customer VPC connectivity.

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

The CPU architecture of an application.

" - } - }, - "imageConfiguration": { - "target": "com.amazonaws.emrserverless#ImageConfigurationInput", - "traits": { - "smithy.api#documentation": "

The image configuration for all worker types. You can either set this parameter or\n imageConfiguration for each worker type in\n workerTypeSpecifications.

" - } - }, - "workerTypeSpecifications": { - "target": "com.amazonaws.emrserverless#WorkerTypeSpecificationInputMap", - "traits": { - "smithy.api#documentation": "

The key-value pairs that specify worker type to\n WorkerTypeSpecificationInput. This parameter must contain all valid worker\n types for a Spark or Hive application. Valid worker types include Driver and\n Executor for Spark applications and HiveDriver and\n TezTask for Hive applications. You can either set image details in this\n parameter for each worker type, or in imageConfiguration for all worker\n types.

" - } - }, - "runtimeConfiguration": { - "target": "com.amazonaws.emrserverless#ConfigurationList", - "traits": { - "smithy.api#documentation": "

The Configuration \n specifications to use when creating an application. Each configuration consists of a classification and properties.\n This configuration is applied to all the job runs submitted under the application.

" - } - }, - "monitoringConfiguration": { - "target": "com.amazonaws.emrserverless#MonitoringConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration setting for monitoring.

" - } - } - } - }, - "com.amazonaws.emrserverless#CreateApplicationResponse": { - "type": "structure", - "members": { - "applicationId": { - "target": "com.amazonaws.emrserverless#ApplicationId", - "traits": { - "smithy.api#documentation": "

The output contains the application ID.

", - "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "applicationId" - } - }, - "name": { - "target": "com.amazonaws.emrserverless#ApplicationName", - "traits": { - "smithy.api#documentation": "

The output contains the name of the application.

" - } - }, - "arn": { - "target": "com.amazonaws.emrserverless#ApplicationArn", - "traits": { - "smithy.api#documentation": "

The output contains the ARN of the application.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.emrserverless#Date": { - "type": "timestamp" - }, - "com.amazonaws.emrserverless#DeleteApplication": { - "type": "operation", - "input": { - "target": "com.amazonaws.emrserverless#DeleteApplicationRequest" - }, - "output": { - "target": "com.amazonaws.emrserverless#DeleteApplicationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.emrserverless#InternalServerException" - }, - { - "target": "com.amazonaws.emrserverless#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.emrserverless#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes an application. An application has to be in a stopped or created state in order\n to be deleted.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/applications/{applicationId}" - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.emrserverless#DeleteApplicationRequest": { - "type": "structure", - "members": { - "applicationId": { - "target": "com.amazonaws.emrserverless#ApplicationId", - "traits": { - "smithy.api#documentation": "

The ID of the application that will be deleted.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "applicationId" - } - } - } - }, - "com.amazonaws.emrserverless#DeleteApplicationResponse": { - "type": "structure", - "members": {} - }, - "com.amazonaws.emrserverless#DiskSize": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 15 - }, - "smithy.api#pattern": "^[1-9][0-9]*(\\s)?(GB|gb|gB|Gb)$" - } - }, - "com.amazonaws.emrserverless#DiskType": { - "type": "string", - "traits": { - "smithy.api#pattern": "^(SHUFFLE_OPTIMIZED|[Ss]huffle_[Oo]ptimized|STANDARD|[Ss]tandard)$" - } - }, - "com.amazonaws.emrserverless#Duration": { - "type": "long", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 0, - "max": 1000000 - } - } - }, - "com.amazonaws.emrserverless#EncryptionKeyArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 20, - "max": 2048 - }, - "smithy.api#pattern": "^arn:(aws[a-zA-Z0-9-]*):kms:[a-zA-Z0-9\\-]*:(\\d{12})?:key\\/[a-zA-Z0-9-]+$" - } - }, - "com.amazonaws.emrserverless#EngineType": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - } - } - }, - "com.amazonaws.emrserverless#EntryPointArgument": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10280 - }, - "smithy.api#pattern": ".*\\S.*", - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.emrserverless#EntryPointArguments": { - "type": "list", - "member": { - "target": "com.amazonaws.emrserverless#EntryPointArgument" - } - }, - "com.amazonaws.emrserverless#EntryPointPath": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - }, - "smithy.api#pattern": ".*\\S.*", - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.emrserverless#GetApplication": { - "type": "operation", - "input": { - "target": "com.amazonaws.emrserverless#GetApplicationRequest" - }, - "output": { - "target": "com.amazonaws.emrserverless#GetApplicationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.emrserverless#InternalServerException" - }, - { - "target": "com.amazonaws.emrserverless#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.emrserverless#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Displays detailed information about a specified application.

", - "smithy.api#http": { - "method": "GET", - "uri": "/applications/{applicationId}" - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.emrserverless#GetApplicationRequest": { - "type": "structure", - "members": { - "applicationId": { - "target": "com.amazonaws.emrserverless#ApplicationId", - "traits": { - "smithy.api#documentation": "

The ID of the application that will be described.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "applicationId" - } - } - } - }, - "com.amazonaws.emrserverless#GetApplicationResponse": { - "type": "structure", - "members": { - "application": { - "target": "com.amazonaws.emrserverless#Application", - "traits": { - "aws.cloudformation#cfnExcludeProperty": {}, - "smithy.api#documentation": "

The output displays information about the specified application.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.emrserverless#GetDashboardForJobRun": { - "type": "operation", - "input": { - "target": "com.amazonaws.emrserverless#GetDashboardForJobRunRequest" - }, - "output": { - "target": "com.amazonaws.emrserverless#GetDashboardForJobRunResponse" - }, - "errors": [ - { - "target": "com.amazonaws.emrserverless#InternalServerException" - }, - { - "target": "com.amazonaws.emrserverless#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.emrserverless#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates and returns a URL that you can use to access the application UIs for a job\n run.

\n

For jobs in a running state, the application UI is a live user interface such as the\n Spark or Tez web UI. For completed jobs, the application UI is a persistent application\n user interface such as the Spark History Server or persistent Tez UI.

\n \n

The URL is valid for one hour after you generate it. To access the application UI\n after that hour elapses, you must invoke the API again to generate a new URL.

\n ", - "smithy.api#http": { - "method": "GET", - "uri": "/applications/{applicationId}/jobruns/{jobRunId}/dashboard" - } - } - }, - "com.amazonaws.emrserverless#GetDashboardForJobRunRequest": { - "type": "structure", - "members": { - "applicationId": { - "target": "com.amazonaws.emrserverless#ApplicationId", - "traits": { - "smithy.api#documentation": "

The ID of the application.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "applicationId" - } - }, - "jobRunId": { - "target": "com.amazonaws.emrserverless#JobRunId", - "traits": { - "smithy.api#documentation": "

The ID of the job run.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "jobRunId" - } - } - } - }, - "com.amazonaws.emrserverless#GetDashboardForJobRunResponse": { - "type": "structure", - "members": { - "url": { - "target": "com.amazonaws.emrserverless#Url", - "traits": { - "smithy.api#documentation": "

The URL to view job run's dashboard.

" - } - } - } - }, - "com.amazonaws.emrserverless#GetJobRun": { - "type": "operation", - "input": { - "target": "com.amazonaws.emrserverless#GetJobRunRequest" - }, - "output": { - "target": "com.amazonaws.emrserverless#GetJobRunResponse" - }, - "errors": [ - { - "target": "com.amazonaws.emrserverless#InternalServerException" - }, - { - "target": "com.amazonaws.emrserverless#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.emrserverless#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Displays detailed information about a job run.

", - "smithy.api#http": { - "method": "GET", - "uri": "/applications/{applicationId}/jobruns/{jobRunId}" - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.emrserverless#GetJobRunRequest": { - "type": "structure", - "members": { - "applicationId": { - "target": "com.amazonaws.emrserverless#ApplicationId", - "traits": { - "smithy.api#documentation": "

The ID of the application on which the job run is submitted.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "applicationId" - } - }, - "jobRunId": { - "target": "com.amazonaws.emrserverless#JobRunId", - "traits": { - "smithy.api#documentation": "

The ID of the job run.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "jobRunId" - } - } - } - }, - "com.amazonaws.emrserverless#GetJobRunResponse": { - "type": "structure", - "members": { - "jobRun": { - "target": "com.amazonaws.emrserverless#JobRun", - "traits": { - "smithy.api#documentation": "

The output displays information about the job run.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.emrserverless#Hive": { - "type": "structure", - "members": { - "query": { - "target": "com.amazonaws.emrserverless#Query", - "traits": { - "smithy.api#documentation": "

The query for the Hive job run.

", - "smithy.api#required": {} - } - }, - "initQueryFile": { - "target": "com.amazonaws.emrserverless#InitScriptPath", - "traits": { - "smithy.api#documentation": "

The query file for the Hive job run.

" - } - }, - "parameters": { - "target": "com.amazonaws.emrserverless#HiveCliParameters", - "traits": { - "smithy.api#documentation": "

The parameters for the Hive job run.

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

The configurations for the Hive job driver.

" - } - }, - "com.amazonaws.emrserverless#HiveCliParameters": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 102400 - }, - "smithy.api#pattern": ".*\\S.*", - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.emrserverless#IAMRoleArn": { - "type": "string", - "traits": { - "aws.api#arnReference": { - "type": "AWS::IAM::Role" - }, - "smithy.api#length": { - "min": 20, - "max": 2048 - }, - "smithy.api#pattern": "^arn:(aws[a-zA-Z0-9-]*):iam::(\\d{12})?:(role((\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F))[\\w+=,.@-]+)$" - } - }, - "com.amazonaws.emrserverless#ImageConfiguration": { - "type": "structure", - "members": { - "imageUri": { - "target": "com.amazonaws.emrserverless#ImageUri", - "traits": { - "smithy.api#documentation": "

The image URI.

", - "smithy.api#required": {} - } - }, - "resolvedImageDigest": { - "target": "com.amazonaws.emrserverless#ImageDigest", - "traits": { - "smithy.api#documentation": "

The SHA256 digest of the image URI. This indicates which specific image the application\n is configured for. The image digest doesn't exist until an application has started.

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

The applied image configuration.

" - } - }, - "com.amazonaws.emrserverless#ImageConfigurationInput": { - "type": "structure", - "members": { - "imageUri": { - "target": "com.amazonaws.emrserverless#ImageUri", - "traits": { - "smithy.api#documentation": "

The URI of an image in the Amazon ECR registry. This field is required when you create a\n new application. If you leave this field blank in an update, Amazon EMR will remove\n the image configuration.

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

The image configuration.

" - } - }, - "com.amazonaws.emrserverless#ImageDigest": { - "type": "string", - "traits": { - "smithy.api#pattern": "^sha256:[0-9a-f]{64}$" - } - }, - "com.amazonaws.emrserverless#ImageUri": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - }, - "smithy.api#pattern": "^([a-z0-9]+[a-z0-9-.]*)\\/((?:[a-z0-9]+(?:[._-][a-z0-9]+)*\\/)*[a-z0-9]+(?:[._-][a-z0-9]+)*)(?:\\:([a-zA-Z0-9_][a-zA-Z0-9-._]{0,299})|@(sha256:[0-9a-f]{64}))$" - } - }, - "com.amazonaws.emrserverless#InitScriptPath": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - }, - "smithy.api#pattern": ".*\\S.*", - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.emrserverless#InitialCapacityConfig": { - "type": "structure", - "members": { - "workerCount": { - "target": "com.amazonaws.emrserverless#WorkerCounts", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of workers in the initial capacity configuration.

", - "smithy.api#required": {} - } - }, - "workerConfiguration": { - "target": "com.amazonaws.emrserverless#WorkerResourceConfig", - "traits": { - "smithy.api#documentation": "

The resource configuration of the initial capacity configuration.

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

The initial capacity configuration per worker.

" - } - }, - "com.amazonaws.emrserverless#InitialCapacityConfigMap": { - "type": "map", - "key": { - "target": "com.amazonaws.emrserverless#WorkerTypeString" - }, - "value": { - "target": "com.amazonaws.emrserverless#InitialCapacityConfig" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 10 - } - } - }, - "com.amazonaws.emrserverless#InternalServerException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.emrserverless#String1024", - "traits": { - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Request processing failed because of an error or failure with the service.

", - "smithy.api#error": "server", - "smithy.api#httpError": 500 - } - }, - "com.amazonaws.emrserverless#JobArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 60, - "max": 1024 - }, - "smithy.api#pattern": "^arn:(aws[a-zA-Z0-9-]*):emr-serverless:.+:(\\d{12}):\\/applications\\/[0-9a-zA-Z]+\\/jobruns\\/[0-9a-zA-Z]+$" - } - }, - "com.amazonaws.emrserverless#JobDriver": { - "type": "union", - "members": { - "sparkSubmit": { - "target": "com.amazonaws.emrserverless#SparkSubmit", - "traits": { - "smithy.api#documentation": "

The job driver parameters specified for Spark.

" - } - }, - "hive": { - "target": "com.amazonaws.emrserverless#Hive", - "traits": { - "smithy.api#documentation": "

The job driver parameters specified for Hive.

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

The driver that the job runs on.

" - } - }, - "com.amazonaws.emrserverless#JobRun": { - "type": "structure", - "members": { - "applicationId": { - "target": "com.amazonaws.emrserverless#ApplicationId", - "traits": { - "smithy.api#documentation": "

The ID of the application the job is running on.

", - "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "applicationId" - } - }, - "jobRunId": { - "target": "com.amazonaws.emrserverless#JobRunId", - "traits": { - "smithy.api#documentation": "

The ID of the job run.

", - "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "jobRunId" - } - }, - "name": { - "target": "com.amazonaws.emrserverless#String256", - "traits": { - "smithy.api#documentation": "

The optional job run name. This doesn't have to be unique.

" - } - }, - "arn": { - "target": "com.amazonaws.emrserverless#JobArn", - "traits": { - "smithy.api#documentation": "

The execution role ARN of the job run.

", - "smithy.api#required": {} - } - }, - "createdBy": { - "target": "com.amazonaws.emrserverless#RequestIdentityUserArn", - "traits": { - "smithy.api#documentation": "

The user who created the job run.

", - "smithy.api#required": {} - } - }, - "createdAt": { - "target": "com.amazonaws.emrserverless#Date", - "traits": { - "smithy.api#documentation": "

The date and time when the job run was created.

", - "smithy.api#required": {} - } - }, - "updatedAt": { - "target": "com.amazonaws.emrserverless#Date", - "traits": { - "smithy.api#documentation": "

The date and time when the job run was updated.

", - "smithy.api#required": {} - } - }, - "executionRole": { - "target": "com.amazonaws.emrserverless#IAMRoleArn", - "traits": { - "smithy.api#documentation": "

The execution role ARN of the job run.

", - "smithy.api#required": {} - } - }, - "state": { - "target": "com.amazonaws.emrserverless#JobRunState", - "traits": { - "smithy.api#documentation": "

The state of the job run.

", - "smithy.api#required": {} - } - }, - "stateDetails": { - "target": "com.amazonaws.emrserverless#String256", - "traits": { - "smithy.api#documentation": "

The state details of the job run.

", - "smithy.api#required": {} - } - }, - "releaseLabel": { - "target": "com.amazonaws.emrserverless#ReleaseLabel", - "traits": { - "smithy.api#documentation": "

The Amazon EMR release associated with the application your job is running\n on.

", - "smithy.api#required": {} - } - }, - "configurationOverrides": { - "target": "com.amazonaws.emrserverless#ConfigurationOverrides", - "traits": { - "smithy.api#documentation": "

The configuration settings that are used to override default configuration.

" - } - }, - "jobDriver": { - "target": "com.amazonaws.emrserverless#JobDriver", - "traits": { - "smithy.api#documentation": "

The job driver for the job run.

", - "smithy.api#required": {} - } - }, - "tags": { - "target": "com.amazonaws.emrserverless#TagMap", - "traits": { - "smithy.api#documentation": "

The tags assigned to the job run.

" - } - }, - "totalResourceUtilization": { - "target": "com.amazonaws.emrserverless#TotalResourceUtilization", - "traits": { - "smithy.api#documentation": "

The aggregate vCPU, memory, and storage resources used from the time the job starts to\n execute, until the time the job terminates, rounded up to the nearest second.

" - } - }, - "networkConfiguration": { - "target": "com.amazonaws.emrserverless#NetworkConfiguration" - }, - "totalExecutionDurationSeconds": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "

The job run total execution duration in seconds. This field is only available for job\n runs in a COMPLETED, FAILED, or CANCELLED\n state.

" - } - }, - "executionTimeoutMinutes": { - "target": "com.amazonaws.emrserverless#Duration", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

Returns the job run timeout value from the StartJobRun call. If no timeout\n was specified, then it returns the default timeout of 720 minutes.

" - } - }, - "billedResourceUtilization": { - "target": "com.amazonaws.emrserverless#ResourceUtilization", - "traits": { - "smithy.api#documentation": "

The aggregate vCPU, memory, and storage that Amazon Web Services has billed for the job\n run. The billed resources include a 1-minute minimum usage for workers, plus additional\n storage over 20 GB per worker. Note that billed resources do not include usage for idle\n pre-initialized workers.

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

Information about a job run. A job run is a unit of work, such as a Spark JAR, Hive\n query, or SparkSQL query, that you submit to an Amazon EMR Serverless\n application.

" - } - }, - "com.amazonaws.emrserverless#JobRunId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - }, - "smithy.api#pattern": "^[0-9a-z]+$" - } - }, - "com.amazonaws.emrserverless#JobRunResource": { - "type": "resource", - "identifiers": { - "applicationId": { - "target": "com.amazonaws.emrserverless#ApplicationId" - }, - "jobRunId": { - "target": "com.amazonaws.emrserverless#JobRunId" - } - }, - "create": { - "target": "com.amazonaws.emrserverless#StartJobRun" - }, - "read": { - "target": "com.amazonaws.emrserverless#GetJobRun" - }, - "delete": { - "target": "com.amazonaws.emrserverless#CancelJobRun" - }, - "list": { - "target": "com.amazonaws.emrserverless#ListJobRuns" - }, - "operations": [ - { - "target": "com.amazonaws.emrserverless#GetDashboardForJobRun" - } - ] - }, - "com.amazonaws.emrserverless#JobRunState": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "SUBMITTED", - "name": "SUBMITTED" - }, - { - "value": "PENDING", - "name": "PENDING" - }, - { - "value": "SCHEDULED", - "name": "SCHEDULED" - }, - { - "value": "RUNNING", - "name": "RUNNING" - }, - { - "value": "SUCCESS", - "name": "SUCCESS" - }, - { - "value": "FAILED", - "name": "FAILED" - }, - { - "value": "CANCELLING", - "name": "CANCELLING" - }, - { - "value": "CANCELLED", - "name": "CANCELLED" - } - ] - } - }, - "com.amazonaws.emrserverless#JobRunStateSet": { - "type": "list", - "member": { - "target": "com.amazonaws.emrserverless#JobRunState" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 8 - }, - "smithy.api#uniqueItems": {} - } - }, - "com.amazonaws.emrserverless#JobRunSummary": { - "type": "structure", - "members": { - "applicationId": { - "target": "com.amazonaws.emrserverless#ApplicationId", - "traits": { - "smithy.api#documentation": "

The ID of the application the job is running on.

", - "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "applicationId" - } - }, - "id": { - "target": "com.amazonaws.emrserverless#JobRunId", - "traits": { - "smithy.api#documentation": "

The ID of the job run.

", - "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "jobRunId" - } - }, - "name": { - "target": "com.amazonaws.emrserverless#String256", - "traits": { - "smithy.api#documentation": "

The optional job run name. This doesn't have to be unique.

" - } - }, - "arn": { - "target": "com.amazonaws.emrserverless#JobArn", - "traits": { - "smithy.api#documentation": "

The ARN of the job run.

", - "smithy.api#required": {} - } - }, - "createdBy": { - "target": "com.amazonaws.emrserverless#RequestIdentityUserArn", - "traits": { - "smithy.api#documentation": "

The user who created the job run.

", - "smithy.api#required": {} - } - }, - "createdAt": { - "target": "com.amazonaws.emrserverless#Date", - "traits": { - "smithy.api#documentation": "

The date and time when the job run was created.

", - "smithy.api#required": {} - } - }, - "updatedAt": { - "target": "com.amazonaws.emrserverless#Date", - "traits": { - "smithy.api#documentation": "

The date and time when the job run was last updated.

", - "smithy.api#required": {} - } - }, - "executionRole": { - "target": "com.amazonaws.emrserverless#IAMRoleArn", - "traits": { - "smithy.api#documentation": "

The execution role ARN of the job run.

", - "smithy.api#required": {} - } - }, - "state": { - "target": "com.amazonaws.emrserverless#JobRunState", - "traits": { - "smithy.api#documentation": "

The state of the job run.

", - "smithy.api#required": {} - } - }, - "stateDetails": { - "target": "com.amazonaws.emrserverless#String256", - "traits": { - "smithy.api#documentation": "

The state details of the job run.

", - "smithy.api#required": {} - } - }, - "releaseLabel": { - "target": "com.amazonaws.emrserverless#ReleaseLabel", - "traits": { - "smithy.api#documentation": "

The Amazon EMR release associated with the application your job is running\n on.

", - "smithy.api#required": {} - } - }, - "type": { - "target": "com.amazonaws.emrserverless#JobRunType", - "traits": { - "smithy.api#documentation": "

The type of job run, such as Spark or Hive.

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

The summary of attributes associated with a job run.

" - } - }, - "com.amazonaws.emrserverless#JobRunType": { - "type": "string" - }, - "com.amazonaws.emrserverless#JobRuns": { - "type": "list", - "member": { - "target": "com.amazonaws.emrserverless#JobRunSummary" - } - }, - "com.amazonaws.emrserverless#ListApplications": { - "type": "operation", - "input": { - "target": "com.amazonaws.emrserverless#ListApplicationsRequest" - }, - "output": { - "target": "com.amazonaws.emrserverless#ListApplicationsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.emrserverless#InternalServerException" - }, - { - "target": "com.amazonaws.emrserverless#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists applications based on a set of parameters.

", - "smithy.api#http": { - "method": "GET", - "uri": "/applications" - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "maxResults", - "items": "applications" - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.emrserverless#ListApplicationsRequest": { - "type": "structure", - "members": { - "nextToken": { - "target": "com.amazonaws.emrserverless#NextToken", - "traits": { - "smithy.api#documentation": "

The token for the next set of application results.

", - "smithy.api#httpQuery": "nextToken" - } - }, - "maxResults": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The maximum number of applications that can be listed.

", - "smithy.api#httpQuery": "maxResults", - "smithy.api#range": { - "min": 1, - "max": 50 - } - } - }, - "states": { - "target": "com.amazonaws.emrserverless#ApplicationStateSet", - "traits": { - "smithy.api#documentation": "

An optional filter for application states. Note that if this filter contains multiple\n states, the resulting list will be grouped by the state.

", - "smithy.api#httpQuery": "states" - } - } - } - }, - "com.amazonaws.emrserverless#ListApplicationsResponse": { - "type": "structure", - "members": { - "applications": { - "target": "com.amazonaws.emrserverless#ApplicationList", - "traits": { - "smithy.api#documentation": "

The output lists the specified applications.

", - "smithy.api#required": {} - } - }, - "nextToken": { - "target": "com.amazonaws.emrserverless#NextToken", - "traits": { - "smithy.api#documentation": "

The output displays the token for the next set of application results. This is required\n for pagination and is available as a response of the previous request.

" - } - } - } - }, - "com.amazonaws.emrserverless#ListJobRuns": { - "type": "operation", - "input": { - "target": "com.amazonaws.emrserverless#ListJobRunsRequest" - }, - "output": { - "target": "com.amazonaws.emrserverless#ListJobRunsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.emrserverless#InternalServerException" - }, - { - "target": "com.amazonaws.emrserverless#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists job runs based on a set of parameters.

", - "smithy.api#http": { - "method": "GET", - "uri": "/applications/{applicationId}/jobruns" - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "maxResults", - "items": "jobRuns" - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.emrserverless#ListJobRunsRequest": { - "type": "structure", - "members": { - "applicationId": { - "target": "com.amazonaws.emrserverless#ApplicationId", - "traits": { - "smithy.api#documentation": "

The ID of the application for which to list the job run.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "applicationId" - } - }, - "nextToken": { - "target": "com.amazonaws.emrserverless#NextToken", - "traits": { - "smithy.api#documentation": "

The token for the next set of job run results.

", - "smithy.api#httpQuery": "nextToken" - } - }, - "maxResults": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The maximum number of job runs that can be listed.

", - "smithy.api#httpQuery": "maxResults", - "smithy.api#range": { - "min": 1, - "max": 50 - } - } - }, - "createdAtAfter": { - "target": "com.amazonaws.emrserverless#Date", - "traits": { - "smithy.api#documentation": "

The lower bound of the option to filter by creation date and time.

", - "smithy.api#httpQuery": "createdAtAfter" - } - }, - "createdAtBefore": { - "target": "com.amazonaws.emrserverless#Date", - "traits": { - "smithy.api#documentation": "

The upper bound of the option to filter by creation date and time.

", - "smithy.api#httpQuery": "createdAtBefore" - } - }, - "states": { - "target": "com.amazonaws.emrserverless#JobRunStateSet", - "traits": { - "smithy.api#documentation": "

An optional filter for job run states. Note that if this filter contains multiple\n states, the resulting list will be grouped by the state.

", - "smithy.api#httpQuery": "states" - } - } - } - }, - "com.amazonaws.emrserverless#ListJobRunsResponse": { - "type": "structure", - "members": { - "jobRuns": { - "target": "com.amazonaws.emrserverless#JobRuns", - "traits": { - "smithy.api#documentation": "

The output lists information about the specified job runs.

", - "smithy.api#required": {} - } - }, - "nextToken": { - "target": "com.amazonaws.emrserverless#NextToken", - "traits": { - "smithy.api#documentation": "

The output displays the token for the next set of job run results. This is required for\n pagination and is available as a response of the previous request.

" - } - } - } - }, - "com.amazonaws.emrserverless#ListTagsForResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.emrserverless#ListTagsForResourceRequest" - }, - "output": { - "target": "com.amazonaws.emrserverless#ListTagsForResourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.emrserverless#InternalServerException" - }, - { - "target": "com.amazonaws.emrserverless#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.emrserverless#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists the tags assigned to the resources.

", - "smithy.api#http": { - "method": "GET", - "uri": "/tags/{resourceArn}" - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.emrserverless#ListTagsForResourceRequest": { - "type": "structure", - "members": { - "resourceArn": { - "target": "com.amazonaws.emrserverless#ResourceArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that identifies the resource to list the tags for.\n Currently, the supported resources are Amazon EMR Serverless applications and job\n runs.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.emrserverless#ListTagsForResourceResponse": { - "type": "structure", - "members": { - "tags": { - "target": "com.amazonaws.emrserverless#TagMap", - "traits": { - "smithy.api#documentation": "

The tags for the resource.

" - } - } - } - }, - "com.amazonaws.emrserverless#LogGroupName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 512 - }, - "smithy.api#pattern": "^[\\.\\-_/#A-Za-z0-9]+$" - } - }, - "com.amazonaws.emrserverless#LogStreamNamePrefix": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 512 - }, - "smithy.api#pattern": "^[^:*]*$" - } - }, - "com.amazonaws.emrserverless#LogTypeList": { - "type": "list", - "member": { - "target": "com.amazonaws.emrserverless#LogTypeString" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 5 - } - } - }, - "com.amazonaws.emrserverless#LogTypeMap": { - "type": "map", - "key": { - "target": "com.amazonaws.emrserverless#WorkerTypeString" - }, - "value": { - "target": "com.amazonaws.emrserverless#LogTypeList" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 4 - } - } - }, - "com.amazonaws.emrserverless#LogTypeString": { - "type": "string", - "traits": { - "smithy.api#documentation": "Log type for a Spark/Hive job-run.", - "smithy.api#length": { - "min": 1, - "max": 50 - }, - "smithy.api#pattern": "^[a-zA-Z]+[-_]*[a-zA-Z]+$" - } - }, - "com.amazonaws.emrserverless#ManagedPersistenceMonitoringConfiguration": { - "type": "structure", - "members": { - "enabled": { - "target": "smithy.api#Boolean", - "traits": { - "smithy.api#documentation": "

Enables managed logging and defaults to true. If set to false, managed logging will be\n turned off.

" - } - }, - "encryptionKeyArn": { - "target": "com.amazonaws.emrserverless#EncryptionKeyArn", - "traits": { - "smithy.api#documentation": "

The KMS key ARN to encrypt the logs stored in managed log persistence.

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

The managed log persistence configuration for a job run.

" - } - }, - "com.amazonaws.emrserverless#MaximumAllowedResources": { - "type": "structure", - "members": { - "cpu": { - "target": "com.amazonaws.emrserverless#CpuSize", - "traits": { - "smithy.api#documentation": "

The maximum allowed CPU for an application.

", - "smithy.api#required": {} - } - }, - "memory": { - "target": "com.amazonaws.emrserverless#MemorySize", - "traits": { - "smithy.api#documentation": "

The maximum allowed resources for an application.

", - "smithy.api#required": {} - } - }, - "disk": { - "target": "com.amazonaws.emrserverless#DiskSize", - "traits": { - "smithy.api#documentation": "

The maximum allowed disk for an application.

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

The maximum allowed cumulative resources for an application. No new resources will be\n created once the limit is hit.

" - } - }, - "com.amazonaws.emrserverless#MemorySize": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 15 - }, - "smithy.api#pattern": "^[1-9][0-9]*(\\s)?(GB|gb|gB|Gb)?$" - } - }, - "com.amazonaws.emrserverless#MonitoringConfiguration": { - "type": "structure", - "members": { - "s3MonitoringConfiguration": { - "target": "com.amazonaws.emrserverless#S3MonitoringConfiguration", - "traits": { - "smithy.api#documentation": "

The Amazon S3 configuration for monitoring log publishing.

" - } - }, - "managedPersistenceMonitoringConfiguration": { - "target": "com.amazonaws.emrserverless#ManagedPersistenceMonitoringConfiguration", - "traits": { - "smithy.api#documentation": "

The managed log persistence configuration for a job run.

" - } - }, - "cloudWatchLoggingConfiguration": { - "target": "com.amazonaws.emrserverless#CloudWatchLoggingConfiguration", - "traits": { - "smithy.api#documentation": "

The Amazon CloudWatch configuration for monitoring logs. You can configure your jobs\n to send log information to CloudWatch.

" - } - }, - "prometheusMonitoringConfiguration": { - "target": "com.amazonaws.emrserverless#PrometheusMonitoringConfiguration", - "traits": { - "smithy.api#documentation": "

The monitoring configuration object you can configure to send metrics to Amazon Managed Service for Prometheus for a job run.

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

The configuration setting for monitoring.

" - } - }, - "com.amazonaws.emrserverless#NetworkConfiguration": { - "type": "structure", - "members": { - "subnetIds": { - "target": "com.amazonaws.emrserverless#SubnetIds", - "traits": { - "smithy.api#documentation": "

The array of subnet Ids for customer VPC connectivity.

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

The array of security group Ids for customer VPC connectivity.

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

The network configuration for customer VPC connectivity.

" - } - }, - "com.amazonaws.emrserverless#NextToken": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - }, - "smithy.api#pattern": "^[A-Za-z0-9_=-]+$" - } - }, - "com.amazonaws.emrserverless#PrometheusMonitoringConfiguration": { - "type": "structure", - "members": { - "remoteWriteUrl": { - "target": "com.amazonaws.emrserverless#PrometheusUrlString", - "traits": { - "smithy.api#documentation": "

The remote write URL in the Amazon Managed Service for Prometheus workspace to send metrics to.

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

The monitoring configuration object you can configure to send metrics to Amazon Managed Service for Prometheus for a job run.

" - } - }, - "com.amazonaws.emrserverless#PrometheusUrlString": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10280 - }, - "smithy.api#pattern": "^https://aps-workspaces.([a-z]{2}-[a-z-]{1,20}-[1-9]).amazonaws(.[0-9A-Za-z]{2,4})+/workspaces/[-_.0-9A-Za-z]{1,100}/api/v1/remote_write$" - } - }, - "com.amazonaws.emrserverless#Query": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10280 - }, - "smithy.api#pattern": ".*\\S.*", - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.emrserverless#ReleaseLabel": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - }, - "smithy.api#pattern": "^[A-Za-z0-9._/-]+$" - } - }, - "com.amazonaws.emrserverless#RequestIdentityUserArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 20, - "max": 2048 - }, - "smithy.api#pattern": "^arn:(aws[a-zA-Z0-9-]*):(iam|sts)::(\\d{12})?:[\\w/+=,.@-]+$" - } - }, - "com.amazonaws.emrserverless#ResourceArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 60, - "max": 1024 - }, - "smithy.api#pattern": "^arn:(aws[a-zA-Z0-9-]*):emr-serverless:.+:(\\d{12}):\\/applications\\/[0-9a-zA-Z]+(\\/jobruns\\/[0-9a-zA-Z]+)?$" - } - }, - "com.amazonaws.emrserverless#ResourceNotFoundException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.emrserverless#String1024", - "traits": { - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The specified resource was not found.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.emrserverless#ResourceUtilization": { - "type": "structure", - "members": { - "vCPUHour": { - "target": "smithy.api#Double", - "traits": { - "smithy.api#documentation": "

The aggregated vCPU used per hour from the time the job starts executing until the job\n is terminated.

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

The aggregated memory used per hour from the time the job starts executing until the job\n is terminated.

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

The aggregated storage used per hour from the time the job starts executing until the\n job is terminated.

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

The resource utilization for memory, storage, and vCPU for jobs.

" - } - }, - "com.amazonaws.emrserverless#S3MonitoringConfiguration": { - "type": "structure", - "members": { - "logUri": { - "target": "com.amazonaws.emrserverless#UriString", - "traits": { - "smithy.api#documentation": "

The Amazon S3 destination URI for log publishing.

" - } - }, - "encryptionKeyArn": { - "target": "com.amazonaws.emrserverless#EncryptionKeyArn", - "traits": { - "smithy.api#documentation": "

The KMS key ARN to encrypt the logs published to the given Amazon S3 destination.

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

The Amazon S3 configuration for monitoring log publishing. You can configure your jobs\n to send log information to Amazon S3.

" - } - }, - "com.amazonaws.emrserverless#SecurityGroupIds": { - "type": "list", - "member": { - "target": "com.amazonaws.emrserverless#SecurityGroupString" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 5 - } - } - }, - "com.amazonaws.emrserverless#SecurityGroupString": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 32 - }, - "smithy.api#pattern": "^[-0-9a-zA-Z]+" - } - }, - "com.amazonaws.emrserverless#SensitivePropertiesMap": { - "type": "map", - "key": { - "target": "com.amazonaws.emrserverless#ConfigurationPropertyKey" - }, - "value": { - "target": "com.amazonaws.emrserverless#ConfigurationPropertyValue" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - }, - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.emrserverless#ServiceQuotaExceededException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.emrserverless#String1024", - "traits": { - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The maximum number of resources per account has been reached.

", - "smithy.api#error": "client", - "smithy.api#httpError": 402 - } - }, - "com.amazonaws.emrserverless#SparkSubmit": { - "type": "structure", - "members": { - "entryPoint": { - "target": "com.amazonaws.emrserverless#EntryPointPath", - "traits": { - "smithy.api#documentation": "

The entry point for the Spark submit job run.

", - "smithy.api#required": {} - } - }, - "entryPointArguments": { - "target": "com.amazonaws.emrserverless#EntryPointArguments", - "traits": { - "smithy.api#documentation": "

The arguments for the Spark submit job run.

" - } - }, - "sparkSubmitParameters": { - "target": "com.amazonaws.emrserverless#SparkSubmitParameters", - "traits": { - "smithy.api#documentation": "

The parameters for the Spark submit job run.

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

The configurations for the Spark submit job driver.

" - } - }, - "com.amazonaws.emrserverless#SparkSubmitParameters": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 102400 - }, - "smithy.api#pattern": ".*\\S.*", - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.emrserverless#StartApplication": { - "type": "operation", - "input": { - "target": "com.amazonaws.emrserverless#StartApplicationRequest" - }, - "output": { - "target": "com.amazonaws.emrserverless#StartApplicationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.emrserverless#InternalServerException" - }, - { - "target": "com.amazonaws.emrserverless#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.emrserverless#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.emrserverless#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Starts a specified application and initializes initial capacity if configured.

", - "smithy.api#http": { - "method": "POST", - "uri": "/applications/{applicationId}/start" - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.emrserverless#StartApplicationRequest": { - "type": "structure", - "members": { - "applicationId": { - "target": "com.amazonaws.emrserverless#ApplicationId", - "traits": { - "smithy.api#documentation": "

The ID of the application to start.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "applicationId" - } - } - } - }, - "com.amazonaws.emrserverless#StartApplicationResponse": { - "type": "structure", - "members": {} - }, - "com.amazonaws.emrserverless#StartJobRun": { - "type": "operation", - "input": { - "target": "com.amazonaws.emrserverless#StartJobRunRequest" - }, - "output": { - "target": "com.amazonaws.emrserverless#StartJobRunResponse" - }, - "errors": [ - { - "target": "com.amazonaws.emrserverless#ConflictException" - }, - { - "target": "com.amazonaws.emrserverless#InternalServerException" - }, - { - "target": "com.amazonaws.emrserverless#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.emrserverless#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Starts a job run.

", - "smithy.api#http": { - "method": "POST", - "uri": "/applications/{applicationId}/jobruns" - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.emrserverless#StartJobRunRequest": { - "type": "structure", - "members": { - "applicationId": { - "target": "com.amazonaws.emrserverless#ApplicationId", - "traits": { - "smithy.api#documentation": "

The ID of the application on which to run the job.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "applicationId" - } - }, - "clientToken": { - "target": "com.amazonaws.emrserverless#ClientToken", - "traits": { - "smithy.api#documentation": "

The client idempotency token of the job run to start. Its value must be unique for each\n request.

", - "smithy.api#idempotencyToken": {}, - "smithy.api#required": {} - } - }, - "executionRoleArn": { - "target": "com.amazonaws.emrserverless#IAMRoleArn", - "traits": { - "smithy.api#documentation": "

The execution role ARN for the job run.

", - "smithy.api#required": {} - } - }, - "jobDriver": { - "target": "com.amazonaws.emrserverless#JobDriver", - "traits": { - "smithy.api#documentation": "

The job driver for the job run.

" - } - }, - "configurationOverrides": { - "target": "com.amazonaws.emrserverless#ConfigurationOverrides", - "traits": { - "smithy.api#documentation": "

The configuration overrides for the job run.

" - } - }, - "tags": { - "target": "com.amazonaws.emrserverless#TagMap", - "traits": { - "smithy.api#documentation": "

The tags assigned to the job run.

" - } - }, - "executionTimeoutMinutes": { - "target": "com.amazonaws.emrserverless#Duration", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The maximum duration for the job run to run. If the job run runs beyond this duration,\n it will be automatically cancelled.

" - } - }, - "name": { - "target": "com.amazonaws.emrserverless#String256", - "traits": { - "smithy.api#documentation": "

The optional job run name. This doesn't have to be unique.

" - } - } - } - }, - "com.amazonaws.emrserverless#StartJobRunResponse": { - "type": "structure", - "members": { - "applicationId": { - "target": "com.amazonaws.emrserverless#ApplicationId", - "traits": { - "smithy.api#documentation": "

This output displays the application ID on which the job run was submitted.

", - "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "applicationId" - } - }, - "jobRunId": { - "target": "com.amazonaws.emrserverless#JobRunId", - "traits": { - "smithy.api#documentation": "

The output contains the ID of the started job run.

", - "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "jobRunId" - } - }, - "arn": { - "target": "com.amazonaws.emrserverless#JobArn", - "traits": { - "smithy.api#documentation": "

This output displays the ARN of the job run..

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.emrserverless#StopApplication": { - "type": "operation", - "input": { - "target": "com.amazonaws.emrserverless#StopApplicationRequest" - }, - "output": { - "target": "com.amazonaws.emrserverless#StopApplicationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.emrserverless#InternalServerException" - }, - { - "target": "com.amazonaws.emrserverless#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.emrserverless#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Stops a specified application and releases initial capacity if configured. All scheduled\n and running jobs must be completed or cancelled before stopping an application.

", - "smithy.api#http": { - "method": "POST", - "uri": "/applications/{applicationId}/stop" - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.emrserverless#StopApplicationRequest": { - "type": "structure", - "members": { - "applicationId": { - "target": "com.amazonaws.emrserverless#ApplicationId", - "traits": { - "smithy.api#documentation": "

The ID of the application to stop.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "applicationId" - } - } - } - }, - "com.amazonaws.emrserverless#StopApplicationResponse": { - "type": "structure", - "members": {} - }, - "com.amazonaws.emrserverless#String1024": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - }, - "smithy.api#pattern": ".*\\S.*" - } - }, - "com.amazonaws.emrserverless#String256": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - }, - "smithy.api#pattern": ".*\\S.*" - } - }, - "com.amazonaws.emrserverless#SubnetIds": { - "type": "list", - "member": { - "target": "com.amazonaws.emrserverless#SubnetString" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 16 - } - } - }, - "com.amazonaws.emrserverless#SubnetString": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 32 - }, - "smithy.api#pattern": "^[-0-9a-zA-Z]+" - } - }, - "com.amazonaws.emrserverless#TagKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - }, - "smithy.api#pattern": "^[A-Za-z0-9 /_.:=+@-]+$" - } - }, - "com.amazonaws.emrserverless#TagKeyList": { - "type": "list", - "member": { - "target": "com.amazonaws.emrserverless#TagKey" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 200 - } - } - }, - "com.amazonaws.emrserverless#TagMap": { - "type": "map", - "key": { - "target": "com.amazonaws.emrserverless#TagKey" - }, - "value": { - "target": "com.amazonaws.emrserverless#TagValue" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 200 - } - } - }, - "com.amazonaws.emrserverless#TagResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.emrserverless#TagResourceRequest" - }, - "output": { - "target": "com.amazonaws.emrserverless#TagResourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.emrserverless#InternalServerException" - }, - { - "target": "com.amazonaws.emrserverless#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.emrserverless#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Assigns tags to resources. A tag is a label that you assign to an Amazon Web Services\n resource. Each tag consists of a key and an optional value, both of which you define. Tags\n enable you to categorize your Amazon Web Services resources by attributes such as purpose,\n owner, or environment. When you have many resources of the same type, you can quickly\n identify a specific resource based on the tags you've assigned to it.

", - "smithy.api#http": { - "method": "POST", - "uri": "/tags/{resourceArn}" - } - } - }, - "com.amazonaws.emrserverless#TagResourceRequest": { - "type": "structure", - "members": { - "resourceArn": { - "target": "com.amazonaws.emrserverless#ResourceArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that identifies the resource to list the tags for.\n Currently, the supported resources are Amazon EMR Serverless applications and job\n runs.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "tags": { - "target": "com.amazonaws.emrserverless#TagMap", - "traits": { - "smithy.api#documentation": "

The tags to add to the resource. A tag is an array of key-value pairs.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.emrserverless#TagResourceResponse": { - "type": "structure", - "members": {} - }, - "com.amazonaws.emrserverless#TagValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - }, - "smithy.api#pattern": "^[A-Za-z0-9 /_.:=+@-]*$" - } - }, - "com.amazonaws.emrserverless#TotalResourceUtilization": { - "type": "structure", - "members": { - "vCPUHour": { - "target": "smithy.api#Double", - "traits": { - "smithy.api#documentation": "

The aggregated vCPU used per hour from the time job start executing till the time job is\n terminated.

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

The aggregated memory used per hour from the time job start executing till the time job\n is terminated.

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

The aggregated storage used per hour from the time job start executing till the time job\n is terminated.

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

The aggregate vCPU, memory, and storage resources used from the time job start executing\n till the time job is terminated, rounded up to the nearest second.

" - } - }, - "com.amazonaws.emrserverless#UntagResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.emrserverless#UntagResourceRequest" - }, - "output": { - "target": "com.amazonaws.emrserverless#UntagResourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.emrserverless#InternalServerException" - }, - { - "target": "com.amazonaws.emrserverless#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.emrserverless#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Removes tags from resources.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/tags/{resourceArn}" - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.emrserverless#UntagResourceRequest": { - "type": "structure", - "members": { - "resourceArn": { - "target": "com.amazonaws.emrserverless#ResourceArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that identifies the resource to list the tags for.\n Currently, the supported resources are Amazon EMR Serverless applications and job\n runs.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "tagKeys": { - "target": "com.amazonaws.emrserverless#TagKeyList", - "traits": { - "smithy.api#documentation": "

The keys of the tags to be removed.

", - "smithy.api#httpQuery": "tagKeys", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.emrserverless#UntagResourceResponse": { - "type": "structure", - "members": {} - }, - "com.amazonaws.emrserverless#UpdateApplication": { - "type": "operation", - "input": { - "target": "com.amazonaws.emrserverless#UpdateApplicationRequest" - }, - "output": { - "target": "com.amazonaws.emrserverless#UpdateApplicationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.emrserverless#InternalServerException" - }, - { - "target": "com.amazonaws.emrserverless#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.emrserverless#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates a specified application. An application has to be in a stopped or created state\n in order to be updated.

", - "smithy.api#http": { - "method": "PATCH", - "uri": "/applications/{applicationId}" - } - } - }, - "com.amazonaws.emrserverless#UpdateApplicationRequest": { - "type": "structure", - "members": { - "applicationId": { - "target": "com.amazonaws.emrserverless#ApplicationId", - "traits": { - "smithy.api#documentation": "

The ID of the application to update.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {}, - "smithy.api#resourceIdentifier": "applicationId" - } - }, - "clientToken": { - "target": "com.amazonaws.emrserverless#ClientToken", - "traits": { - "smithy.api#documentation": "

The client idempotency token of the application to update. Its value must be unique for\n each request.

", - "smithy.api#idempotencyToken": {}, - "smithy.api#required": {} - } - }, - "initialCapacity": { - "target": "com.amazonaws.emrserverless#InitialCapacityConfigMap", - "traits": { - "smithy.api#documentation": "

The capacity to initialize when the application is updated.

" - } - }, - "maximumCapacity": { - "target": "com.amazonaws.emrserverless#MaximumAllowedResources", - "traits": { - "smithy.api#documentation": "

The maximum capacity to allocate when the application is updated. This is cumulative\n across all workers at any given point in time during the lifespan of the application. No\n new resources will be created once any one of the defined limits is hit.

" - } - }, - "autoStartConfiguration": { - "target": "com.amazonaws.emrserverless#AutoStartConfig", - "traits": { - "smithy.api#documentation": "

The configuration for an application to automatically start on job submission.

" - } - }, - "autoStopConfiguration": { - "target": "com.amazonaws.emrserverless#AutoStopConfig", - "traits": { - "smithy.api#documentation": "

The configuration for an application to automatically stop after a certain amount of\n time being idle.

" - } - }, - "networkConfiguration": { - "target": "com.amazonaws.emrserverless#NetworkConfiguration" - }, - "architecture": { - "target": "com.amazonaws.emrserverless#Architecture", - "traits": { - "smithy.api#documentation": "

The CPU architecture of an application.

" - } - }, - "imageConfiguration": { - "target": "com.amazonaws.emrserverless#ImageConfigurationInput", - "traits": { - "smithy.api#documentation": "

The image configuration to be used for all worker types. You can either set this\n parameter or imageConfiguration for each worker type in\n WorkerTypeSpecificationInput.

" - } - }, - "workerTypeSpecifications": { - "target": "com.amazonaws.emrserverless#WorkerTypeSpecificationInputMap", - "traits": { - "smithy.api#documentation": "

The key-value pairs that specify worker type to\n WorkerTypeSpecificationInput. This parameter must contain all valid worker\n types for a Spark or Hive application. Valid worker types include Driver and\n Executor for Spark applications and HiveDriver and\n TezTask for Hive applications. You can either set image details in this\n parameter for each worker type, or in imageConfiguration for all worker\n types.

" - } - }, - "releaseLabel": { - "target": "com.amazonaws.emrserverless#ReleaseLabel", - "traits": { - "smithy.api#documentation": "

The Amazon EMR release label for the application. You can change the release\n label to use a different release of Amazon EMR.

" - } - }, - "runtimeConfiguration": { - "target": "com.amazonaws.emrserverless#ConfigurationList", - "traits": { - "smithy.api#documentation": "

The Configuration \n specifications to use when updating an application. Each configuration consists of a classification and properties.\n This configuration is applied across all the job runs submitted under the application.

" - } - }, - "monitoringConfiguration": { - "target": "com.amazonaws.emrserverless#MonitoringConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration setting for monitoring.

" - } - } - } - }, - "com.amazonaws.emrserverless#UpdateApplicationResponse": { - "type": "structure", - "members": { - "application": { - "target": "com.amazonaws.emrserverless#Application", - "traits": { - "smithy.api#documentation": "

Information about the updated application.

", - "smithy.api#required": {} - } - } - } - }, - "com.amazonaws.emrserverless#UriString": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10280 - }, - "smithy.api#pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDBFF-\\uDC00\\uDFFF\\r\\n\\t]*" - } - }, - "com.amazonaws.emrserverless#Url": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2048 - } - } - }, - "com.amazonaws.emrserverless#ValidationException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.emrserverless#String1024", - "traits": { - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The input fails to satisfy the constraints specified by an Amazon Web Services\n service.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.emrserverless#WorkerCounts": { - "type": "long", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 1, - "max": 1000000 - } - } - }, - "com.amazonaws.emrserverless#WorkerResourceConfig": { - "type": "structure", - "members": { - "cpu": { - "target": "com.amazonaws.emrserverless#CpuSize", - "traits": { - "smithy.api#documentation": "

The CPU requirements for every worker instance of the worker type.

", - "smithy.api#required": {} - } - }, - "memory": { - "target": "com.amazonaws.emrserverless#MemorySize", - "traits": { - "smithy.api#documentation": "

The memory requirements for every worker instance of the worker type.

", - "smithy.api#required": {} - } - }, - "disk": { - "target": "com.amazonaws.emrserverless#DiskSize", - "traits": { - "smithy.api#documentation": "

The disk requirements for every worker instance of the worker type.

" - } - }, - "diskType": { - "target": "com.amazonaws.emrserverless#DiskType", - "traits": { - "smithy.api#documentation": "

The disk type for every worker instance of the work type. Shuffle optimized disks have higher performance \n characteristics and are better for shuffle heavy workloads. Default is STANDARD.

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

The cumulative configuration requirements for every worker instance of the worker\n type.

" - } - }, - "com.amazonaws.emrserverless#WorkerTypeSpecification": { - "type": "structure", - "members": { - "imageConfiguration": { - "target": "com.amazonaws.emrserverless#ImageConfiguration", - "traits": { - "smithy.api#documentation": "

The image configuration for a worker type.

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

The specifications for a worker type.

" - } - }, - "com.amazonaws.emrserverless#WorkerTypeSpecificationInput": { - "type": "structure", - "members": { - "imageConfiguration": { - "target": "com.amazonaws.emrserverless#ImageConfigurationInput", - "traits": { - "smithy.api#documentation": "

The image configuration for a worker type.

" - } + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://emr-serverless-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://emr-serverless.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://emr-serverless.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://emr-serverless-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://emr-serverless.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://emr-serverless-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://emr-serverless.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.emrserverless#CancelJobRun": { + "type": "operation", + "input": { + "target": "com.amazonaws.emrserverless#CancelJobRunRequest" + }, + "output": { + "target": "com.amazonaws.emrserverless#CancelJobRunResponse" + }, + "errors": [ + { + "target": "com.amazonaws.emrserverless#InternalServerException" + }, + { + "target": "com.amazonaws.emrserverless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.emrserverless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Cancels a job run.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/applications/{applicationId}/jobruns/{jobRunId}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.emrserverless#CancelJobRunRequest": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.emrserverless#ApplicationId", + "traits": { + "smithy.api#documentation": "

The ID of the application on which the job run will be canceled.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "applicationId" + } + }, + "jobRunId": { + "target": "com.amazonaws.emrserverless#JobRunId", + "traits": { + "smithy.api#documentation": "

The ID of the job run to cancel.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "jobRunId" + } + } + } + }, + "com.amazonaws.emrserverless#CancelJobRunResponse": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.emrserverless#ApplicationId", + "traits": { + "smithy.api#documentation": "

The output contains the application ID on which the job run is cancelled.

", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "applicationId" + } + }, + "jobRunId": { + "target": "com.amazonaws.emrserverless#JobRunId", + "traits": { + "smithy.api#documentation": "

The output contains the ID of the cancelled job run.

", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "jobRunId" + } + } + } + }, + "com.amazonaws.emrserverless#ClientToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[A-Za-z0-9._-]+$" + } + }, + "com.amazonaws.emrserverless#CloudWatchLoggingConfiguration": { + "type": "structure", + "members": { + "enabled": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Enables CloudWatch logging.

", + "smithy.api#required": {} + } + }, + "logGroupName": { + "target": "com.amazonaws.emrserverless#LogGroupName", + "traits": { + "smithy.api#documentation": "

The name of the log group in Amazon CloudWatch Logs where you want to publish your\n logs.

" + } + }, + "logStreamNamePrefix": { + "target": "com.amazonaws.emrserverless#LogStreamNamePrefix", + "traits": { + "smithy.api#documentation": "

Prefix for the CloudWatch log stream name.

" + } + }, + "encryptionKeyArn": { + "target": "com.amazonaws.emrserverless#EncryptionKeyArn", + "traits": { + "smithy.api#documentation": "

The Key Management Service (KMS) key ARN to encrypt the logs that you store in CloudWatch Logs.

" + } + }, + "logTypes": { + "target": "com.amazonaws.emrserverless#LogTypeMap", + "traits": { + "smithy.api#documentation": "

The types of logs that you want to publish to CloudWatch. If you don't specify\n any log types, driver STDOUT and STDERR logs will be published to CloudWatch Logs by\n default. For more information including the supported worker types for Hive and Spark, see\n Logging for\n EMR Serverless with CloudWatch.

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

The Amazon CloudWatch configuration for monitoring logs. You can configure your jobs\n to send log information to CloudWatch.

" + } + }, + "com.amazonaws.emrserverless#Configuration": { + "type": "structure", + "members": { + "classification": { + "target": "com.amazonaws.emrserverless#String1024", + "traits": { + "smithy.api#documentation": "

The classification within a configuration.

", + "smithy.api#required": {} + } + }, + "properties": { + "target": "com.amazonaws.emrserverless#SensitivePropertiesMap", + "traits": { + "smithy.api#documentation": "

A set of properties specified within a configuration classification.

" + } + }, + "configurations": { + "target": "com.amazonaws.emrserverless#ConfigurationList", + "traits": { + "smithy.api#documentation": "

A list of additional configurations to apply within a configuration object.

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

A configuration specification to be used when provisioning an application. A\n configuration consists of a classification, properties, and optional nested configurations.\n A classification refers to an application-specific configuration file. Properties are the\n settings you want to change in that file.

" + } + }, + "com.amazonaws.emrserverless#ConfigurationList": { + "type": "list", + "member": { + "target": "com.amazonaws.emrserverless#Configuration" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.emrserverless#ConfigurationOverrides": { + "type": "structure", + "members": { + "applicationConfiguration": { + "target": "com.amazonaws.emrserverless#ConfigurationList", + "traits": { + "smithy.api#documentation": "

The override configurations for the application.

" + } + }, + "monitoringConfiguration": { + "target": "com.amazonaws.emrserverless#MonitoringConfiguration", + "traits": { + "smithy.api#documentation": "

The override configurations for monitoring.

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

A configuration specification to be used to override existing configurations.

" + } + }, + "com.amazonaws.emrserverless#ConfigurationPropertyKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^.*\\S.*$" + } + }, + "com.amazonaws.emrserverless#ConfigurationPropertyValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#pattern": "^.*\\S.*$" + } + }, + "com.amazonaws.emrserverless#ConflictException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.emrserverless#String1024", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The request could not be processed because of conflict in the current state of the\n resource.

", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.emrserverless#CpuSize": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 15 + }, + "smithy.api#pattern": "^[1-9][0-9]*(\\s)?(vCPU|vcpu|VCPU)?$" + } + }, + "com.amazonaws.emrserverless#CreateApplication": { + "type": "operation", + "input": { + "target": "com.amazonaws.emrserverless#CreateApplicationRequest" + }, + "output": { + "target": "com.amazonaws.emrserverless#CreateApplicationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.emrserverless#ConflictException" + }, + { + "target": "com.amazonaws.emrserverless#InternalServerException" + }, + { + "target": "com.amazonaws.emrserverless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.emrserverless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an application.

", + "smithy.api#http": { + "method": "POST", + "uri": "/applications" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.emrserverless#CreateApplicationRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.emrserverless#ApplicationName", + "traits": { + "smithy.api#documentation": "

The name of the application.

" + } + }, + "releaseLabel": { + "target": "com.amazonaws.emrserverless#ReleaseLabel", + "traits": { + "smithy.api#documentation": "

The Amazon EMR release associated with the application.

", + "smithy.api#required": {} + } + }, + "type": { + "target": "com.amazonaws.emrserverless#EngineType", + "traits": { + "smithy.api#documentation": "

The type of application you want to start, such as Spark or Hive.

", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.emrserverless#ClientToken", + "traits": { + "smithy.api#documentation": "

The client idempotency token of the application to create. Its value must be unique for\n each request.

", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + }, + "initialCapacity": { + "target": "com.amazonaws.emrserverless#InitialCapacityConfigMap", + "traits": { + "smithy.api#documentation": "

The capacity to initialize when the application is created.

" + } + }, + "maximumCapacity": { + "target": "com.amazonaws.emrserverless#MaximumAllowedResources", + "traits": { + "smithy.api#documentation": "

The maximum capacity to allocate when the application is created. This is cumulative\n across all workers at any given point in time, not just when an application is created. No\n new resources will be created once any one of the defined limits is hit.

" + } + }, + "tags": { + "target": "com.amazonaws.emrserverless#TagMap", + "traits": { + "smithy.api#documentation": "

The tags assigned to the application.

" + } + }, + "autoStartConfiguration": { + "target": "com.amazonaws.emrserverless#AutoStartConfig", + "traits": { + "smithy.api#documentation": "

The configuration for an application to automatically start on job submission.

" + } + }, + "autoStopConfiguration": { + "target": "com.amazonaws.emrserverless#AutoStopConfig", + "traits": { + "smithy.api#documentation": "

The configuration for an application to automatically stop after a certain amount of\n time being idle.

" + } + }, + "networkConfiguration": { + "target": "com.amazonaws.emrserverless#NetworkConfiguration", + "traits": { + "smithy.api#documentation": "

The network configuration for customer VPC connectivity.

" + } + }, + "architecture": { + "target": "com.amazonaws.emrserverless#Architecture", + "traits": { + "smithy.api#documentation": "

The CPU architecture of an application.

" + } + }, + "imageConfiguration": { + "target": "com.amazonaws.emrserverless#ImageConfigurationInput", + "traits": { + "smithy.api#documentation": "

The image configuration for all worker types. You can either set this parameter or\n imageConfiguration for each worker type in\n workerTypeSpecifications.

" + } + }, + "workerTypeSpecifications": { + "target": "com.amazonaws.emrserverless#WorkerTypeSpecificationInputMap", + "traits": { + "smithy.api#documentation": "

The key-value pairs that specify worker type to\n WorkerTypeSpecificationInput. This parameter must contain all valid worker\n types for a Spark or Hive application. Valid worker types include Driver and\n Executor for Spark applications and HiveDriver and\n TezTask for Hive applications. You can either set image details in this\n parameter for each worker type, or in imageConfiguration for all worker\n types.

" + } + }, + "runtimeConfiguration": { + "target": "com.amazonaws.emrserverless#ConfigurationList", + "traits": { + "smithy.api#documentation": "

The Configuration \n specifications to use when creating an application. Each configuration consists of a classification and properties.\n This configuration is applied to all the job runs submitted under the application.

" + } + }, + "monitoringConfiguration": { + "target": "com.amazonaws.emrserverless#MonitoringConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration setting for monitoring.

" + } + }, + "interactiveConfiguration": { + "target": "com.amazonaws.emrserverless#InteractiveConfiguration", + "traits": { + "smithy.api#documentation": "

The interactive configuration object that enables the interactive use cases \n to use when running an application.

" + } + } + } + }, + "com.amazonaws.emrserverless#CreateApplicationResponse": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.emrserverless#ApplicationId", + "traits": { + "smithy.api#documentation": "

The output contains the application ID.

", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "applicationId" + } + }, + "name": { + "target": "com.amazonaws.emrserverless#ApplicationName", + "traits": { + "smithy.api#documentation": "

The output contains the name of the application.

" + } + }, + "arn": { + "target": "com.amazonaws.emrserverless#ApplicationArn", + "traits": { + "smithy.api#documentation": "

The output contains the ARN of the application.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.emrserverless#Date": { + "type": "timestamp" + }, + "com.amazonaws.emrserverless#DeleteApplication": { + "type": "operation", + "input": { + "target": "com.amazonaws.emrserverless#DeleteApplicationRequest" + }, + "output": { + "target": "com.amazonaws.emrserverless#DeleteApplicationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.emrserverless#InternalServerException" + }, + { + "target": "com.amazonaws.emrserverless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.emrserverless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes an application. An application has to be in a stopped or created state in order\n to be deleted.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/applications/{applicationId}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.emrserverless#DeleteApplicationRequest": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.emrserverless#ApplicationId", + "traits": { + "smithy.api#documentation": "

The ID of the application that will be deleted.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "applicationId" + } + } + } + }, + "com.amazonaws.emrserverless#DeleteApplicationResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.emrserverless#DiskSize": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 15 + }, + "smithy.api#pattern": "^[1-9][0-9]*(\\s)?(GB|gb|gB|Gb)$" + } + }, + "com.amazonaws.emrserverless#DiskType": { + "type": "string", + "traits": { + "smithy.api#pattern": "^(SHUFFLE_OPTIMIZED|[Ss]huffle_[Oo]ptimized|STANDARD|[Ss]tandard)$" + } + }, + "com.amazonaws.emrserverless#Duration": { + "type": "long", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0, + "max": 1000000 + } + } + }, + "com.amazonaws.emrserverless#EncryptionKeyArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:(aws[a-zA-Z0-9-]*):kms:[a-zA-Z0-9\\-]*:(\\d{12})?:key\\/[a-zA-Z0-9-]+$" + } + }, + "com.amazonaws.emrserverless#EngineType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.emrserverless#EntryPointArgument": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10280 + }, + "smithy.api#pattern": ".*\\S.*", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.emrserverless#EntryPointArguments": { + "type": "list", + "member": { + "target": "com.amazonaws.emrserverless#EntryPointArgument" + } + }, + "com.amazonaws.emrserverless#EntryPointPath": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": ".*\\S.*", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.emrserverless#GetApplication": { + "type": "operation", + "input": { + "target": "com.amazonaws.emrserverless#GetApplicationRequest" + }, + "output": { + "target": "com.amazonaws.emrserverless#GetApplicationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.emrserverless#InternalServerException" + }, + { + "target": "com.amazonaws.emrserverless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.emrserverless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Displays detailed information about a specified application.

", + "smithy.api#http": { + "method": "GET", + "uri": "/applications/{applicationId}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.emrserverless#GetApplicationRequest": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.emrserverless#ApplicationId", + "traits": { + "smithy.api#documentation": "

The ID of the application that will be described.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "applicationId" + } + } + } + }, + "com.amazonaws.emrserverless#GetApplicationResponse": { + "type": "structure", + "members": { + "application": { + "target": "com.amazonaws.emrserverless#Application", + "traits": { + "aws.cloudformation#cfnExcludeProperty": {}, + "smithy.api#documentation": "

The output displays information about the specified application.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.emrserverless#GetDashboardForJobRun": { + "type": "operation", + "input": { + "target": "com.amazonaws.emrserverless#GetDashboardForJobRunRequest" + }, + "output": { + "target": "com.amazonaws.emrserverless#GetDashboardForJobRunResponse" + }, + "errors": [ + { + "target": "com.amazonaws.emrserverless#InternalServerException" + }, + { + "target": "com.amazonaws.emrserverless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.emrserverless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates and returns a URL that you can use to access the application UIs for a job\n run.

\n

For jobs in a running state, the application UI is a live user interface such as the\n Spark or Tez web UI. For completed jobs, the application UI is a persistent application\n user interface such as the Spark History Server or persistent Tez UI.

\n \n

The URL is valid for one hour after you generate it. To access the application UI\n after that hour elapses, you must invoke the API again to generate a new URL.

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/applications/{applicationId}/jobruns/{jobRunId}/dashboard" + } + } + }, + "com.amazonaws.emrserverless#GetDashboardForJobRunRequest": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.emrserverless#ApplicationId", + "traits": { + "smithy.api#documentation": "

The ID of the application.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "applicationId" + } + }, + "jobRunId": { + "target": "com.amazonaws.emrserverless#JobRunId", + "traits": { + "smithy.api#documentation": "

The ID of the job run.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "jobRunId" + } + } + } + }, + "com.amazonaws.emrserverless#GetDashboardForJobRunResponse": { + "type": "structure", + "members": { + "url": { + "target": "com.amazonaws.emrserverless#Url", + "traits": { + "smithy.api#documentation": "

The URL to view job run's dashboard.

" + } + } + } + }, + "com.amazonaws.emrserverless#GetJobRun": { + "type": "operation", + "input": { + "target": "com.amazonaws.emrserverless#GetJobRunRequest" + }, + "output": { + "target": "com.amazonaws.emrserverless#GetJobRunResponse" + }, + "errors": [ + { + "target": "com.amazonaws.emrserverless#InternalServerException" + }, + { + "target": "com.amazonaws.emrserverless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.emrserverless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Displays detailed information about a job run.

", + "smithy.api#http": { + "method": "GET", + "uri": "/applications/{applicationId}/jobruns/{jobRunId}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.emrserverless#GetJobRunRequest": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.emrserverless#ApplicationId", + "traits": { + "smithy.api#documentation": "

The ID of the application on which the job run is submitted.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "applicationId" + } + }, + "jobRunId": { + "target": "com.amazonaws.emrserverless#JobRunId", + "traits": { + "smithy.api#documentation": "

The ID of the job run.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "jobRunId" + } + } + } + }, + "com.amazonaws.emrserverless#GetJobRunResponse": { + "type": "structure", + "members": { + "jobRun": { + "target": "com.amazonaws.emrserverless#JobRun", + "traits": { + "smithy.api#documentation": "

The output displays information about the job run.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.emrserverless#Hive": { + "type": "structure", + "members": { + "query": { + "target": "com.amazonaws.emrserverless#Query", + "traits": { + "smithy.api#documentation": "

The query for the Hive job run.

", + "smithy.api#required": {} + } + }, + "initQueryFile": { + "target": "com.amazonaws.emrserverless#InitScriptPath", + "traits": { + "smithy.api#documentation": "

The query file for the Hive job run.

" + } + }, + "parameters": { + "target": "com.amazonaws.emrserverless#HiveCliParameters", + "traits": { + "smithy.api#documentation": "

The parameters for the Hive job run.

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

The configurations for the Hive job driver.

" + } + }, + "com.amazonaws.emrserverless#HiveCliParameters": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 102400 + }, + "smithy.api#pattern": ".*\\S.*", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.emrserverless#IAMRoleArn": { + "type": "string", + "traits": { + "aws.api#arnReference": { + "type": "AWS::IAM::Role" + }, + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:(aws[a-zA-Z0-9-]*):iam::(\\d{12})?:(role((\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F))[\\w+=,.@-]+)$" + } + }, + "com.amazonaws.emrserverless#ImageConfiguration": { + "type": "structure", + "members": { + "imageUri": { + "target": "com.amazonaws.emrserverless#ImageUri", + "traits": { + "smithy.api#documentation": "

The image URI.

", + "smithy.api#required": {} + } + }, + "resolvedImageDigest": { + "target": "com.amazonaws.emrserverless#ImageDigest", + "traits": { + "smithy.api#documentation": "

The SHA256 digest of the image URI. This indicates which specific image the application\n is configured for. The image digest doesn't exist until an application has started.

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

The applied image configuration.

" + } + }, + "com.amazonaws.emrserverless#ImageConfigurationInput": { + "type": "structure", + "members": { + "imageUri": { + "target": "com.amazonaws.emrserverless#ImageUri", + "traits": { + "smithy.api#documentation": "

The URI of an image in the Amazon ECR registry. This field is required when you create a\n new application. If you leave this field blank in an update, Amazon EMR will remove\n the image configuration.

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

The image configuration.

" + } + }, + "com.amazonaws.emrserverless#ImageDigest": { + "type": "string", + "traits": { + "smithy.api#pattern": "^sha256:[0-9a-f]{64}$" + } + }, + "com.amazonaws.emrserverless#ImageUri": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^([a-z0-9]+[a-z0-9-.]*)\\/((?:[a-z0-9]+(?:[._-][a-z0-9]+)*\\/)*[a-z0-9]+(?:[._-][a-z0-9]+)*)(?:\\:([a-zA-Z0-9_][a-zA-Z0-9-._]{0,299})|@(sha256:[0-9a-f]{64}))$" + } + }, + "com.amazonaws.emrserverless#InitScriptPath": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": ".*\\S.*", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.emrserverless#InitialCapacityConfig": { + "type": "structure", + "members": { + "workerCount": { + "target": "com.amazonaws.emrserverless#WorkerCounts", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of workers in the initial capacity configuration.

", + "smithy.api#required": {} + } + }, + "workerConfiguration": { + "target": "com.amazonaws.emrserverless#WorkerResourceConfig", + "traits": { + "smithy.api#documentation": "

The resource configuration of the initial capacity configuration.

", + "smithy.api#recommended": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The initial capacity configuration per worker.

" + } + }, + "com.amazonaws.emrserverless#InitialCapacityConfigMap": { + "type": "map", + "key": { + "target": "com.amazonaws.emrserverless#WorkerTypeString" + }, + "value": { + "target": "com.amazonaws.emrserverless#InitialCapacityConfig" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, + "com.amazonaws.emrserverless#InteractiveConfiguration": { + "type": "structure", + "members": { + "studioEnabled": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Enables you to connect an application to Amazon EMR Studio to run interactive workloads in a notebook.

" + } + }, + "livyEndpointEnabled": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Enables an Apache Livy endpoint that you can connect to and run interactive jobs.

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

The configuration to use to enable the different types of interactive use cases in an application.

" + } + }, + "com.amazonaws.emrserverless#InternalServerException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.emrserverless#String1024", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Request processing failed because of an error or failure with the service.

", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.emrserverless#JobArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 60, + "max": 1024 + }, + "smithy.api#pattern": "^arn:(aws[a-zA-Z0-9-]*):emr-serverless:.+:(\\d{12}):\\/applications\\/[0-9a-zA-Z]+\\/jobruns\\/[0-9a-zA-Z]+$" + } + }, + "com.amazonaws.emrserverless#JobDriver": { + "type": "union", + "members": { + "sparkSubmit": { + "target": "com.amazonaws.emrserverless#SparkSubmit", + "traits": { + "smithy.api#documentation": "

The job driver parameters specified for Spark.

" + } + }, + "hive": { + "target": "com.amazonaws.emrserverless#Hive", + "traits": { + "smithy.api#documentation": "

The job driver parameters specified for Hive.

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

The driver that the job runs on.

" + } + }, + "com.amazonaws.emrserverless#JobRun": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.emrserverless#ApplicationId", + "traits": { + "smithy.api#documentation": "

The ID of the application the job is running on.

", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "applicationId" + } + }, + "jobRunId": { + "target": "com.amazonaws.emrserverless#JobRunId", + "traits": { + "smithy.api#documentation": "

The ID of the job run.

", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "jobRunId" + } + }, + "name": { + "target": "com.amazonaws.emrserverless#String256", + "traits": { + "smithy.api#documentation": "

The optional job run name. This doesn't have to be unique.

" + } + }, + "arn": { + "target": "com.amazonaws.emrserverless#JobArn", + "traits": { + "smithy.api#documentation": "

The execution role ARN of the job run.

", + "smithy.api#required": {} + } + }, + "createdBy": { + "target": "com.amazonaws.emrserverless#RequestIdentityUserArn", + "traits": { + "smithy.api#documentation": "

The user who created the job run.

", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.emrserverless#Date", + "traits": { + "smithy.api#documentation": "

The date and time when the job run was created.

", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.emrserverless#Date", + "traits": { + "smithy.api#documentation": "

The date and time when the job run was updated.

", + "smithy.api#required": {} + } + }, + "executionRole": { + "target": "com.amazonaws.emrserverless#IAMRoleArn", + "traits": { + "smithy.api#documentation": "

The execution role ARN of the job run.

", + "smithy.api#required": {} + } + }, + "state": { + "target": "com.amazonaws.emrserverless#JobRunState", + "traits": { + "smithy.api#documentation": "

The state of the job run.

", + "smithy.api#required": {} + } + }, + "stateDetails": { + "target": "com.amazonaws.emrserverless#String256", + "traits": { + "smithy.api#documentation": "

The state details of the job run.

", + "smithy.api#required": {} + } + }, + "releaseLabel": { + "target": "com.amazonaws.emrserverless#ReleaseLabel", + "traits": { + "smithy.api#documentation": "

The Amazon EMR release associated with the application your job is running\n on.

", + "smithy.api#required": {} + } + }, + "configurationOverrides": { + "target": "com.amazonaws.emrserverless#ConfigurationOverrides", + "traits": { + "smithy.api#documentation": "

The configuration settings that are used to override default configuration.

" + } + }, + "jobDriver": { + "target": "com.amazonaws.emrserverless#JobDriver", + "traits": { + "smithy.api#documentation": "

The job driver for the job run.

", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.emrserverless#TagMap", + "traits": { + "smithy.api#documentation": "

The tags assigned to the job run.

" + } + }, + "totalResourceUtilization": { + "target": "com.amazonaws.emrserverless#TotalResourceUtilization", + "traits": { + "smithy.api#documentation": "

The aggregate vCPU, memory, and storage resources used from the time the job starts to\n execute, until the time the job terminates, rounded up to the nearest second.

" + } + }, + "networkConfiguration": { + "target": "com.amazonaws.emrserverless#NetworkConfiguration" + }, + "totalExecutionDurationSeconds": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The job run total execution duration in seconds. This field is only available for job\n runs in a COMPLETED, FAILED, or CANCELLED\n state.

" + } + }, + "executionTimeoutMinutes": { + "target": "com.amazonaws.emrserverless#Duration", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

Returns the job run timeout value from the StartJobRun call. If no timeout\n was specified, then it returns the default timeout of 720 minutes.

" + } + }, + "billedResourceUtilization": { + "target": "com.amazonaws.emrserverless#ResourceUtilization", + "traits": { + "smithy.api#documentation": "

The aggregate vCPU, memory, and storage that Amazon Web Services has billed for the job\n run. The billed resources include a 1-minute minimum usage for workers, plus additional\n storage over 20 GB per worker. Note that billed resources do not include usage for idle\n pre-initialized workers.

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

Information about a job run. A job run is a unit of work, such as a Spark JAR, Hive\n query, or SparkSQL query, that you submit to an Amazon EMR Serverless\n application.

" + } + }, + "com.amazonaws.emrserverless#JobRunId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[0-9a-z]+$" + } + }, + "com.amazonaws.emrserverless#JobRunResource": { + "type": "resource", + "identifiers": { + "applicationId": { + "target": "com.amazonaws.emrserverless#ApplicationId" + }, + "jobRunId": { + "target": "com.amazonaws.emrserverless#JobRunId" + } + }, + "create": { + "target": "com.amazonaws.emrserverless#StartJobRun" + }, + "read": { + "target": "com.amazonaws.emrserverless#GetJobRun" + }, + "delete": { + "target": "com.amazonaws.emrserverless#CancelJobRun" + }, + "list": { + "target": "com.amazonaws.emrserverless#ListJobRuns" + }, + "operations": [ + { + "target": "com.amazonaws.emrserverless#GetDashboardForJobRun" + } + ] + }, + "com.amazonaws.emrserverless#JobRunState": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "SUBMITTED", + "name": "SUBMITTED" + }, + { + "value": "PENDING", + "name": "PENDING" + }, + { + "value": "SCHEDULED", + "name": "SCHEDULED" + }, + { + "value": "RUNNING", + "name": "RUNNING" + }, + { + "value": "SUCCESS", + "name": "SUCCESS" + }, + { + "value": "FAILED", + "name": "FAILED" + }, + { + "value": "CANCELLING", + "name": "CANCELLING" + }, + { + "value": "CANCELLED", + "name": "CANCELLED" + } + ] + } + }, + "com.amazonaws.emrserverless#JobRunStateSet": { + "type": "list", + "member": { + "target": "com.amazonaws.emrserverless#JobRunState" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 8 + }, + "smithy.api#uniqueItems": {} + } + }, + "com.amazonaws.emrserverless#JobRunSummary": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.emrserverless#ApplicationId", + "traits": { + "smithy.api#documentation": "

The ID of the application the job is running on.

", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "applicationId" + } + }, + "id": { + "target": "com.amazonaws.emrserverless#JobRunId", + "traits": { + "smithy.api#documentation": "

The ID of the job run.

", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "jobRunId" + } + }, + "name": { + "target": "com.amazonaws.emrserverless#String256", + "traits": { + "smithy.api#documentation": "

The optional job run name. This doesn't have to be unique.

" + } + }, + "arn": { + "target": "com.amazonaws.emrserverless#JobArn", + "traits": { + "smithy.api#documentation": "

The ARN of the job run.

", + "smithy.api#required": {} + } + }, + "createdBy": { + "target": "com.amazonaws.emrserverless#RequestIdentityUserArn", + "traits": { + "smithy.api#documentation": "

The user who created the job run.

", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.emrserverless#Date", + "traits": { + "smithy.api#documentation": "

The date and time when the job run was created.

", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "com.amazonaws.emrserverless#Date", + "traits": { + "smithy.api#documentation": "

The date and time when the job run was last updated.

", + "smithy.api#required": {} + } + }, + "executionRole": { + "target": "com.amazonaws.emrserverless#IAMRoleArn", + "traits": { + "smithy.api#documentation": "

The execution role ARN of the job run.

", + "smithy.api#required": {} + } + }, + "state": { + "target": "com.amazonaws.emrserverless#JobRunState", + "traits": { + "smithy.api#documentation": "

The state of the job run.

", + "smithy.api#required": {} + } + }, + "stateDetails": { + "target": "com.amazonaws.emrserverless#String256", + "traits": { + "smithy.api#documentation": "

The state details of the job run.

", + "smithy.api#required": {} + } + }, + "releaseLabel": { + "target": "com.amazonaws.emrserverless#ReleaseLabel", + "traits": { + "smithy.api#documentation": "

The Amazon EMR release associated with the application your job is running\n on.

", + "smithy.api#required": {} + } + }, + "type": { + "target": "com.amazonaws.emrserverless#JobRunType", + "traits": { + "smithy.api#documentation": "

The type of job run, such as Spark or Hive.

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

The summary of attributes associated with a job run.

" + } + }, + "com.amazonaws.emrserverless#JobRunType": { + "type": "string" + }, + "com.amazonaws.emrserverless#JobRuns": { + "type": "list", + "member": { + "target": "com.amazonaws.emrserverless#JobRunSummary" + } + }, + "com.amazonaws.emrserverless#ListApplications": { + "type": "operation", + "input": { + "target": "com.amazonaws.emrserverless#ListApplicationsRequest" + }, + "output": { + "target": "com.amazonaws.emrserverless#ListApplicationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.emrserverless#InternalServerException" + }, + { + "target": "com.amazonaws.emrserverless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists applications based on a set of parameters.

", + "smithy.api#http": { + "method": "GET", + "uri": "/applications" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "applications" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.emrserverless#ListApplicationsRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.emrserverless#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next set of application results.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The maximum number of applications that can be listed.

", + "smithy.api#httpQuery": "maxResults", + "smithy.api#range": { + "min": 1, + "max": 50 + } + } + }, + "states": { + "target": "com.amazonaws.emrserverless#ApplicationStateSet", + "traits": { + "smithy.api#documentation": "

An optional filter for application states. Note that if this filter contains multiple\n states, the resulting list will be grouped by the state.

", + "smithy.api#httpQuery": "states" + } + } + } + }, + "com.amazonaws.emrserverless#ListApplicationsResponse": { + "type": "structure", + "members": { + "applications": { + "target": "com.amazonaws.emrserverless#ApplicationList", + "traits": { + "smithy.api#documentation": "

The output lists the specified applications.

", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.emrserverless#NextToken", + "traits": { + "smithy.api#documentation": "

The output displays the token for the next set of application results. This is required\n for pagination and is available as a response of the previous request.

" + } + } + } + }, + "com.amazonaws.emrserverless#ListJobRuns": { + "type": "operation", + "input": { + "target": "com.amazonaws.emrserverless#ListJobRunsRequest" + }, + "output": { + "target": "com.amazonaws.emrserverless#ListJobRunsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.emrserverless#InternalServerException" + }, + { + "target": "com.amazonaws.emrserverless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists job runs based on a set of parameters.

", + "smithy.api#http": { + "method": "GET", + "uri": "/applications/{applicationId}/jobruns" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "jobRuns" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.emrserverless#ListJobRunsRequest": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.emrserverless#ApplicationId", + "traits": { + "smithy.api#documentation": "

The ID of the application for which to list the job run.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "applicationId" + } + }, + "nextToken": { + "target": "com.amazonaws.emrserverless#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next set of job run results.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The maximum number of job runs that can be listed.

", + "smithy.api#httpQuery": "maxResults", + "smithy.api#range": { + "min": 1, + "max": 50 + } + } + }, + "createdAtAfter": { + "target": "com.amazonaws.emrserverless#Date", + "traits": { + "smithy.api#documentation": "

The lower bound of the option to filter by creation date and time.

", + "smithy.api#httpQuery": "createdAtAfter" + } + }, + "createdAtBefore": { + "target": "com.amazonaws.emrserverless#Date", + "traits": { + "smithy.api#documentation": "

The upper bound of the option to filter by creation date and time.

", + "smithy.api#httpQuery": "createdAtBefore" + } + }, + "states": { + "target": "com.amazonaws.emrserverless#JobRunStateSet", + "traits": { + "smithy.api#documentation": "

An optional filter for job run states. Note that if this filter contains multiple\n states, the resulting list will be grouped by the state.

", + "smithy.api#httpQuery": "states" + } + } + } + }, + "com.amazonaws.emrserverless#ListJobRunsResponse": { + "type": "structure", + "members": { + "jobRuns": { + "target": "com.amazonaws.emrserverless#JobRuns", + "traits": { + "smithy.api#documentation": "

The output lists information about the specified job runs.

", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.emrserverless#NextToken", + "traits": { + "smithy.api#documentation": "

The output displays the token for the next set of job run results. This is required for\n pagination and is available as a response of the previous request.

" + } + } + } + }, + "com.amazonaws.emrserverless#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.emrserverless#ListTagsForResourceRequest" + }, + "output": { + "target": "com.amazonaws.emrserverless#ListTagsForResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.emrserverless#InternalServerException" + }, + { + "target": "com.amazonaws.emrserverless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.emrserverless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the tags assigned to the resources.

", + "smithy.api#http": { + "method": "GET", + "uri": "/tags/{resourceArn}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.emrserverless#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.emrserverless#ResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that identifies the resource to list the tags for.\n Currently, the supported resources are Amazon EMR Serverless applications and job\n runs.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.emrserverless#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "tags": { + "target": "com.amazonaws.emrserverless#TagMap", + "traits": { + "smithy.api#documentation": "

The tags for the resource.

" + } + } + } + }, + "com.amazonaws.emrserverless#LogGroupName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + }, + "smithy.api#pattern": "^[\\.\\-_/#A-Za-z0-9]+$" + } + }, + "com.amazonaws.emrserverless#LogStreamNamePrefix": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + }, + "smithy.api#pattern": "^[^:*]*$" + } + }, + "com.amazonaws.emrserverless#LogTypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.emrserverless#LogTypeString" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.emrserverless#LogTypeMap": { + "type": "map", + "key": { + "target": "com.amazonaws.emrserverless#WorkerTypeString" + }, + "value": { + "target": "com.amazonaws.emrserverless#LogTypeList" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 4 + } + } + }, + "com.amazonaws.emrserverless#LogTypeString": { + "type": "string", + "traits": { + "smithy.api#documentation": "Log type for a Spark/Hive job-run.", + "smithy.api#length": { + "min": 1, + "max": 50 + }, + "smithy.api#pattern": "^[a-zA-Z]+[-_]*[a-zA-Z]+$" + } + }, + "com.amazonaws.emrserverless#ManagedPersistenceMonitoringConfiguration": { + "type": "structure", + "members": { + "enabled": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Enables managed logging and defaults to true. If set to false, managed logging will be\n turned off.

" + } + }, + "encryptionKeyArn": { + "target": "com.amazonaws.emrserverless#EncryptionKeyArn", + "traits": { + "smithy.api#documentation": "

The KMS key ARN to encrypt the logs stored in managed log persistence.

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

The managed log persistence configuration for a job run.

" + } + }, + "com.amazonaws.emrserverless#MaximumAllowedResources": { + "type": "structure", + "members": { + "cpu": { + "target": "com.amazonaws.emrserverless#CpuSize", + "traits": { + "smithy.api#documentation": "

The maximum allowed CPU for an application.

", + "smithy.api#required": {} + } + }, + "memory": { + "target": "com.amazonaws.emrserverless#MemorySize", + "traits": { + "smithy.api#documentation": "

The maximum allowed resources for an application.

", + "smithy.api#required": {} + } + }, + "disk": { + "target": "com.amazonaws.emrserverless#DiskSize", + "traits": { + "smithy.api#documentation": "

The maximum allowed disk for an application.

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

The maximum allowed cumulative resources for an application. No new resources will be\n created once the limit is hit.

" + } + }, + "com.amazonaws.emrserverless#MemorySize": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 15 + }, + "smithy.api#pattern": "^[1-9][0-9]*(\\s)?(GB|gb|gB|Gb)?$" + } + }, + "com.amazonaws.emrserverless#MonitoringConfiguration": { + "type": "structure", + "members": { + "s3MonitoringConfiguration": { + "target": "com.amazonaws.emrserverless#S3MonitoringConfiguration", + "traits": { + "smithy.api#documentation": "

The Amazon S3 configuration for monitoring log publishing.

" + } + }, + "managedPersistenceMonitoringConfiguration": { + "target": "com.amazonaws.emrserverless#ManagedPersistenceMonitoringConfiguration", + "traits": { + "smithy.api#documentation": "

The managed log persistence configuration for a job run.

" + } + }, + "cloudWatchLoggingConfiguration": { + "target": "com.amazonaws.emrserverless#CloudWatchLoggingConfiguration", + "traits": { + "smithy.api#documentation": "

The Amazon CloudWatch configuration for monitoring logs. You can configure your jobs\n to send log information to CloudWatch.

" + } + }, + "prometheusMonitoringConfiguration": { + "target": "com.amazonaws.emrserverless#PrometheusMonitoringConfiguration", + "traits": { + "smithy.api#documentation": "

The monitoring configuration object you can configure to send metrics to Amazon Managed Service for Prometheus for a job run.

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

The configuration setting for monitoring.

" + } + }, + "com.amazonaws.emrserverless#NetworkConfiguration": { + "type": "structure", + "members": { + "subnetIds": { + "target": "com.amazonaws.emrserverless#SubnetIds", + "traits": { + "smithy.api#documentation": "

The array of subnet Ids for customer VPC connectivity.

" + } + }, + "securityGroupIds": { + "target": "com.amazonaws.emrserverless#SecurityGroupIds", + "traits": { + "smithy.api#documentation": "

The array of security group Ids for customer VPC connectivity.

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

The network configuration for customer VPC connectivity.

" + } + }, + "com.amazonaws.emrserverless#NextToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^[A-Za-z0-9_=-]+$" + } + }, + "com.amazonaws.emrserverless#PrometheusMonitoringConfiguration": { + "type": "structure", + "members": { + "remoteWriteUrl": { + "target": "com.amazonaws.emrserverless#PrometheusUrlString", + "traits": { + "smithy.api#documentation": "

The remote write URL in the Amazon Managed Service for Prometheus workspace to send metrics to.

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

The monitoring configuration object you can configure to send metrics to Amazon Managed Service for Prometheus for a job run.

" + } + }, + "com.amazonaws.emrserverless#PrometheusUrlString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10280 + }, + "smithy.api#pattern": "^https://aps-workspaces.([a-z]{2}-[a-z-]{1,20}-[1-9]).amazonaws(.[0-9A-Za-z]{2,4})+/workspaces/[-_.0-9A-Za-z]{1,100}/api/v1/remote_write$" + } + }, + "com.amazonaws.emrserverless#Query": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10280 + }, + "smithy.api#pattern": ".*\\S.*", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.emrserverless#ReleaseLabel": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[A-Za-z0-9._/-]+$" + } + }, + "com.amazonaws.emrserverless#RequestIdentityUserArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:(aws[a-zA-Z0-9-]*):(iam|sts)::(\\d{12})?:[\\w/+=,.@-]+$" + } + }, + "com.amazonaws.emrserverless#ResourceArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 60, + "max": 1024 + }, + "smithy.api#pattern": "^arn:(aws[a-zA-Z0-9-]*):emr-serverless:.+:(\\d{12}):\\/applications\\/[0-9a-zA-Z]+(\\/jobruns\\/[0-9a-zA-Z]+)?$" + } + }, + "com.amazonaws.emrserverless#ResourceNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.emrserverless#String1024", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The specified resource was not found.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.emrserverless#ResourceUtilization": { + "type": "structure", + "members": { + "vCPUHour": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "

The aggregated vCPU used per hour from the time the job starts executing until the job\n is terminated.

" + } + }, + "memoryGBHour": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "

The aggregated memory used per hour from the time the job starts executing until the job\n is terminated.

" + } + }, + "storageGBHour": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "

The aggregated storage used per hour from the time the job starts executing until the\n job is terminated.

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

The resource utilization for memory, storage, and vCPU for jobs.

" + } + }, + "com.amazonaws.emrserverless#S3MonitoringConfiguration": { + "type": "structure", + "members": { + "logUri": { + "target": "com.amazonaws.emrserverless#UriString", + "traits": { + "smithy.api#documentation": "

The Amazon S3 destination URI for log publishing.

" + } + }, + "encryptionKeyArn": { + "target": "com.amazonaws.emrserverless#EncryptionKeyArn", + "traits": { + "smithy.api#documentation": "

The KMS key ARN to encrypt the logs published to the given Amazon S3 destination.

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

The Amazon S3 configuration for monitoring log publishing. You can configure your jobs\n to send log information to Amazon S3.

" + } + }, + "com.amazonaws.emrserverless#SecurityGroupIds": { + "type": "list", + "member": { + "target": "com.amazonaws.emrserverless#SecurityGroupString" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 5 + } + } + }, + "com.amazonaws.emrserverless#SecurityGroupString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 32 + }, + "smithy.api#pattern": "^[-0-9a-zA-Z]+" + } + }, + "com.amazonaws.emrserverless#SensitivePropertiesMap": { + "type": "map", + "key": { + "target": "com.amazonaws.emrserverless#ConfigurationPropertyKey" + }, + "value": { + "target": "com.amazonaws.emrserverless#ConfigurationPropertyValue" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.emrserverless#ServiceQuotaExceededException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.emrserverless#String1024", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The maximum number of resources per account has been reached.

", + "smithy.api#error": "client", + "smithy.api#httpError": 402 + } + }, + "com.amazonaws.emrserverless#SparkSubmit": { + "type": "structure", + "members": { + "entryPoint": { + "target": "com.amazonaws.emrserverless#EntryPointPath", + "traits": { + "smithy.api#documentation": "

The entry point for the Spark submit job run.

", + "smithy.api#required": {} + } + }, + "entryPointArguments": { + "target": "com.amazonaws.emrserverless#EntryPointArguments", + "traits": { + "smithy.api#documentation": "

The arguments for the Spark submit job run.

" + } + }, + "sparkSubmitParameters": { + "target": "com.amazonaws.emrserverless#SparkSubmitParameters", + "traits": { + "smithy.api#documentation": "

The parameters for the Spark submit job run.

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

The configurations for the Spark submit job driver.

" + } + }, + "com.amazonaws.emrserverless#SparkSubmitParameters": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 102400 + }, + "smithy.api#pattern": ".*\\S.*", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.emrserverless#StartApplication": { + "type": "operation", + "input": { + "target": "com.amazonaws.emrserverless#StartApplicationRequest" + }, + "output": { + "target": "com.amazonaws.emrserverless#StartApplicationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.emrserverless#InternalServerException" + }, + { + "target": "com.amazonaws.emrserverless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.emrserverless#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.emrserverless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Starts a specified application and initializes initial capacity if configured.

", + "smithy.api#http": { + "method": "POST", + "uri": "/applications/{applicationId}/start" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.emrserverless#StartApplicationRequest": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.emrserverless#ApplicationId", + "traits": { + "smithy.api#documentation": "

The ID of the application to start.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "applicationId" + } + } + } + }, + "com.amazonaws.emrserverless#StartApplicationResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.emrserverless#StartJobRun": { + "type": "operation", + "input": { + "target": "com.amazonaws.emrserverless#StartJobRunRequest" + }, + "output": { + "target": "com.amazonaws.emrserverless#StartJobRunResponse" + }, + "errors": [ + { + "target": "com.amazonaws.emrserverless#ConflictException" + }, + { + "target": "com.amazonaws.emrserverless#InternalServerException" + }, + { + "target": "com.amazonaws.emrserverless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.emrserverless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Starts a job run.

", + "smithy.api#http": { + "method": "POST", + "uri": "/applications/{applicationId}/jobruns" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.emrserverless#StartJobRunRequest": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.emrserverless#ApplicationId", + "traits": { + "smithy.api#documentation": "

The ID of the application on which to run the job.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "applicationId" + } + }, + "clientToken": { + "target": "com.amazonaws.emrserverless#ClientToken", + "traits": { + "smithy.api#documentation": "

The client idempotency token of the job run to start. Its value must be unique for each\n request.

", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + }, + "executionRoleArn": { + "target": "com.amazonaws.emrserverless#IAMRoleArn", + "traits": { + "smithy.api#documentation": "

The execution role ARN for the job run.

", + "smithy.api#required": {} + } + }, + "jobDriver": { + "target": "com.amazonaws.emrserverless#JobDriver", + "traits": { + "smithy.api#documentation": "

The job driver for the job run.

" + } + }, + "configurationOverrides": { + "target": "com.amazonaws.emrserverless#ConfigurationOverrides", + "traits": { + "smithy.api#documentation": "

The configuration overrides for the job run.

" + } + }, + "tags": { + "target": "com.amazonaws.emrserverless#TagMap", + "traits": { + "smithy.api#documentation": "

The tags assigned to the job run.

" + } + }, + "executionTimeoutMinutes": { + "target": "com.amazonaws.emrserverless#Duration", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The maximum duration for the job run to run. If the job run runs beyond this duration,\n it will be automatically cancelled.

" + } + }, + "name": { + "target": "com.amazonaws.emrserverless#String256", + "traits": { + "smithy.api#documentation": "

The optional job run name. This doesn't have to be unique.

" + } + } + } + }, + "com.amazonaws.emrserverless#StartJobRunResponse": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.emrserverless#ApplicationId", + "traits": { + "smithy.api#documentation": "

This output displays the application ID on which the job run was submitted.

", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "applicationId" + } + }, + "jobRunId": { + "target": "com.amazonaws.emrserverless#JobRunId", + "traits": { + "smithy.api#documentation": "

The output contains the ID of the started job run.

", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "jobRunId" + } + }, + "arn": { + "target": "com.amazonaws.emrserverless#JobArn", + "traits": { + "smithy.api#documentation": "

This output displays the ARN of the job run..

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.emrserverless#StopApplication": { + "type": "operation", + "input": { + "target": "com.amazonaws.emrserverless#StopApplicationRequest" + }, + "output": { + "target": "com.amazonaws.emrserverless#StopApplicationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.emrserverless#InternalServerException" + }, + { + "target": "com.amazonaws.emrserverless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.emrserverless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Stops a specified application and releases initial capacity if configured. All scheduled\n and running jobs must be completed or cancelled before stopping an application.

", + "smithy.api#http": { + "method": "POST", + "uri": "/applications/{applicationId}/stop" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.emrserverless#StopApplicationRequest": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.emrserverless#ApplicationId", + "traits": { + "smithy.api#documentation": "

The ID of the application to stop.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "applicationId" + } + } + } + }, + "com.amazonaws.emrserverless#StopApplicationResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.emrserverless#String1024": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": ".*\\S.*" + } + }, + "com.amazonaws.emrserverless#String256": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": ".*\\S.*" + } + }, + "com.amazonaws.emrserverless#SubnetIds": { + "type": "list", + "member": { + "target": "com.amazonaws.emrserverless#SubnetString" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 16 + } + } + }, + "com.amazonaws.emrserverless#SubnetString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 32 + }, + "smithy.api#pattern": "^[-0-9a-zA-Z]+" + } + }, + "com.amazonaws.emrserverless#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[A-Za-z0-9 /_.:=+@-]+$" + } + }, + "com.amazonaws.emrserverless#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.emrserverless#TagKey" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + } + } + }, + "com.amazonaws.emrserverless#TagMap": { + "type": "map", + "key": { + "target": "com.amazonaws.emrserverless#TagKey" + }, + "value": { + "target": "com.amazonaws.emrserverless#TagValue" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.emrserverless#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.emrserverless#TagResourceRequest" + }, + "output": { + "target": "com.amazonaws.emrserverless#TagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.emrserverless#InternalServerException" + }, + { + "target": "com.amazonaws.emrserverless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.emrserverless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Assigns tags to resources. A tag is a label that you assign to an Amazon Web Services\n resource. Each tag consists of a key and an optional value, both of which you define. Tags\n enable you to categorize your Amazon Web Services resources by attributes such as purpose,\n owner, or environment. When you have many resources of the same type, you can quickly\n identify a specific resource based on the tags you've assigned to it.

", + "smithy.api#http": { + "method": "POST", + "uri": "/tags/{resourceArn}" + } + } + }, + "com.amazonaws.emrserverless#TagResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.emrserverless#ResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that identifies the resource to list the tags for.\n Currently, the supported resources are Amazon EMR Serverless applications and job\n runs.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.emrserverless#TagMap", + "traits": { + "smithy.api#documentation": "

The tags to add to the resource. A tag is an array of key-value pairs.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.emrserverless#TagResourceResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.emrserverless#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^[A-Za-z0-9 /_.:=+@-]*$" + } + }, + "com.amazonaws.emrserverless#TotalResourceUtilization": { + "type": "structure", + "members": { + "vCPUHour": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "

The aggregated vCPU used per hour from the time job start executing till the time job is\n terminated.

" + } + }, + "memoryGBHour": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "

The aggregated memory used per hour from the time job start executing till the time job\n is terminated.

" + } + }, + "storageGBHour": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "

The aggregated storage used per hour from the time job start executing till the time job\n is terminated.

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

The aggregate vCPU, memory, and storage resources used from the time job start executing\n till the time job is terminated, rounded up to the nearest second.

" + } + }, + "com.amazonaws.emrserverless#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.emrserverless#UntagResourceRequest" + }, + "output": { + "target": "com.amazonaws.emrserverless#UntagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.emrserverless#InternalServerException" + }, + { + "target": "com.amazonaws.emrserverless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.emrserverless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Removes tags from resources.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/tags/{resourceArn}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.emrserverless#UntagResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.emrserverless#ResourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that identifies the resource to list the tags for.\n Currently, the supported resources are Amazon EMR Serverless applications and job\n runs.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "tagKeys": { + "target": "com.amazonaws.emrserverless#TagKeyList", + "traits": { + "smithy.api#documentation": "

The keys of the tags to be removed.

", + "smithy.api#httpQuery": "tagKeys", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.emrserverless#UntagResourceResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.emrserverless#UpdateApplication": { + "type": "operation", + "input": { + "target": "com.amazonaws.emrserverless#UpdateApplicationRequest" + }, + "output": { + "target": "com.amazonaws.emrserverless#UpdateApplicationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.emrserverless#InternalServerException" + }, + { + "target": "com.amazonaws.emrserverless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.emrserverless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates a specified application. An application has to be in a stopped or created state\n in order to be updated.

", + "smithy.api#http": { + "method": "PATCH", + "uri": "/applications/{applicationId}" + } + } + }, + "com.amazonaws.emrserverless#UpdateApplicationRequest": { + "type": "structure", + "members": { + "applicationId": { + "target": "com.amazonaws.emrserverless#ApplicationId", + "traits": { + "smithy.api#documentation": "

The ID of the application to update.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "applicationId" + } + }, + "clientToken": { + "target": "com.amazonaws.emrserverless#ClientToken", + "traits": { + "smithy.api#documentation": "

The client idempotency token of the application to update. Its value must be unique for\n each request.

", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + }, + "initialCapacity": { + "target": "com.amazonaws.emrserverless#InitialCapacityConfigMap", + "traits": { + "smithy.api#documentation": "

The capacity to initialize when the application is updated.

" + } + }, + "maximumCapacity": { + "target": "com.amazonaws.emrserverless#MaximumAllowedResources", + "traits": { + "smithy.api#documentation": "

The maximum capacity to allocate when the application is updated. This is cumulative\n across all workers at any given point in time during the lifespan of the application. No\n new resources will be created once any one of the defined limits is hit.

" + } + }, + "autoStartConfiguration": { + "target": "com.amazonaws.emrserverless#AutoStartConfig", + "traits": { + "smithy.api#documentation": "

The configuration for an application to automatically start on job submission.

" + } + }, + "autoStopConfiguration": { + "target": "com.amazonaws.emrserverless#AutoStopConfig", + "traits": { + "smithy.api#documentation": "

The configuration for an application to automatically stop after a certain amount of\n time being idle.

" + } + }, + "networkConfiguration": { + "target": "com.amazonaws.emrserverless#NetworkConfiguration" + }, + "architecture": { + "target": "com.amazonaws.emrserverless#Architecture", + "traits": { + "smithy.api#documentation": "

The CPU architecture of an application.

" + } + }, + "imageConfiguration": { + "target": "com.amazonaws.emrserverless#ImageConfigurationInput", + "traits": { + "smithy.api#documentation": "

The image configuration to be used for all worker types. You can either set this\n parameter or imageConfiguration for each worker type in\n WorkerTypeSpecificationInput.

" + } + }, + "workerTypeSpecifications": { + "target": "com.amazonaws.emrserverless#WorkerTypeSpecificationInputMap", + "traits": { + "smithy.api#documentation": "

The key-value pairs that specify worker type to\n WorkerTypeSpecificationInput. This parameter must contain all valid worker\n types for a Spark or Hive application. Valid worker types include Driver and\n Executor for Spark applications and HiveDriver and\n TezTask for Hive applications. You can either set image details in this\n parameter for each worker type, or in imageConfiguration for all worker\n types.

" + } + }, + "interactiveConfiguration": { + "target": "com.amazonaws.emrserverless#InteractiveConfiguration", + "traits": { + "smithy.api#documentation": "

The interactive configuration object that contains new interactive use cases \n when the application is updated.

" + } + }, + "releaseLabel": { + "target": "com.amazonaws.emrserverless#ReleaseLabel", + "traits": { + "smithy.api#documentation": "

The Amazon EMR release label for the application. You can change the release\n label to use a different release of Amazon EMR.

" + } + }, + "runtimeConfiguration": { + "target": "com.amazonaws.emrserverless#ConfigurationList", + "traits": { + "smithy.api#documentation": "

The Configuration \n specifications to use when updating an application. Each configuration consists of a classification and properties.\n This configuration is applied across all the job runs submitted under the application.

" + } + }, + "monitoringConfiguration": { + "target": "com.amazonaws.emrserverless#MonitoringConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration setting for monitoring.

" + } + } + } + }, + "com.amazonaws.emrserverless#UpdateApplicationResponse": { + "type": "structure", + "members": { + "application": { + "target": "com.amazonaws.emrserverless#Application", + "traits": { + "smithy.api#documentation": "

Information about the updated application.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.emrserverless#UriString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10280 + }, + "smithy.api#pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDBFF-\\uDC00\\uDFFF\\r\\n\\t]*" + } + }, + "com.amazonaws.emrserverless#Url": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, + "com.amazonaws.emrserverless#ValidationException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.emrserverless#String1024", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The input fails to satisfy the constraints specified by an Amazon Web Services\n service.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.emrserverless#WorkerCounts": { + "type": "long", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 1, + "max": 1000000 + } + } + }, + "com.amazonaws.emrserverless#WorkerResourceConfig": { + "type": "structure", + "members": { + "cpu": { + "target": "com.amazonaws.emrserverless#CpuSize", + "traits": { + "smithy.api#documentation": "

The CPU requirements for every worker instance of the worker type.

", + "smithy.api#required": {} + } + }, + "memory": { + "target": "com.amazonaws.emrserverless#MemorySize", + "traits": { + "smithy.api#documentation": "

The memory requirements for every worker instance of the worker type.

", + "smithy.api#required": {} + } + }, + "disk": { + "target": "com.amazonaws.emrserverless#DiskSize", + "traits": { + "smithy.api#documentation": "

The disk requirements for every worker instance of the worker type.

" + } + }, + "diskType": { + "target": "com.amazonaws.emrserverless#DiskType", + "traits": { + "smithy.api#documentation": "

The disk type for every worker instance of the work type. Shuffle optimized disks have higher performance \n characteristics and are better for shuffle heavy workloads. Default is STANDARD.

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

The cumulative configuration requirements for every worker instance of the worker\n type.

" + } + }, + "com.amazonaws.emrserverless#WorkerTypeSpecification": { + "type": "structure", + "members": { + "imageConfiguration": { + "target": "com.amazonaws.emrserverless#ImageConfiguration", + "traits": { + "smithy.api#documentation": "

The image configuration for a worker type.

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

The specifications for a worker type.

" + } + }, + "com.amazonaws.emrserverless#WorkerTypeSpecificationInput": { + "type": "structure", + "members": { + "imageConfiguration": { + "target": "com.amazonaws.emrserverless#ImageConfigurationInput", + "traits": { + "smithy.api#documentation": "

The image configuration for a worker type.

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

The specifications for a worker type.

" + } + }, + "com.amazonaws.emrserverless#WorkerTypeSpecificationInputMap": { + "type": "map", + "key": { + "target": "com.amazonaws.emrserverless#WorkerTypeString" + }, + "value": { + "target": "com.amazonaws.emrserverless#WorkerTypeSpecificationInput" + } + }, + "com.amazonaws.emrserverless#WorkerTypeSpecificationMap": { + "type": "map", + "key": { + "target": "com.amazonaws.emrserverless#WorkerTypeString" + }, + "value": { + "target": "com.amazonaws.emrserverless#WorkerTypeSpecification" + } + }, + "com.amazonaws.emrserverless#WorkerTypeString": { + "type": "string", + "traits": { + "smithy.api#documentation": "Worker type for an analytics framework.", + "smithy.api#length": { + "min": 1, + "max": 50 + }, + "smithy.api#pattern": "^[a-zA-Z]+[-_]*[a-zA-Z]+$" + } } - }, - "traits": { - "smithy.api#documentation": "

The specifications for a worker type.

" - } - }, - "com.amazonaws.emrserverless#WorkerTypeSpecificationInputMap": { - "type": "map", - "key": { - "target": "com.amazonaws.emrserverless#WorkerTypeString" - }, - "value": { - "target": "com.amazonaws.emrserverless#WorkerTypeSpecificationInput" - } - }, - "com.amazonaws.emrserverless#WorkerTypeSpecificationMap": { - "type": "map", - "key": { - "target": "com.amazonaws.emrserverless#WorkerTypeString" - }, - "value": { - "target": "com.amazonaws.emrserverless#WorkerTypeSpecification" - } - }, - "com.amazonaws.emrserverless#WorkerTypeString": { - "type": "string", - "traits": { - "smithy.api#documentation": "Worker type for an analytics framework.", - "smithy.api#length": { - "min": 1, - "max": 50 - }, - "smithy.api#pattern": "^[a-zA-Z]+[-_]*[a-zA-Z]+$" - } } - } -} +} \ No newline at end of file diff --git a/codegen/sdk-codegen/aws-models/opsworks.json b/codegen/sdk-codegen/aws-models/opsworks.json index 65928718b311..042be462c60d 100644 --- a/codegen/sdk-codegen/aws-models/opsworks.json +++ b/codegen/sdk-codegen/aws-models/opsworks.json @@ -1,9603 +1,9603 @@ { - "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. However, the size of the associated data structure - which includes the variable names, values, and protected flag values - cannot exceed 20 KB. This limit should accommodate most if not all use cases, but if you do exceed it, you will cause an exception (API) with an \"Environment: is too large (maximum is 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 AWS 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 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 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. AWS OpsWorks Stacks does not support \n Application Load Balancer. You can only use Classic Load Balancer with AWS 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 Elastic\n 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 AWS OpsWorks Stacks should ignore metrics\n and suppress additional scaling events. For example, AWS 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 AWS 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, 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 AWS 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 AWS 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 AWS OpsWorks Stacks starts or 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 AWS 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.

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

The cloned stack AWS region, such as \"ap-northeast-2\". For more information about AWS 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 AWS OpsWorks Stacks infers the value of the other parameter. If you specify neither parameter, AWS 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 AWS 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 AWS Identity and Access Management (IAM) role, which allows AWS OpsWorks Stacks to work with AWS\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 AWS OpsWorks 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 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. 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 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 For more information about supported operating systems,\n see AWS 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 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 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 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 AWS OpsWorks Stacks built-in security groups with the stack's layers.

\n

AWS 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 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, AWS\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 AWS 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 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. 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 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 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. 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 Amazon CloudWatch logs configuration for a layer. For detailed information about members of this data type, 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. 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. AWS 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 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 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. 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.

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

For more information about the supported operating systems,\n see AWS 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. For more information about supported operating\n systems, see Operating SystemsFor more information about how to use custom AMIs with AWS 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 default subnet ID value and direct AWS 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 AWS 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. 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, inherit tenancy settings from the VPC. The following are valid values for this parameter: dedicated, default, or host. Because there are costs associated with changes in tenancy options, we recommend that you research tenancy options before choosing them for your instances. For more information about dedicated hosts, see Dedicated Hosts Overview and Amazon EC2 Dedicated Hosts. For more information about dedicated instances, see Dedicated Instances and Amazon EC2 Dedicated Instances.

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

", - "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 AWS OpsWorks Stacks and by Chef recipes. The short name is also used as the name for the directory where your app files are installed. It can have a maximum of 200 characters, which are limited to the alphanumeric characters, '-', '_', and '.'.

\n

The built-in layers' short names are defined by AWS OpsWorks Stacks. For more information, see the 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, 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 AWS 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.

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

The stack's AWS region, such as ap-south-1. For more information about\n Amazon regions, see Regions and Endpoints.

\n \n

In the AWS CLI, this API maps to the --stack-region parameter. If the\n --stack-region parameter and the AWS 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 AWS 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 AWS, we recommend\n that you use regional endpoints for new stacks. The AWS CLI common\n --region parameter always specifies a regional API endpoint; it\n cannot be used to specify a classic AWS 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 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 AWS OpsWorks Stacks infers the value of the \n other parameter. If you specify neither parameter, AWS 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 AWS 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 AWS Identity and Access Management (IAM) role, which allows AWS OpsWorks Stacks to work with AWS\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 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 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 For more information about supported operating systems,\n see AWS 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 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 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.

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

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

\n

AWS 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, AWS\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 AWS 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, 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, AWS OpsWorks Stacks removes them. For example,\n my.name will be changed to myname. If you do not specify an SSH\n user name, AWS 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 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 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 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 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 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 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 2016.09, set Args to the\n following.

\n

\n { \"upgrade_os_to\":[\"Amazon Linux 2016.09\"], \"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 then be registered by another\n 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#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 a registered Amazon EC2 or on-premises instance. This action removes the \n instance from the stack and returns it to your control. This action cannot be used with \n instances that were created with AWS OpsWorks Stacks.

\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 AWS OpsWorks Stacks volume ID, which is the GUID that AWS OpsWorks Stacks assigned to the instance when you registered the volume with the stack, not the Amazon EC2 volume ID.

", - "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 AWS 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, 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, 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 - } - } + "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" + } ], - "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" - } - } - } + "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" + } ], - "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, AWS 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" - } - } - } + "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" + } ], - "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" - } - } - } + "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" + } ], - "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" - } - } - } + "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" + } ], - "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" - } - } - } + "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" + } ], - "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 AWS 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 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 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 AWS 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 AWS 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,\n DescribeStacks returns a description of every stack.

" - } - } - }, - "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 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. AWS 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.

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

The domain.

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

The AWS 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's name.

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

The instance's AWS 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 that the instance is associated with.

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

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

" - } - }, - "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 that the Elastic Load Balancing instance is managing traffic for.

" - } - } - }, - "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. 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, 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 will be returned by the DescribeApps action.\n To conceal an environment variable's value, set Secure to true.\n DescribeApps then 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 AWS 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, the user will no longer be able to use the credentials to log in. If the user is logged in at the time, he or she automatically will be logged out.

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

" - } - }, - "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 then update\n your 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, 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 AWS 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.

" - } - }, - "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, AWS OpsWorks Stacks returns *****FILTERED*****\n instead of the actual value

\n

For an ECS Cluster layer, AWS 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": "

AWS OpsWorks Stacks supports five lifecycle events: setup, configuration, \n deploy, undeploy, and shutdown.\n For each layer, AWS 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. AWS 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 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 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 AWS 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 AWS 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 2018.03.

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

The ID of a supported operating system, such as Amazon Linux 2018.03.

" - } - }, - "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 AWS 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 AWS 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 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" + "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" + } }, - { - "target": "com.amazonaws.opsworks#AssignVolume" + "com.amazonaws.opsworks#MaxResults": { + "type": "integer", + "traits": { + "smithy.api#default": 0 + } }, - { - "target": "com.amazonaws.opsworks#AssociateElasticIp" + "com.amazonaws.opsworks#Minute": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } }, - { - "target": "com.amazonaws.opsworks#AttachElasticLoadBalancer" + "com.amazonaws.opsworks#NextToken": { + "type": "string" }, - { - "target": "com.amazonaws.opsworks#CloneStack" + "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.

" + } }, - { - "target": "com.amazonaws.opsworks#CreateApp" + "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.

" + } }, - { - "target": "com.amazonaws.opsworks#CreateDeployment" + "com.amazonaws.opsworks#OperatingSystemConfigurationManagers": { + "type": "list", + "member": { + "target": "com.amazonaws.opsworks#OperatingSystemConfigurationManager" + } }, - { - "target": "com.amazonaws.opsworks#CreateInstance" + "com.amazonaws.opsworks#OperatingSystems": { + "type": "list", + "member": { + "target": "com.amazonaws.opsworks#OperatingSystem" + } }, - { - "target": "com.amazonaws.opsworks#CreateLayer" + "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" + } + } }, - { - "target": "com.amazonaws.opsworks#CreateStack" + "com.amazonaws.opsworks#Parameters": { + "type": "map", + "key": { + "target": "com.amazonaws.opsworks#String" + }, + "value": { + "target": "com.amazonaws.opsworks#String" + } }, - { - "target": "com.amazonaws.opsworks#CreateUserProfile" + "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.

" + } }, - { - "target": "com.amazonaws.opsworks#DeleteApp" + "com.amazonaws.opsworks#Permissions": { + "type": "list", + "member": { + "target": "com.amazonaws.opsworks#Permission" + } }, - { - "target": "com.amazonaws.opsworks#DeleteInstance" + "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.

" + } }, - { - "target": "com.amazonaws.opsworks#DeleteLayer" + "com.amazonaws.opsworks#RaidArrays": { + "type": "list", + "member": { + "target": "com.amazonaws.opsworks#RaidArray" + } }, - { - "target": "com.amazonaws.opsworks#DeleteStack" + "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.

" + } }, - { - "target": "com.amazonaws.opsworks#DeleteUserProfile" + "com.amazonaws.opsworks#RdsDbInstances": { + "type": "list", + "member": { + "target": "com.amazonaws.opsworks#RdsDbInstance" + } }, - { - "target": "com.amazonaws.opsworks#DeregisterEcsCluster" + "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.

" + } }, - { - "target": "com.amazonaws.opsworks#DeregisterElasticIp" + "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": {} + } }, - { - "target": "com.amazonaws.opsworks#DeregisterInstance" + "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.

" + } }, - { - "target": "com.amazonaws.opsworks#DeregisterRdsDbInstance" + "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.

" + } }, - { - "target": "com.amazonaws.opsworks#DeregisterVolume" + "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": {} + } }, - { - "target": "com.amazonaws.opsworks#DescribeAgentVersions" + "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": {} + } }, - { - "target": "com.amazonaws.opsworks#DescribeApps" + "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.

" + } }, - { - "target": "com.amazonaws.opsworks#DescribeCommands" + "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": {} + } }, - { - "target": "com.amazonaws.opsworks#DescribeDeployments" + "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": {} + } }, - { - "target": "com.amazonaws.opsworks#DescribeEcsClusters" + "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.

" + } }, - { - "target": "com.amazonaws.opsworks#DescribeElasticIps" + "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": {} + } }, - { - "target": "com.amazonaws.opsworks#DescribeElasticLoadBalancers" + "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": {} + } }, - { - "target": "com.amazonaws.opsworks#DescribeInstances" + "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.

" + } }, - { - "target": "com.amazonaws.opsworks#DescribeLayers" + "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": {} + } }, - { - "target": "com.amazonaws.opsworks#DescribeLoadBasedAutoScaling" + "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.

" + } }, - { - "target": "com.amazonaws.opsworks#DescribeMyUserProfile" + "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": {} + } }, - { - "target": "com.amazonaws.opsworks#DescribeOperatingSystems" + "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": {} + } }, - { - "target": "com.amazonaws.opsworks#DescribePermissions" + "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.

" + } }, - { - "target": "com.amazonaws.opsworks#DescribeRaidArrays" + "com.amazonaws.opsworks#ResourceArn": { + "type": "string" }, - { - "target": "com.amazonaws.opsworks#DescribeRdsDbInstances" + "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" + } }, - { - "target": "com.amazonaws.opsworks#DescribeServiceErrors" + "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" + } + } + } }, - { - "target": "com.amazonaws.opsworks#DescribeStackProvisioningParameters" + "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.

" + } }, - { - "target": "com.amazonaws.opsworks#DescribeStacks" + "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.

" + } }, - { - "target": "com.amazonaws.opsworks#DescribeStackSummary" + "com.amazonaws.opsworks#ServiceErrors": { + "type": "list", + "member": { + "target": "com.amazonaws.opsworks#ServiceError" + } }, - { - "target": "com.amazonaws.opsworks#DescribeTimeBasedAutoScaling" + "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.

" + } }, - { - "target": "com.amazonaws.opsworks#DescribeUserProfiles" + "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": {} + } }, - { - "target": "com.amazonaws.opsworks#DescribeVolumes" + "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.

" + } }, - { - "target": "com.amazonaws.opsworks#DetachElasticLoadBalancer" + "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": {} + } }, - { - "target": "com.amazonaws.opsworks#DisassociateElasticIp" + "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.

" + } }, - { - "target": "com.amazonaws.opsworks#GetHostnameSuggestion" + "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": {} + } }, - { - "target": "com.amazonaws.opsworks#GrantAccess" + "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.

" + } }, - { - "target": "com.amazonaws.opsworks#ListTags" + "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.

" + } }, - { - "target": "com.amazonaws.opsworks#RebootInstance" + "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" + } + } + } }, - { - "target": "com.amazonaws.opsworks#RegisterEcsCluster" + "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.

" + } }, - { - "target": "com.amazonaws.opsworks#RegisterElasticIp" + "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.

" + } }, - { - "target": "com.amazonaws.opsworks#RegisterInstance" + "com.amazonaws.opsworks#StackAttributes": { + "type": "map", + "key": { + "target": "com.amazonaws.opsworks#StackAttributesKeys" + }, + "value": { + "target": "com.amazonaws.opsworks#String" + } }, - { - "target": "com.amazonaws.opsworks#RegisterRdsDbInstance" + "com.amazonaws.opsworks#StackAttributesKeys": { + "type": "enum", + "members": { + "Color": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Color" + } + } + } }, - { - "target": "com.amazonaws.opsworks#RegisterVolume" + "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.

" + } }, - { - "target": "com.amazonaws.opsworks#SetLoadBasedAutoScaling" + "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.

" + } }, - { - "target": "com.amazonaws.opsworks#SetPermission" + "com.amazonaws.opsworks#Stacks": { + "type": "list", + "member": { + "target": "com.amazonaws.opsworks#Stack" + } }, - { - "target": "com.amazonaws.opsworks#SetTimeBasedAutoScaling" + "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.

" + } }, - { - "target": "com.amazonaws.opsworks#StartInstance" + "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": {} + } }, - { - "target": "com.amazonaws.opsworks#StartStack" + "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.

" + } }, - { - "target": "com.amazonaws.opsworks#StopInstance" + "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": {} + } }, - { - "target": "com.amazonaws.opsworks#StopStack" + "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.

" + } }, - { - "target": "com.amazonaws.opsworks#TagResource" + "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": {} + } }, - { - "target": "com.amazonaws.opsworks#UnassignInstance" + "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.

" + } }, - { - "target": "com.amazonaws.opsworks#UnassignVolume" + "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": {} + } }, - { - "target": "com.amazonaws.opsworks#UntagResource" + "com.amazonaws.opsworks#String": { + "type": "string" }, - { - "target": "com.amazonaws.opsworks#UpdateApp" + "com.amazonaws.opsworks#Strings": { + "type": "list", + "member": { + "target": "com.amazonaws.opsworks#String" + } }, - { - "target": "com.amazonaws.opsworks#UpdateElasticIp" + "com.amazonaws.opsworks#Switch": { + "type": "string" }, - { - "target": "com.amazonaws.opsworks#UpdateInstance" + "com.amazonaws.opsworks#TagKey": { + "type": "string" }, - { - "target": "com.amazonaws.opsworks#UpdateLayer" + "com.amazonaws.opsworks#TagKeys": { + "type": "list", + "member": { + "target": "com.amazonaws.opsworks#TagKey" + } }, - { - "target": "com.amazonaws.opsworks#UpdateMyUserProfile" + "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.

" + } }, - { - "target": "com.amazonaws.opsworks#UpdateRdsDbInstance" + "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": {} + } }, - { - "target": "com.amazonaws.opsworks#UpdateStack" + "com.amazonaws.opsworks#TagValue": { + "type": "string" }, - { - "target": "com.amazonaws.opsworks#UpdateUserProfile" + "com.amazonaws.opsworks#Tags": { + "type": "map", + "key": { + "target": "com.amazonaws.opsworks#TagKey" + }, + "value": { + "target": "com.amazonaws.opsworks#TagValue" + } }, - { - "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": "AWS OpsWorks\n

Welcome to the AWS OpsWorks Stacks API Reference. This guide provides descriptions, syntax, and\n usage examples for AWS OpsWorks Stacks actions and data types, including common parameters and error\n codes.

\n

AWS OpsWorks Stacks is an application management service that provides an integrated experience for\n overseeing the complete application lifecycle. For information about this product, go to the\n AWS OpsWorks details page.

\n\n

\n SDKs and CLI\n

\n

The most common way to use the AWS OpsWorks Stacks API is by using the AWS Command Line Interface (CLI) or by using one of the AWS SDKs to implement applications in your preferred language. For more information, see:

\n \n\n

\n Endpoints\n

\n

AWS OpsWorks Stacks supports the following endpoints, all HTTPS. You must connect to one of the following endpoints. Stacks \n 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 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" + "com.amazonaws.opsworks#TemporaryCredential": { + "type": "structure", + "members": { + "Username": { + "target": "com.amazonaws.opsworks#String", + "traits": { + "smithy.api#documentation": "

The user name.

" } - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] + }, + "Password": { + "target": "com.amazonaws.opsworks#String", + "traits": { + "smithy.api#documentation": "

The password.

" } - ], - "error": "Invalid Configuration: FIPS and custom endpoint are not supported", - "type": "error" }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] + "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.

" } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" - }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" + "InstanceId": { + "target": "com.amazonaws.opsworks#String", + "traits": { + "smithy.api#documentation": "

The instance's OpsWorks Stacks ID.

" + } } - ], - "type": "tree" }, - { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Region" + "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.

" } - ] } - ], - "rules": [ + }, + "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": [ { - "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" + "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": {} } - ], - "type": "tree" } - ], - "type": "tree" }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" + "traits": { + "smithy.api#input": {} } - ] }, - "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 - } + "com.amazonaws.opsworks#UnassignVolume": { + "type": "operation", + "input": { + "target": "com.amazonaws.opsworks#UnassignVolumeRequest" }, - { - "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 - } + "output": { + "target": "smithy.api#Unit" }, - { - "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 - } + "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": {} + } + } }, - { - "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 - } + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.opsworks#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.opsworks#UntagResourceRequest" }, - { - "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 - } + "output": { + "target": "smithy.api#Unit" }, - { - "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 - } + "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": {} + } + } }, - { - "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 - } + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.opsworks#UpdateApp": { + "type": "operation", + "input": { + "target": "com.amazonaws.opsworks#UpdateAppRequest" }, - { - "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 - } + "output": { + "target": "smithy.api#Unit" }, - { - "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 - } + "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 " + } + } }, - { - "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 - } + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.opsworks#UpdateElasticIp": { + "type": "operation", + "input": { + "target": "com.amazonaws.opsworks#UpdateElasticIpRequest" }, - { - "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 - } + "output": { + "target": "smithy.api#Unit" }, - { - "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 - } + "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.

" + } + } }, - { - "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 - } + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.opsworks#UpdateInstance": { + "type": "operation", + "input": { + "target": "com.amazonaws.opsworks#UpdateInstanceRequest" }, - { - "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 - } + "output": { + "target": "smithy.api#Unit" }, - { - "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 - } + "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.

" + } + } }, - { - "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 - } + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.opsworks#UpdateLayer": { + "type": "operation", + "input": { + "target": "com.amazonaws.opsworks#UpdateLayerRequest" }, - { - "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 - } + "output": { + "target": "smithy.api#Unit" }, - { - "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 - } + "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": "

" + } + } }, - { - "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 - } + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.opsworks#UpdateMyUserProfile": { + "type": "operation", + "input": { + "target": "com.amazonaws.opsworks#UpdateMyUserProfileRequest" }, - { - "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 - } + "output": { + "target": "smithy.api#Unit" }, - { - "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 - } + "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.

" + } + } }, - { - "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 - } + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.opsworks#UpdateRdsDbInstance": { + "type": "operation", + "input": { + "target": "com.amazonaws.opsworks#UpdateRdsDbInstanceRequest" }, - { - "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 - } + "output": { + "target": "smithy.api#Unit" }, - { - "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 - } + "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.

" + } + } }, - { - "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 - } + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.opsworks#UpdateStack": { + "type": "operation", + "input": { + "target": "com.amazonaws.opsworks#UpdateStackRequest" }, - { - "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 - } + "output": { + "target": "smithy.api#Unit" }, - { - "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 - } + "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 " + } + } }, - { - "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 - } + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.opsworks#UpdateUserProfile": { + "type": "operation", + "input": { + "target": "com.amazonaws.opsworks#UpdateUserProfileRequest" }, - { - "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 - } + "output": { + "target": "smithy.api#Unit" }, - { - "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 - } + "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.

" + } + } }, - { - "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 - } + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.opsworks#UpdateVolume": { + "type": "operation", + "input": { + "target": "com.amazonaws.opsworks#UpdateVolumeRequest" }, - { - "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 - } + "output": { + "target": "smithy.api#Unit" }, - { - "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 - } + "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.

" + } + } }, - { - "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 - } + "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.

" + } + } }, - { - "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" - } + "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.

" + } + } }, - { - "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" - } + "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.

" + } + } }, - { - "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" - } + "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.

" + } + } }, - { - "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" - } + "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.

" + } + } }, - { - "documentation": "Missing region", - "expect": { - "error": "Invalid Configuration: Missing Region" - } + "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

" } - ], - "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 AWS 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 DB 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": "

AWS OpsWorks Stacks returns *****FILTERED***** instead of the actual value.

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

The instance's AWS 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 AWS OpsWorks Stacks is unable to discover the Amazon RDS instance. AWS 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": "

AWS OpsWorks Stacks supports five\n lifecycle events:\n setup, configuration, deploy, undeploy, and shutdown. For\n each layer, AWS 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. AWS 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\n

To specify a recipe, use the cookbook's directory name in the repository followed by two colons and the recipe name, which is the recipe's file name without the .rb extension. For example: phpapp2::dbsetup specifies the dbsetup.rb recipe in 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 AWS 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 AWS 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 AWS CLI register command, which performs the entire\n registration operation. For more information,\n see \n Registering an Instance with an AWS OpsWorks Stacks Stack.

\n \n

Registered instances have the same requirements as instances that are created by using the CreateInstance 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 hostname.

" - } - }, - "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 AWS 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 AWS 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. Load-based auto scaling operates only on the instances from that set, so you must ensure that you have created enough instances to handle the maximum anticipated load.

\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, AWS 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, AWS 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 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 AWS OpsWorks Stacks will wait after triggering a Shutdown event before 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 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, AWS 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, AWS OpsWorks Stacks returns *****FILTERED***** instead of the actual value.

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

The application's version. AWS OpsWorks Stacks enables you to easily deploy new versions of an application. One of the simplest approaches is to have branches or revisions in your repository that represent different versions that can potentially be deployed.

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

" - } - }, - "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 AWS region, such as \"ap-northeast-2\". For more information about AWS 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 AWS 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. You can use custom JSON to override the corresponding default stack configuration attribute values or to pass data to recipes. The string should be in the following format:

\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 AWS 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 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.

" - } - }, - "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. The default value for Linux stacks is 11.4.

" - } - } - }, - "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 AWS OpsWorks Stacks 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 AWS OpsWorks Stacks 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 AWS OpsWorks Stacks. For more information about how tagging works, see Tags in the AWS 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, the user will no longer be able to use the credentials to log in. If they are logged in at the time, they will be automatically logged out.

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

The instance's AWS 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 AWS 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 - 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 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.

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

" - } - }, - "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 a custom AMI.

\n \n

For more information about supported operating systems,\n see AWS 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 supported operating\n systems, see Operating Systems. 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 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 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 AWS 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.

" - } - }, - "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 AWS OpsWorks Stacks and by Chef. The short name is also used as the name for the directory where your app files are installed. It can have a maximum of 200 characters and must be in the following format: /\\A[a-z0-9\\-\\_\\.]+\\Z/.

\n

The built-in layers' short names are defined by AWS OpsWorks Stacks. For more information, see the Layer Reference\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, 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.

" - } - }, - "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 For more information about supported operating systems,\n see AWS 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 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 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 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 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 AWS 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 AWS OpsWorks Stacks built-in security groups with the stack's layers.

\n

AWS 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 AWS 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 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, AWS OpsWorks Stacks removes them. For example,\n my.name will be changed to myname. If you do not specify an SSH\n user name, AWS 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 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.

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

" - } - }, - "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 AWS region. For more information about AWS regions, see 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, 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

" - } } - } }