{ "smithy": "2.0", "shapes": { "com.amazonaws.launchwizard#AccountConstraint": { "type": "union", "members": { "managementAccount": { "target": "com.amazonaws.launchwizard#ManagementAccountConstraint" }, "delegatedAdmin": { "target": "com.amazonaws.launchwizard#DelegatedAdminConstraint" } }, "traits": { "smithy.api#documentation": "A constraint on which AWS account a deployment can be initiated from. Specify one of the supported constraint types." } }, "com.amazonaws.launchwizard#AccountConstraintsList": { "type": "list", "member": { "target": "com.amazonaws.launchwizard#AccountConstraint" }, "traits": { "smithy.api#length": { "min": 0, "max": 10 }, "smithy.api#uniqueItems": {} } }, "com.amazonaws.launchwizard#AllowedValues": { "type": "list", "member": { "target": "com.amazonaws.launchwizard#ValueString" } }, "com.amazonaws.launchwizard#CreateDeployment": { "type": "operation", "input": { "target": "com.amazonaws.launchwizard#CreateDeploymentInput" }, "output": { "target": "com.amazonaws.launchwizard#CreateDeploymentOutput" }, "errors": [ { "target": "com.amazonaws.launchwizard#InternalServerException" }, { "target": "com.amazonaws.launchwizard#ResourceLimitException" }, { "target": "com.amazonaws.launchwizard#ResourceNotFoundException" }, { "target": "com.amazonaws.launchwizard#ValidationException" } ], "traits": { "smithy.api#documentation": "
Creates a deployment for the given workload. Deployments created by this operation are not available in the Launch Wizard console to use the Clone deployment action on.
The name of the workload. You can use the ListWorkloads operation to discover supported values for this parameter.
The name of the deployment pattern supported by a given workload. You can use the ListWorkloadDeploymentPatterns operation to discover supported values for this parameter.
The name of the deployment.
", "smithy.api#required": {} } }, "specifications": { "target": "com.amazonaws.launchwizard#DeploymentSpecifications", "traits": { "smithy.api#documentation": "The settings specified for the deployment. These settings define how to deploy and configure your resources created by the deployment. For more information about the specifications required for creating a deployment for a SAP workload, see SAP deployment specifications. To retrieve the specifications required to create a deployment for other workloads, use the GetWorkloadDeploymentPattern operation.
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
The tags to add to the deployment.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.launchwizard#CreateDeploymentOutput": { "type": "structure", "members": { "deploymentId": { "target": "com.amazonaws.launchwizard#DeploymentId", "traits": { "smithy.api#documentation": "The ID of the deployment.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.launchwizard#DelegatedAdminConstraint": { "type": "structure", "members": { "servicePrincipal": { "target": "com.amazonaws.launchwizard#ServicePrincipalType", "traits": { "smithy.api#documentation": "The service principal for which the account must be a delegated administrator. For example, `stacksets.cloudformation.amazonaws.com`.", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The deployment must be initiated from a delegated administrator account for the specified service principal." } }, "com.amazonaws.launchwizard#DeleteDeployment": { "type": "operation", "input": { "target": "com.amazonaws.launchwizard#DeleteDeploymentInput" }, "output": { "target": "com.amazonaws.launchwizard#DeleteDeploymentOutput" }, "errors": [ { "target": "com.amazonaws.launchwizard#InternalServerException" }, { "target": "com.amazonaws.launchwizard#ResourceLimitException" }, { "target": "com.amazonaws.launchwizard#ResourceNotFoundException" }, { "target": "com.amazonaws.launchwizard#ValidationException" } ], "traits": { "smithy.api#documentation": "Deletes a deployment.
", "smithy.api#examples": [ { "title": "Delete a deployment.", "input": { "deploymentId": "4c1b59c1-659c-467f-b6e9-6ef6f9d28e1d" }, "output": { "status": "DELETED", "statusReason": "Finished processing DeleteApp request" } } ], "smithy.api#http": { "code": 200, "method": "POST", "uri": "/deleteDeployment" }, "smithy.api#idempotent": {} } }, "com.amazonaws.launchwizard#DeleteDeploymentInput": { "type": "structure", "members": { "deploymentId": { "target": "com.amazonaws.launchwizard#DeploymentId", "traits": { "smithy.api#documentation": "The ID of the deployment.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.launchwizard#DeleteDeploymentOutput": { "type": "structure", "members": { "status": { "target": "com.amazonaws.launchwizard#DeploymentStatus", "traits": { "smithy.api#documentation": "The status of the deployment.
" } }, "statusReason": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The reason for the deployment status.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.launchwizard#Deployment": { "type": "resource", "identifiers": { "deploymentId": { "target": "com.amazonaws.launchwizard#DeploymentId" } }, "create": { "target": "com.amazonaws.launchwizard#CreateDeployment" }, "read": { "target": "com.amazonaws.launchwizard#GetDeployment" }, "update": { "target": "com.amazonaws.launchwizard#UpdateDeployment" }, "delete": { "target": "com.amazonaws.launchwizard#DeleteDeployment" }, "list": { "target": "com.amazonaws.launchwizard#ListDeployments" }, "resources": [ { "target": "com.amazonaws.launchwizard#DeploymentEvent" } ] }, "com.amazonaws.launchwizard#DeploymentConditionalField": { "type": "structure", "members": { "name": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The name of the deployment condition.
" } }, "value": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The value of the condition.
" } }, "comparator": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The comparator of the condition.
Valid values: Equal | NotEqual
A field that details a condition of the specifications for a deployment.
" } }, "com.amazonaws.launchwizard#DeploymentData": { "type": "structure", "members": { "name": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The name of the deployment.
" } }, "id": { "target": "com.amazonaws.launchwizard#DeploymentId", "traits": { "smithy.api#documentation": "The ID of the deployment.
" } }, "workloadName": { "target": "com.amazonaws.launchwizard#WorkloadName", "traits": { "smithy.api#documentation": "The name of the workload.
" } }, "patternName": { "target": "com.amazonaws.launchwizard#DeploymentPatternName", "traits": { "smithy.api#documentation": "The pattern name of the deployment.
" } }, "status": { "target": "com.amazonaws.launchwizard#DeploymentStatus", "traits": { "smithy.api#documentation": "The status of the deployment.
" } }, "createdAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The time the deployment was created.
" } }, "modifiedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The time the deployment was last modified.
" } }, "specifications": { "target": "com.amazonaws.launchwizard#DeploymentSpecifications", "traits": { "smithy.api#documentation": "The settings specified for the deployment. These settings define how to deploy and configure your resources created by the deployment. For more information about the specifications required for creating a deployment for a SAP workload, see SAP deployment specifications. To retrieve the specifications required to create a deployment for other workloads, use the GetWorkloadDeploymentPattern operation.
The resource group of the deployment.
" } }, "deletedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The time the deployment was deleted.
" } }, "tags": { "target": "com.amazonaws.launchwizard#Tags", "traits": { "smithy.api#documentation": "Information about the tags attached to a deployment.
" } }, "deploymentArn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the deployment.
" } } }, "traits": { "smithy.api#documentation": "The data associated with a deployment.
" } }, "com.amazonaws.launchwizard#DeploymentDataSummary": { "type": "structure", "members": { "name": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The name of the deployment
" } }, "id": { "target": "com.amazonaws.launchwizard#DeploymentId", "traits": { "smithy.api#documentation": "The ID of the deployment.
" } }, "workloadName": { "target": "com.amazonaws.launchwizard#WorkloadName", "traits": { "smithy.api#documentation": "The name of the workload.
" } }, "patternName": { "target": "com.amazonaws.launchwizard#DeploymentPatternName", "traits": { "smithy.api#documentation": "The name of the workload deployment pattern.
" } }, "status": { "target": "com.amazonaws.launchwizard#DeploymentStatus", "traits": { "smithy.api#documentation": "The status of the deployment.
" } }, "createdAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The time the deployment was created.
" } }, "modifiedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The time the deployment was last modified.
" } } }, "traits": { "smithy.api#documentation": "A summary of the deployment data.
" } }, "com.amazonaws.launchwizard#DeploymentDataSummaryList": { "type": "list", "member": { "target": "com.amazonaws.launchwizard#DeploymentDataSummary" } }, "com.amazonaws.launchwizard#DeploymentEvent": { "type": "resource", "identifiers": { "deploymentId": { "target": "com.amazonaws.launchwizard#DeploymentId" }, "eventId": { "target": "com.amazonaws.launchwizard#EventId" } }, "list": { "target": "com.amazonaws.launchwizard#ListDeploymentEvents" } }, "com.amazonaws.launchwizard#DeploymentEventDataSummary": { "type": "structure", "members": { "name": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The name of the deployment event.
" } }, "description": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The description of the deployment event.
" } }, "status": { "target": "com.amazonaws.launchwizard#EventStatus", "traits": { "smithy.api#documentation": "The status of the deployment event.
" } }, "statusReason": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The reason of the deployment event status.
" } }, "timestamp": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The timestamp of the deployment event.
" } }, "metadata": { "target": "com.amazonaws.launchwizard#DeploymentEventMetadata" } }, "traits": { "smithy.api#documentation": "A summary of the deployment event data.
" } }, "com.amazonaws.launchwizard#DeploymentEventDataSummaryList": { "type": "list", "member": { "target": "com.amazonaws.launchwizard#DeploymentEventDataSummary" } }, "com.amazonaws.launchwizard#DeploymentEventMetadata": { "type": "map", "key": { "target": "com.amazonaws.launchwizard#DeploymentEventMetadataKey" }, "value": { "target": "com.amazonaws.launchwizard#DeploymentEventMetadataValue" }, "traits": { "smithy.api#documentation": "A map of metadata key-value pairs associated with a deployment event.\nFor error detection events, contains workload context and log excerpts used for troubleshooting.", "smithy.api#length": { "max": 25 } } }, "com.amazonaws.launchwizard#DeploymentEventMetadataKey": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^[a-zA-Z0-9_.-]+$" } }, "com.amazonaws.launchwizard#DeploymentEventMetadataValue": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 4096 } } }, "com.amazonaws.launchwizard#DeploymentFilter": { "type": "structure", "members": { "name": { "target": "com.amazonaws.launchwizard#DeploymentFilterKey", "traits": { "smithy.api#documentation": "The name of the filter. Filter names are case-sensitive.
" } }, "values": { "target": "com.amazonaws.launchwizard#DeploymentFilterValues", "traits": { "smithy.api#documentation": "The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.
A filter name and value pair that is used to return more specific results from a describe operation. Filters can be used to match a set of resources by specific criteria.
" } }, "com.amazonaws.launchwizard#DeploymentFilterKey": { "type": "enum", "members": { "WORKLOAD_NAME": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "WORKLOAD_NAME" } }, "DEPLOYMENT_STATUS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DEPLOYMENT_STATUS" } } } }, "com.amazonaws.launchwizard#DeploymentFilterList": { "type": "list", "member": { "target": "com.amazonaws.launchwizard#DeploymentFilter" }, "traits": { "smithy.api#length": { "min": 1 } } }, "com.amazonaws.launchwizard#DeploymentFilterValue": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 100 }, "smithy.api#pattern": "(^(([A-Za-z])+([0-9A-Za-z\\-\\_])+)$)" } }, "com.amazonaws.launchwizard#DeploymentFilterValues": { "type": "list", "member": { "target": "com.amazonaws.launchwizard#DeploymentFilterValue", "traits": { "smithy.api#length": { "min": 1, "max": 100 } } } }, "com.amazonaws.launchwizard#DeploymentId": { "type": "string", "traits": { "smithy.api#length": { "min": 2, "max": 128 }, "smithy.api#pattern": "^[a-zA-Z0-9-]+$" } }, "com.amazonaws.launchwizard#DeploymentName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 50 }, "smithy.api#pattern": "^[A-Za-z0-9_\\.-]+$" } }, "com.amazonaws.launchwizard#DeploymentPatternName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 }, "smithy.api#pattern": "^[A-Za-z0-9][a-zA-Z0-9-]*$" } }, "com.amazonaws.launchwizard#DeploymentPatternVersion": { "type": "resource", "identifiers": { "workloadName": { "target": "com.amazonaws.launchwizard#WorkloadName" }, "deploymentPatternName": { "target": "com.amazonaws.launchwizard#DeploymentPatternName" }, "deploymentPatternVersionName": { "target": "com.amazonaws.launchwizard#DeploymentPatternVersionName" } }, "read": { "target": "com.amazonaws.launchwizard#GetDeploymentPatternVersion" }, "list": { "target": "com.amazonaws.launchwizard#ListDeploymentPatternVersions" } }, "com.amazonaws.launchwizard#DeploymentPatternVersionDataSummary": { "type": "structure", "members": { "deploymentPatternVersionName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The name of the deployment pattern version.
" } }, "description": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The description of the deployment pattern version.
" } }, "documentationUrl": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The URL of the documentation for the deployment pattern version.
" } }, "workloadName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The name of the workload.
" } }, "deploymentPatternName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The name of the deployment pattern.
" } } }, "traits": { "smithy.api#documentation": "Describes a deployment pattern version summary.
" } }, "com.amazonaws.launchwizard#DeploymentPatternVersionDataSummaryList": { "type": "list", "member": { "target": "com.amazonaws.launchwizard#DeploymentPatternVersionDataSummary" } }, "com.amazonaws.launchwizard#DeploymentPatternVersionFilter": { "type": "structure", "members": { "name": { "target": "com.amazonaws.launchwizard#DeploymentPatternVersionFilterKey", "traits": { "smithy.api#documentation": "The name of the filter attribute. Specifies which attribute to filter on when querying deployment pattern versions.
", "smithy.api#required": {} } }, "values": { "target": "com.amazonaws.launchwizard#DeploymentPatternVersionFilterValues", "traits": { "smithy.api#documentation": "The values to filter by. Contains the specific values to match against when filtering deployment pattern versions.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A filter for deployment pattern versions. Use this filter to specify criteria for querying deployment pattern versions in Launch Wizard.
" } }, "com.amazonaws.launchwizard#DeploymentPatternVersionFilterKey": { "type": "enum", "members": { "DEPLOYMENT_PATTERN_VERSION_NAME": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "updateFromVersion" } } } }, "com.amazonaws.launchwizard#DeploymentPatternVersionFilterValue": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 100 }, "smithy.api#pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)$" } }, "com.amazonaws.launchwizard#DeploymentPatternVersionFilterValues": { "type": "list", "member": { "target": "com.amazonaws.launchwizard#DeploymentPatternVersionFilterValue", "traits": { "smithy.api#length": { "min": 1, "max": 100 } } } }, "com.amazonaws.launchwizard#DeploymentPatternVersionName": { "type": "string", "traits": { "smithy.api#length": { "min": 5, "max": 30 }, "smithy.api#pattern": "^(([A-Za-z0-9][a-zA-Z0-9-]*)|(\\d+\\.\\d+\\.\\d+))$" } }, "com.amazonaws.launchwizard#DeploymentSpecifications": { "type": "map", "key": { "target": "com.amazonaws.launchwizard#KeyString" }, "value": { "target": "com.amazonaws.launchwizard#ValueString" }, "traits": { "smithy.api#length": { "min": 1, "max": 100 }, "smithy.api#sensitive": {} } }, "com.amazonaws.launchwizard#DeploymentSpecificationsData": { "type": "list", "member": { "target": "com.amazonaws.launchwizard#DeploymentSpecificationsField" }, "traits": { "smithy.api#length": { "min": 1, "max": 100 } } }, "com.amazonaws.launchwizard#DeploymentSpecificationsField": { "type": "structure", "members": { "name": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The name of the deployment specification.
" } }, "description": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The description of the deployment specification.
" } }, "allowedValues": { "target": "com.amazonaws.launchwizard#AllowedValues", "traits": { "smithy.api#documentation": "The allowed values of the deployment specification.
" } }, "required": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Indicates if the deployment specification is required.
" } }, "conditionals": { "target": "com.amazonaws.launchwizard#SpecificationsConditionalData", "traits": { "smithy.api#documentation": "The conditionals used for the deployment specification.
" } } }, "traits": { "smithy.api#documentation": "A field that details a specification of a deployment pattern.
" } }, "com.amazonaws.launchwizard#DeploymentStatus": { "type": "enum", "members": { "COMPLETED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "COMPLETED" } }, "CREATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CREATING" } }, "DELETE_IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETE_IN_PROGRESS" } }, "DELETE_INITIATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETE_INITIATING" } }, "DELETE_FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETE_FAILED" } }, "DELETED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETED" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } }, "IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IN_PROGRESS" } }, "VALIDATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "VALIDATING" } }, "UPDATE_IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UPDATE_IN_PROGRESS" } }, "UPDATE_COMPLETED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UPDATE_COMPLETED" } }, "UPDATE_FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UPDATE_FAILED" } }, "UPDATE_ROLLBACK_COMPLETED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UPDATE_ROLLBACK_COMPLETED" } }, "UPDATE_ROLLBACK_FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UPDATE_ROLLBACK_FAILED" } } } }, "com.amazonaws.launchwizard#EventId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 32 } } }, "com.amazonaws.launchwizard#EventStatus": { "type": "enum", "members": { "CANCELED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CANCELED" } }, "CANCELING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CANCELING" } }, "COMPLETED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "COMPLETED" } }, "CREATED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CREATED" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } }, "IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IN_PROGRESS" } }, "PENDING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PENDING" } }, "TIMED_OUT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TIMED_OUT" } } } }, "com.amazonaws.launchwizard#FilterList": { "type": "list", "member": { "target": "com.amazonaws.launchwizard#DeploymentPatternVersionFilter" } }, "com.amazonaws.launchwizard#GetDeployment": { "type": "operation", "input": { "target": "com.amazonaws.launchwizard#GetDeploymentInput" }, "output": { "target": "com.amazonaws.launchwizard#GetDeploymentOutput" }, "errors": [ { "target": "com.amazonaws.launchwizard#InternalServerException" }, { "target": "com.amazonaws.launchwizard#ResourceNotFoundException" }, { "target": "com.amazonaws.launchwizard#ValidationException" } ], "traits": { "smithy.api#documentation": "Returns information about the deployment.
", "smithy.api#examples": [ { "title": "Get details about a given deployment.", "input": { "deploymentId": "1111111-1111-1111-1111-111111111111" }, "output": { "deployment": { "name": "SapHanaSingleForTest", "id": "1111111-1111-1111-1111-111111111111", "workloadName": "SapHanaSingle", "status": "FAILED", "createdAt": "2023-04-24T13:10:09.857Z", "specifications": { "applicationName": "SapHanaSingleForTest", "deploymentScenario": "SapHanaSingle", "DisableDeploymentRollback": "true", "saveDeploymentArtifacts": "Yes", "saveArtifactsS3Uri": "s3://testbucket", "KeyName": "testLinuxInstance", "VPCID": "vpc-1234567", "environmentType": "production", "SAPTZ": "America/Vancouver", "Encryption": "Yes" }, "deploymentArn": "arn:aws:launchwizard:us-east-1:123456789012:deployment/1111111-1111-1111-1111-111111111111", "tags": { "key1": "val1", "key2": "val2" } } } } ], "smithy.api#http": { "code": 200, "method": "POST", "uri": "/getDeployment" }, "smithy.api#readonly": {} } }, "com.amazonaws.launchwizard#GetDeploymentInput": { "type": "structure", "members": { "deploymentId": { "target": "com.amazonaws.launchwizard#DeploymentId", "traits": { "smithy.api#documentation": "The ID of the deployment.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.launchwizard#GetDeploymentOutput": { "type": "structure", "members": { "deployment": { "target": "com.amazonaws.launchwizard#DeploymentData", "traits": { "smithy.api#documentation": "An object that details the deployment.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.launchwizard#GetDeploymentPatternVersion": { "type": "operation", "input": { "target": "com.amazonaws.launchwizard#GetDeploymentPatternVersionInput" }, "output": { "target": "com.amazonaws.launchwizard#GetDeploymentPatternVersionOutput" }, "errors": [ { "target": "com.amazonaws.launchwizard#InternalServerException" }, { "target": "com.amazonaws.launchwizard#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "Returns information about a deployment pattern version.
", "smithy.api#http": { "code": 200, "method": "POST", "uri": "/getDeploymentPatternVersion" }, "smithy.api#readonly": {} } }, "com.amazonaws.launchwizard#GetDeploymentPatternVersionInput": { "type": "structure", "members": { "workloadName": { "target": "com.amazonaws.launchwizard#WorkloadName", "traits": { "smithy.api#documentation": "The name of the workload. You can use the ListWorkloads operation to discover supported values for this parameter.
The name of the deployment pattern. You can use the ListWorkloadDeploymentPatterns operation to discover supported values for this parameter.
The name of the deployment pattern version.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.launchwizard#GetDeploymentPatternVersionOutput": { "type": "structure", "members": { "deploymentPatternVersion": { "target": "com.amazonaws.launchwizard#DeploymentPatternVersionDataSummary", "traits": { "smithy.api#documentation": "The deployment pattern version.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.launchwizard#GetWorkload": { "type": "operation", "input": { "target": "com.amazonaws.launchwizard#GetWorkloadInput" }, "output": { "target": "com.amazonaws.launchwizard#GetWorkloadOutput" }, "errors": [ { "target": "com.amazonaws.launchwizard#InternalServerException" }, { "target": "com.amazonaws.launchwizard#ResourceNotFoundException" }, { "target": "com.amazonaws.launchwizard#ValidationException" } ], "traits": { "smithy.api#documentation": "Returns information about a workload.
", "smithy.api#examples": [ { "title": "Get details about a specific workload.", "input": { "workloadName": "SAP" }, "output": { "workload": { "workloadName": "SAP", "displayName": "SAP", "description": "Workload Description", "documentationUrl": "https://docs.aws.amazon.com/launchwizard/latest/userguide/launch-wizard-sap.html", "iconUrl": "https://aws-lw-workload-assets-test-us-east-1.s3.amazonaws.com/amazon/SAP/icon.png?X-Amz-Security-Token=IQoJb3JpZ2luX2VjEAUaCXVzLWVhc3QtMSJHMEUCIC4l3GCH4o%2Bgq3pJzcD1YJmtrmyNCoEgG2RIayjDWf9kAiEAnMK5nYixaZLuF1s1UVoNd7xIbDrOQ8EAbhcZWexMp9cq7wIIrf%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FARAEGgw1ODI1NTgxMjEyMDYiDHxMN%2BZ8CoPORzvo4yrDAtkVZlBVxLwnFmwHw005vo13LOUUbyajEpp3HNh%2BaBL8K2DLx7Kzi0UPPD6z8pL1eiFLHAQ9zZgVc7pLVQjBKOdcw1GmIADDepqYEb%2B8zLi7zwWP1JT72YbT6ZXSoWpb5NCqcyAvdK47b0Ae586s6VkWzoeJ65jR%2FgbJMhRpFpqVSP2XI6Rf6yA3%2BkQyUCk3RdyF4ljIL8Nf5nIFb%2BOMK2PZ8aJX85l1j7UpJE1rfNb1PitVcQz3KlW5xkiXfcWRKeVhgHRyuCEL3FY0DyPFdqe3NxcA0%2FzPgBq6Y9B41kM6af5u2kQRfQOjWejDpzpG7w40eaIKAYnhBkjIA9550geSLB7O%2FuAPQLI9fI2lVowIBUKsKVOr0%2FFGIzW3WM7%2BbEx%2FZ0mDkP1IhcpZdP7owC77K8O%2BXDgBCabAy48K3ndi%2BQKQMPXjz6YGOp4Bbgv9mVc3sE4KvXZv1skhnOYcOKGdCncIKLne0W%2BgO3URxyDQiyO2FhM3OekXDH83CNCyDVIpkgpWkvgXDSaZiD5mj0T9iqEeJzfh6uQvX1dRN%2BxI1eV0M7HKY2e7F%2BKNjeLhzKgKpSpDqFIUSjLeBlLLyQCNKuUiO3DMiy3rB89aX4b9wyC8au0SfGb72YyNLXjh6M1whcj1VNGePyw%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20230809T202649Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Credential=ASIAYPIZLPT3GGDNTHTI%2F20230809%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=6a37e41e47208b426a5e7d32392d0815388cd0231187652204836943c37ad86a", "status": "ACTIVE" } } } ], "smithy.api#http": { "code": 200, "method": "POST", "uri": "/getWorkload" }, "smithy.api#readonly": {} } }, "com.amazonaws.launchwizard#GetWorkloadDeploymentPattern": { "type": "operation", "input": { "target": "com.amazonaws.launchwizard#GetWorkloadDeploymentPatternInput" }, "output": { "target": "com.amazonaws.launchwizard#GetWorkloadDeploymentPatternOutput" }, "errors": [ { "target": "com.amazonaws.launchwizard#InternalServerException" }, { "target": "com.amazonaws.launchwizard#ResourceNotFoundException" }, { "target": "com.amazonaws.launchwizard#ValidationException" } ], "traits": { "smithy.api#documentation": "Returns details for a given workload and deployment pattern, including the available specifications. You can use the ListWorkloads operation to discover the available workload names and the ListWorkloadDeploymentPatterns operation to discover the available deployment pattern names of a given workload.
", "smithy.api#examples": [ { "title": "Get details about a specific Workload deployment pattern", "input": { "workloadName": "MicrosoftActiveDirectory", "deploymentPatternName": "adSelfManagedNewVpc" }, "output": { "workloadDeploymentPattern": { "workloadName": "MicrosoftActiveDirectory", "deploymentPatternName": "adSelfManagedNewVpc", "deploymentPatternVersionName": "2024-03-19-14-00-09", "displayName": "Self-managed AD - new VPC", "description": "Builds a new AWS environment (VPC and other components), and deploys AD DS into this new VPC.", "status": "ACTIVE", "specifications": [ { "name": "NumberOfAZs", "description": "Number of Availability Zones to use in the VPC.", "required": "Yes" }, { "name": "AvailabilityZones", "description": "List of Availability Zones (AZs) to use for the subnets in the VPC.", "required": "Yes" }, { "name": "VPCCIDR", "description": "CIDR block for the VPC.", "required": "Yes" } ] } } } ], "smithy.api#http": { "code": 200, "method": "POST", "uri": "/getWorkloadDeploymentPattern" }, "smithy.api#readonly": {} } }, "com.amazonaws.launchwizard#GetWorkloadDeploymentPatternInput": { "type": "structure", "members": { "workloadName": { "target": "com.amazonaws.launchwizard#WorkloadName", "traits": { "smithy.api#documentation": "The name of the workload.
", "smithy.api#required": {} } }, "deploymentPatternName": { "target": "com.amazonaws.launchwizard#DeploymentPatternName", "traits": { "smithy.api#documentation": "The name of the deployment pattern.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.launchwizard#GetWorkloadDeploymentPatternOutput": { "type": "structure", "members": { "workloadDeploymentPattern": { "target": "com.amazonaws.launchwizard#WorkloadDeploymentPatternData", "traits": { "smithy.api#documentation": "Details about the workload deployment pattern.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.launchwizard#GetWorkloadInput": { "type": "structure", "members": { "workloadName": { "target": "com.amazonaws.launchwizard#WorkloadName", "traits": { "smithy.api#documentation": "The name of the workload.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.launchwizard#GetWorkloadOutput": { "type": "structure", "members": { "workload": { "target": "com.amazonaws.launchwizard#WorkloadData", "traits": { "smithy.api#documentation": "Information about the workload.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.launchwizard#InternalServerException": { "type": "structure", "members": { "message": { "target": "smithy.api#String" } }, "traits": { "smithy.api#documentation": "An internal error has occurred. Retry your request, but if the problem persists, contact us with details by posting a question on re:Post.
", "smithy.api#error": "server", "smithy.api#httpError": 500 } }, "com.amazonaws.launchwizard#KeyString": { "type": "string", "traits": { "smithy.api#length": { "min": 3, "max": 256 }, "smithy.api#pattern": "^[a-zA-Z0-9-:]+$" } }, "com.amazonaws.launchwizard#LaunchWizard": { "type": "service", "version": "2018-05-10", "operations": [ { "target": "com.amazonaws.launchwizard#ListTagsForResource" }, { "target": "com.amazonaws.launchwizard#TagResource" }, { "target": "com.amazonaws.launchwizard#UntagResource" } ], "resources": [ { "target": "com.amazonaws.launchwizard#Deployment" }, { "target": "com.amazonaws.launchwizard#SettingsSet" }, { "target": "com.amazonaws.launchwizard#Workload" } ], "traits": { "aws.api#service": { "sdkId": "Launch Wizard", "cloudFormationName": "LaunchWizard", "arnNamespace": "launchwizard", "endpointPrefix": "launchwizard", "cloudTrailEventSource": "launchwizard.amazonaws.com" }, "aws.auth#sigv4": { "name": "launchwizard" }, "aws.protocols#restJson1": {}, "smithy.api#cors": {}, "smithy.api#documentation": "Launch Wizard offers a guided way of sizing, configuring, and deploying Amazon Web Services resources for third party applications, such as Microsoft SQL Server Always On and HANA based SAP systems, without the need to manually identify and provision individual Amazon Web Services resources.
", "smithy.api#title": "AWS Launch Wizard", "smithy.rules#endpointBdd": { "version": "1.1", "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" } }, "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] }, { "fn": "isSet", "argv": [ { "ref": "Region" } ] }, { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "results": [ { "conditions": [], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://launchwizard-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://launchwizard-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://launchwizard.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://launchwizard.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "root": 2, "nodeCount": 13, "nodes": "/////wAAAAH/////AAAAAAAAAAwAAAADAAAAAQAAAAQF9eELAAAAAgAAAAUF9eELAAAAAwAAAAgAAAAGAAAABAAAAAcF9eEKAAAABQX14QgF9eEJAAAABAAAAAoAAAAJAAAABgX14QYF9eEHAAAABQAAAAsF9eEFAAAABgX14QQF9eEFAAAAAwX14QEAAAANAAAABAX14QIF9eED" }, "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": [], "rules": [ { "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" } ], "type": "tree" }, { "conditions": [], "rules": [ { "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": [], "rules": [ { "conditions": [], "endpoint": { "url": "https://launchwizard-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "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": [], "rules": [ { "conditions": [], "endpoint": { "url": "https://launchwizard-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "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": [], "rules": [ { "conditions": [], "endpoint": { "url": "https://launchwizard.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } ], "type": "tree" }, { "conditions": [], "rules": [ { "conditions": [], "endpoint": { "url": "https://launchwizard.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "type": "tree" } ] }, "smithy.rules#endpointTests": { "testCases": [ { "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://launchwizard-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://launchwizard-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://launchwizard.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://launchwizard.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://launchwizard-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://launchwizard-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://launchwizard.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://launchwizard.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://launchwizard-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://launchwizard-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://launchwizard.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://launchwizard.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://launchwizard-fips.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://launchwizard.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://launchwizard-fips.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://launchwizard.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.launchwizard#ListDeploymentEvents": { "type": "operation", "input": { "target": "com.amazonaws.launchwizard#ListDeploymentEventsInput" }, "output": { "target": "com.amazonaws.launchwizard#ListDeploymentEventsOutput" }, "errors": [ { "target": "com.amazonaws.launchwizard#InternalServerException" }, { "target": "com.amazonaws.launchwizard#ResourceNotFoundException" }, { "target": "com.amazonaws.launchwizard#ValidationException" } ], "traits": { "smithy.api#documentation": "Lists the events of a deployment.
", "smithy.api#examples": [ { "title": "List all actions taken during a deployment.", "input": { "deploymentId": "4c1b59c1-659c-467f-b6e9-6ef6f9d28e1d" }, "output": { "deploymentEvents": [ { "name": "Create secure parameter", "description": "Creates a new secure parameter", "status": "COMPLETED", "statusReason": "", "timestamp": "2023-04-24T13:10:39.123Z" }, { "name": "Create resource group", "description": "Creates a resource group with all the application resources", "status": "COMPLETED", "statusReason": "", "timestamp": "2023-04-24T13:10:42.238Z" } ] } } ], "smithy.api#http": { "code": 200, "method": "POST", "uri": "/listDeploymentEvents" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "deploymentEvents" }, "smithy.api#readonly": {} } }, "com.amazonaws.launchwizard#ListDeploymentEventsInput": { "type": "structure", "members": { "deploymentId": { "target": "com.amazonaws.launchwizard#DeploymentId", "traits": { "smithy.api#documentation": "The ID of the deployment.
", "smithy.api#required": {} } }, "maxResults": { "target": "com.amazonaws.launchwizard#MaxDeploymentEventResults", "traits": { "smithy.api#default": null, "smithy.api#documentation": "The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output.
" } }, "nextToken": { "target": "com.amazonaws.launchwizard#NextToken", "traits": { "smithy.api#documentation": "The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.launchwizard#ListDeploymentEventsOutput": { "type": "structure", "members": { "deploymentEvents": { "target": "com.amazonaws.launchwizard#DeploymentEventDataSummaryList", "traits": { "smithy.api#documentation": "Lists the deployment events.
" } }, "nextToken": { "target": "com.amazonaws.launchwizard#NextToken", "traits": { "smithy.api#documentation": "The token to include in another request to get the next page of items. This value is null when there are no more items to return.
Lists the deployment pattern versions.
", "smithy.api#examples": [ { "title": "List all visible versions for the given workload and deployment pattern.", "input": { "workloadName": "security-automations-for-aws-waf", "deploymentPatternName": "default" }, "output": { "deploymentPatternVersions": [ { "workloadName": "security-automations-for-aws-waf", "deploymentPatternName": "default", "deploymentPatternVersionName": "4.0.6" }, { "workloadName": "security-automations-for-aws-waf", "deploymentPatternName": "default", "deploymentPatternVersionName": "3.2.5" }, { "workloadName": "security-automations-for-aws-waf", "deploymentPatternName": "default", "deploymentPatternVersionName": "3.1.0" } ] } }, { "title": "List filtered versions for the given workload and deployment pattern.", "input": { "workloadName": "security-automations-for-aws-waf", "deploymentPatternName": "default", "filters": [ { "name": "updateFromVersion", "values": [ "4.0.2" ] } ] }, "output": { "deploymentPatternVersions": [ { "workloadName": "security-automations-for-aws-waf", "deploymentPatternName": "default", "deploymentPatternVersionName": "4.0.6" } ] } } ], "smithy.api#http": { "code": 200, "method": "POST", "uri": "/listDeploymentPatternVersions" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "deploymentPatternVersions" }, "smithy.api#readonly": {} } }, "com.amazonaws.launchwizard#ListDeploymentPatternVersionsInput": { "type": "structure", "members": { "workloadName": { "target": "com.amazonaws.launchwizard#WorkloadName", "traits": { "smithy.api#documentation": "The name of the workload. You can use the ListWorkloads operation to discover supported values for this parameter.
The name of the deployment pattern. You can use the ListWorkloadDeploymentPatterns operation to discover supported values for this parameter.
The maximum number of deployment pattern versions to list.
" } }, "nextToken": { "target": "com.amazonaws.launchwizard#NextToken", "traits": { "smithy.api#documentation": "The token for the next set of results.
" } }, "filters": { "target": "com.amazonaws.launchwizard#FilterList", "traits": { "smithy.api#documentation": "Filters to apply when listing deployment pattern versions.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.launchwizard#ListDeploymentPatternVersionsOutput": { "type": "structure", "members": { "deploymentPatternVersions": { "target": "com.amazonaws.launchwizard#DeploymentPatternVersionDataSummaryList", "traits": { "smithy.api#documentation": "The deployment pattern versions.
" } }, "nextToken": { "target": "com.amazonaws.launchwizard#NextToken", "traits": { "smithy.api#documentation": "The token for the next set of results.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.launchwizard#ListDeployments": { "type": "operation", "input": { "target": "com.amazonaws.launchwizard#ListDeploymentsInput" }, "output": { "target": "com.amazonaws.launchwizard#ListDeploymentsOutput" }, "errors": [ { "target": "com.amazonaws.launchwizard#InternalServerException" }, { "target": "com.amazonaws.launchwizard#ValidationException" } ], "traits": { "smithy.api#documentation": "Lists the deployments that have been created.
", "smithy.api#examples": [ { "title": "List deployments in the account with filters.", "input": { "filters": [ { "name": "DEPLOYMENT_STATUS", "values": [ "IN_PROGRESS" ] } ] }, "output": { "deployments": [ { "name": "SapHanaSingleForTest", "id": "4c1b59c1-659c-467f-b6e9-6ef6f9d28e1d", "workloadName": "SAP", "patternName": "SapHanaSingle", "status": "IN_PROGRESS", "createdAt": "2023-04-24T13:10:09.857Z" } ] } } ], "smithy.api#http": { "code": 200, "method": "POST", "uri": "/listDeployments" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "deployments" }, "smithy.api#readonly": {} } }, "com.amazonaws.launchwizard#ListDeploymentsInput": { "type": "structure", "members": { "filters": { "target": "com.amazonaws.launchwizard#DeploymentFilterList", "traits": { "smithy.api#documentation": "Filters to scope the results. The following filters are supported:
WORKLOAD_NAME - The name used in deployments.
DEPLOYMENT_STATUS - COMPLETED | CREATING | DELETE_IN_PROGRESS | DELETE_INITIATING | DELETE_FAILED | DELETED | FAILED | IN_PROGRESS | VALIDATING
The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output.
" } }, "nextToken": { "target": "com.amazonaws.launchwizard#NextToken", "traits": { "smithy.api#documentation": "The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.launchwizard#ListDeploymentsOutput": { "type": "structure", "members": { "deployments": { "target": "com.amazonaws.launchwizard#DeploymentDataSummaryList", "traits": { "smithy.api#documentation": "Lists the deployments.
" } }, "nextToken": { "target": "com.amazonaws.launchwizard#NextToken", "traits": { "smithy.api#documentation": "The token to include in another request to get the next page of items. This value is null when there are no more items to return.
Lists the tags associated with a specified resource.
", "smithy.api#examples": [ { "title": "Listing tags on a Launch Wizard deployment resource.", "input": { "resourceArn": "arn:aws:launchwizard:us-east-1:123456789012:deployment/11111111-1111-1111-1111-111111111111" }, "output": { "tags": { "key1": "value1", "key2": "value2" } } } ], "smithy.api#http": { "method": "GET", "uri": "/tags/{resourceArn}" }, "smithy.api#readonly": {} } }, "com.amazonaws.launchwizard#ListTagsForResourceInput": { "type": "structure", "members": { "resourceArn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.launchwizard#ListTagsForResourceOutput": { "type": "structure", "members": { "tags": { "target": "com.amazonaws.launchwizard#Tags", "traits": { "smithy.api#documentation": "Information about the tags.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.launchwizard#ListWorkloadDeploymentPatterns": { "type": "operation", "input": { "target": "com.amazonaws.launchwizard#ListWorkloadDeploymentPatternsInput" }, "output": { "target": "com.amazonaws.launchwizard#ListWorkloadDeploymentPatternsOutput" }, "errors": [ { "target": "com.amazonaws.launchwizard#InternalServerException" }, { "target": "com.amazonaws.launchwizard#ResourceNotFoundException" }, { "target": "com.amazonaws.launchwizard#ValidationException" } ], "traits": { "smithy.api#documentation": "Lists the workload deployment patterns for a given workload name. You can use the ListWorkloads operation to discover the available workload names.
", "smithy.api#examples": [ { "title": "List all available workloads supported by AWS Launch Wizard.", "input": { "workloadName": "SAP" }, "output": { "workloadDeploymentPatterns": [ { "workloadName": "SAP", "deploymentPatternName": "SapHanaHA", "deploymentPatternVersionName": "2023-08-02-01-00-00", "displayName": "Deployment Option Display Name", "description": "Deployment Option Description", "status": "ACTIVE" }, { "workloadName": "SAP", "deploymentPatternName": "SapHanaMulti", "deploymentPatternVersionName": "2023-08-02-01-00-00", "displayName": "Deployment Option Display Name", "description": "Deployment Option Description", "status": "ACTIVE" } ] } } ], "smithy.api#http": { "code": 200, "method": "POST", "uri": "/listWorkloadDeploymentPatterns" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "workloadDeploymentPatterns" }, "smithy.api#readonly": {} } }, "com.amazonaws.launchwizard#ListWorkloadDeploymentPatternsInput": { "type": "structure", "members": { "workloadName": { "target": "com.amazonaws.launchwizard#WorkloadName", "traits": { "smithy.api#documentation": "The name of the workload.
", "smithy.api#required": {} } }, "maxResults": { "target": "com.amazonaws.launchwizard#MaxWorkloadDeploymentPatternResults", "traits": { "smithy.api#default": null, "smithy.api#documentation": "The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output.
" } }, "nextToken": { "target": "com.amazonaws.launchwizard#NextToken", "traits": { "smithy.api#documentation": "The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.launchwizard#ListWorkloadDeploymentPatternsOutput": { "type": "structure", "members": { "workloadDeploymentPatterns": { "target": "com.amazonaws.launchwizard#WorkloadDeploymentPatternDataSummaryList", "traits": { "smithy.api#documentation": "Describes the workload deployment patterns.
" } }, "nextToken": { "target": "com.amazonaws.launchwizard#NextToken", "traits": { "smithy.api#documentation": "The token to include in another request to get the next page of items. This value is null when there are no more items to return.
Lists the available workload names. You can use the ListWorkloadDeploymentPatterns operation to discover the available deployment patterns for a given workload.
", "smithy.api#examples": [ { "title": "List all available workloads supported by AWS Launch Wizard.", "input": {}, "output": { "workloads": [ { "workloadName": "SAP", "displayName": "SAP", "status": "ACTIVE" }, { "workloadName": "SQL", "displayName": "MS SQL Server", "status": "ACTIVE" } ] } } ], "smithy.api#http": { "code": 200, "method": "POST", "uri": "/listWorkloads" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "workloads" }, "smithy.api#readonly": {} } }, "com.amazonaws.launchwizard#ListWorkloadsInput": { "type": "structure", "members": { "maxResults": { "target": "com.amazonaws.launchwizard#MaxWorkloadResults", "traits": { "smithy.api#default": null, "smithy.api#documentation": "The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output.
" } }, "nextToken": { "target": "com.amazonaws.launchwizard#NextToken", "traits": { "smithy.api#documentation": "The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.launchwizard#ListWorkloadsOutput": { "type": "structure", "members": { "workloads": { "target": "com.amazonaws.launchwizard#WorkloadDataSummaryList", "traits": { "smithy.api#documentation": "Information about the workloads.
" } }, "nextToken": { "target": "com.amazonaws.launchwizard#NextToken", "traits": { "smithy.api#documentation": "The token to include in another request to get the next page of items. This value is null when there are no more items to return.
You have exceeded an Launch Wizard resource limit. For example, you might have too many deployments in progress.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.launchwizard#ResourceNotFoundException": { "type": "structure", "members": { "message": { "target": "smithy.api#String" } }, "traits": { "smithy.api#documentation": "The specified workload or deployment resource can't be found.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.launchwizard#ServicePrincipalType": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^[a-z0-9.-]+\\.amazonaws\\.com(\\.cn)?$" } }, "com.amazonaws.launchwizard#SettingsSet": { "type": "resource", "identifiers": { "name": { "target": "com.amazonaws.launchwizard#SettingsSetName" } } }, "com.amazonaws.launchwizard#SettingsSetName": { "type": "string", "traits": { "smithy.api#pattern": "^[a-zA-Z0-9-]{2,50}$" } }, "com.amazonaws.launchwizard#SpecificationsConditionalData": { "type": "list", "member": { "target": "com.amazonaws.launchwizard#DeploymentConditionalField" }, "traits": { "smithy.api#length": { "min": 1, "max": 5 } } }, "com.amazonaws.launchwizard#TagKey": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^[a-zA-Z0-9 _.:/=+@-]+$" } }, "com.amazonaws.launchwizard#TagKeyList": { "type": "list", "member": { "target": "com.amazonaws.launchwizard#TagKey" }, "traits": { "smithy.api#length": { "min": 1, "max": 200 } } }, "com.amazonaws.launchwizard#TagResource": { "type": "operation", "input": { "target": "com.amazonaws.launchwizard#TagResourceInput" }, "output": { "target": "com.amazonaws.launchwizard#TagResourceOutput" }, "errors": [ { "target": "com.amazonaws.launchwizard#InternalServerException" }, { "target": "com.amazonaws.launchwizard#ResourceNotFoundException" }, { "target": "com.amazonaws.launchwizard#ValidationException" } ], "traits": { "smithy.api#documentation": "Adds the specified tags to the given resource.
", "smithy.api#examples": [ { "title": "Adding tags to a Launch Wizard deployment resource.", "input": { "resourceArn": "arn:aws:launchwizard:us-east-1:123456789012:deployment/11111111-1111-1111-1111-111111111111", "tags": { "key1": "value1", "key2": "value2" } }, "output": {} } ], "smithy.api#http": { "method": "POST", "uri": "/tags/{resourceArn}" } } }, "com.amazonaws.launchwizard#TagResourceInput": { "type": "structure", "members": { "resourceArn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.launchwizard#Tags", "traits": { "smithy.api#documentation": "One or more tags to attach to the resource.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.launchwizard#TagResourceOutput": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.launchwizard#TagValue": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 }, "smithy.api#pattern": "^[a-zA-Z0-9 _.:/=+@-]*$" } }, "com.amazonaws.launchwizard#Tags": { "type": "map", "key": { "target": "com.amazonaws.launchwizard#TagKey" }, "value": { "target": "com.amazonaws.launchwizard#TagValue" }, "traits": { "smithy.api#length": { "min": 1, "max": 200 } } }, "com.amazonaws.launchwizard#UntagResource": { "type": "operation", "input": { "target": "com.amazonaws.launchwizard#UntagResourceInput" }, "output": { "target": "com.amazonaws.launchwizard#UntagResourceOutput" }, "errors": [ { "target": "com.amazonaws.launchwizard#InternalServerException" }, { "target": "com.amazonaws.launchwizard#ResourceNotFoundException" }, { "target": "com.amazonaws.launchwizard#ValidationException" } ], "traits": { "smithy.api#documentation": "Removes the specified tags from the given resource.
", "smithy.api#examples": [ { "title": "Removing tags on a Launch Wizard deployment resource.", "input": { "resourceArn": "arn:aws:launchwizard:us-east-1:123456789012:deployment/11111111-1111-1111-1111-111111111111", "tagKeys": [ "key1", "key2" ] }, "output": {} } ], "smithy.api#http": { "method": "DELETE", "uri": "/tags/{resourceArn}" }, "smithy.api#idempotent": {} } }, "com.amazonaws.launchwizard#UntagResourceInput": { "type": "structure", "members": { "resourceArn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "tagKeys": { "target": "com.amazonaws.launchwizard#TagKeyList", "traits": { "smithy.api#documentation": "Keys identifying the tags to remove.
", "smithy.api#httpQuery": "tagKeys", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.launchwizard#UntagResourceOutput": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.launchwizard#UpdateDeployment": { "type": "operation", "input": { "target": "com.amazonaws.launchwizard#UpdateDeploymentInput" }, "output": { "target": "com.amazonaws.launchwizard#UpdateDeploymentOutput" }, "errors": [ { "target": "com.amazonaws.launchwizard#InternalServerException" }, { "target": "com.amazonaws.launchwizard#ResourceLimitException" }, { "target": "com.amazonaws.launchwizard#ResourceNotFoundException" }, { "target": "com.amazonaws.launchwizard#ValidationException" } ], "traits": { "smithy.api#documentation": "Updates a deployment.
", "smithy.api#examples": [ { "title": "Edit deployment specifications.", "input": { "deploymentId": "4c1b59c1-659c-467f-b6e9-6ef6f9d28e1d", "specifications": { "DisableDeploymentRollback": "No", "SaveDeploymentArtifacts": "Yes", "DeploymentArtifactsS3Uri": "aws-bucket-name", "KeyPairName": "keyName", "VpcId": "vpc-1234567", "CreateSecurityGroup": "No", "ProxyServerAddress": "http://mno.abc.com:8080", "Timezone": "Pacific/Wake", "EnableEbsVolumeEncryption": "No", "SapSysGroupId": "5003", "SapVirtualIPOptIn": "No", "SnsTopicArn": "arn:aws:sns:us-east-1:111111222222:snsNameUsEast1.fifo" }, "dryRun": false }, "output": { "deployment": { "name": "TestDeployment1", "id": "4c1b59c1-659c-467f-b6e9-6ef6f9d28e1d", "workloadName": "SAP", "patternName": "SapHanaSingle", "status": "UPDATE_IN_PROGRESS", "createdAt": 1736286728468 } } }, { "title": "Update deployment version.", "input": { "deploymentId": "4c1b59c1-659c-467f-b6e9-6ef6f9d28e1d", "deploymentPatternVersionName": "2.0.0", "specifications": { "DisableDeploymentRollback": "No", "SaveDeploymentArtifacts": "Yes", "DeploymentArtifactsS3Uri": "aws-bucket-name", "KeyPairName": "keyName", "VpcId": "vpc-1234567", "CreateSecurityGroup": "No", "ProxyServerAddress": "http://mno.abc.com:8080", "Timezone": "Pacific/Wake", "EnableEbsVolumeEncryption": "No", "SapSysGroupId": "5003", "SapVirtualIPOptIn": "No", "SnsTopicArn": "arn:aws:sns:us-east-1:111111222222:snsNameUsEast1.fifo", "NewParameter": "Allow" }, "dryRun": false }, "output": { "deployment": { "name": "TestDeployment1", "id": "4c1b59c1-659c-467f-b6e9-6ef6f9d28e1d", "workloadName": "SAP", "patternName": "SapHanaSingle", "status": "UPDATE_IN_PROGRESS", "createdAt": 1736286728468 } } } ], "smithy.api#http": { "code": 200, "method": "POST", "uri": "/updateDeployment" }, "smithy.api#idempotent": {} } }, "com.amazonaws.launchwizard#UpdateDeploymentInput": { "type": "structure", "members": { "deploymentId": { "target": "com.amazonaws.launchwizard#DeploymentId", "traits": { "smithy.api#documentation": "The ID of the deployment.
", "smithy.api#required": {} } }, "specifications": { "target": "com.amazonaws.launchwizard#DeploymentSpecifications", "traits": { "smithy.api#documentation": "The settings specified for the deployment. These settings define how to deploy and configure your resources created by the deployment. For more information about the specifications required for creating a deployment for a SAP workload, see SAP deployment specifications. To retrieve the specifications required to create a deployment for other workloads, use the GetWorkloadDeploymentPattern operation.
The name of the workload version.
" } }, "deploymentPatternVersionName": { "target": "com.amazonaws.launchwizard#DeploymentPatternVersionName", "traits": { "smithy.api#documentation": "The name of the deployment pattern version.
" } }, "dryRun": { "target": "smithy.api#Boolean", "traits": { "smithy.api#default": false, "smithy.api#documentation": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Forces the update even if validation warnings are present.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.launchwizard#UpdateDeploymentOutput": { "type": "structure", "members": { "deployment": { "target": "com.amazonaws.launchwizard#DeploymentDataSummary", "traits": { "smithy.api#documentation": "The deployment.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.launchwizard#ValidationException": { "type": "structure", "members": { "message": { "target": "smithy.api#String" } }, "traits": { "smithy.api#documentation": "The input fails to satisfy the constraints specified by an Amazon Web Services service.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.launchwizard#ValueString": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1500 } } }, "com.amazonaws.launchwizard#Workload": { "type": "resource", "identifiers": { "workloadName": { "target": "com.amazonaws.launchwizard#WorkloadName" } }, "read": { "target": "com.amazonaws.launchwizard#GetWorkload" }, "list": { "target": "com.amazonaws.launchwizard#ListWorkloads" }, "resources": [ { "target": "com.amazonaws.launchwizard#WorkloadDeploymentPattern" } ] }, "com.amazonaws.launchwizard#WorkloadData": { "type": "structure", "members": { "workloadName": { "target": "com.amazonaws.launchwizard#WorkloadName", "traits": { "smithy.api#documentation": "The name of the workload.
" } }, "displayName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The display name of a workload.
" } }, "status": { "target": "com.amazonaws.launchwizard#WorkloadStatus", "traits": { "smithy.api#documentation": "The status of a workload.
You can list deployments in the DISABLED status.
The description of a workload.
" } }, "documentationUrl": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The URL of a workload document.
" } }, "iconUrl": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The URL of a workload icon.
" } }, "statusMessage": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The message about a workload's status.
" } } }, "traits": { "smithy.api#documentation": "Describes a workload.
" } }, "com.amazonaws.launchwizard#WorkloadDataSummary": { "type": "structure", "members": { "workloadName": { "target": "com.amazonaws.launchwizard#WorkloadName", "traits": { "smithy.api#documentation": "The name of the workload.
" } }, "displayName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The display name of the workload data.
" } }, "status": { "target": "com.amazonaws.launchwizard#WorkloadStatus", "traits": { "smithy.api#documentation": "The status of the workload.
" } }, "accountConstraints": { "target": "com.amazonaws.launchwizard#AccountConstraintsList", "traits": { "smithy.api#documentation": "Optional list of constraints describing what kind of AWS account is allowed to deploy this workload or deployment pattern. Within a single list the semantics are OR: an account satisfies the list if it satisfies any entry. Workload-level and pattern-level lists combine with AND at deployment time. An absent or empty list at this level means no constraint at this level." } } }, "traits": { "smithy.api#documentation": "Describes workload data.
" } }, "com.amazonaws.launchwizard#WorkloadDataSummaryList": { "type": "list", "member": { "target": "com.amazonaws.launchwizard#WorkloadDataSummary" } }, "com.amazonaws.launchwizard#WorkloadDeploymentPattern": { "type": "resource", "identifiers": { "workloadName": { "target": "com.amazonaws.launchwizard#WorkloadName" }, "deploymentPatternName": { "target": "com.amazonaws.launchwizard#DeploymentPatternName" } }, "read": { "target": "com.amazonaws.launchwizard#GetWorkloadDeploymentPattern" }, "list": { "target": "com.amazonaws.launchwizard#ListWorkloadDeploymentPatterns" }, "resources": [ { "target": "com.amazonaws.launchwizard#DeploymentPatternVersion" } ] }, "com.amazonaws.launchwizard#WorkloadDeploymentPatternData": { "type": "structure", "members": { "workloadName": { "target": "com.amazonaws.launchwizard#WorkloadName", "traits": { "smithy.api#documentation": "The workload name of the deployment pattern.
" } }, "deploymentPatternName": { "target": "com.amazonaws.launchwizard#DeploymentPatternName", "traits": { "smithy.api#documentation": "The name of the deployment pattern.
" } }, "workloadVersionName": { "target": "com.amazonaws.launchwizard#WorkloadVersionName", "traits": { "smithy.api#documentation": "The workload version name of the deployment pattern.
" } }, "deploymentPatternVersionName": { "target": "com.amazonaws.launchwizard#DeploymentPatternVersionName", "traits": { "smithy.api#documentation": "The version name of the deployment pattern.
" } }, "displayName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The display name of the deployment pattern.
" } }, "description": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The description of the deployment pattern.
" } }, "status": { "target": "com.amazonaws.launchwizard#WorkloadDeploymentPatternStatus", "traits": { "smithy.api#documentation": "The status of the deployment pattern.
" } }, "statusMessage": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The status message of the deployment pattern.
" } }, "accountConstraints": { "target": "com.amazonaws.launchwizard#AccountConstraintsList", "traits": { "smithy.api#documentation": "Optional list of constraints describing what kind of AWS account is allowed to deploy this workload or deployment pattern. Within a single list the semantics are OR: an account satisfies the list if it satisfies any entry. Workload-level and pattern-level lists combine with AND at deployment time. An absent or empty list at this level means no constraint at this level." } }, "specifications": { "target": "com.amazonaws.launchwizard#DeploymentSpecificationsData", "traits": { "smithy.api#documentation": "The settings specified for the deployment. These settings define how to deploy and configure your resources created by the deployment. For more information about the specifications required for creating a deployment for a SAP workload, see SAP deployment specifications. To retrieve the specifications required to create a deployment for other workloads, use the GetWorkloadDeploymentPattern operation.
The data that details a workload deployment pattern.
" } }, "com.amazonaws.launchwizard#WorkloadDeploymentPatternDataSummary": { "type": "structure", "members": { "workloadName": { "target": "com.amazonaws.launchwizard#WorkloadName", "traits": { "smithy.api#documentation": "The name of the workload.
" } }, "deploymentPatternName": { "target": "com.amazonaws.launchwizard#DeploymentPatternName", "traits": { "smithy.api#documentation": "The name of a workload deployment pattern.
" } }, "workloadVersionName": { "target": "com.amazonaws.launchwizard#WorkloadVersionName", "traits": { "smithy.api#documentation": "The name of the workload deployment pattern version.
" } }, "deploymentPatternVersionName": { "target": "com.amazonaws.launchwizard#DeploymentPatternVersionName", "traits": { "smithy.api#documentation": "The version name of a workload deployment pattern.
" } }, "displayName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The display name of a workload deployment pattern.
" } }, "description": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The description of a workload deployment pattern.
" } }, "status": { "target": "com.amazonaws.launchwizard#WorkloadDeploymentPatternStatus", "traits": { "smithy.api#documentation": "The status of a workload deployment pattern.
" } }, "statusMessage": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A message about a workload deployment pattern's status.
" } }, "accountConstraints": { "target": "com.amazonaws.launchwizard#AccountConstraintsList", "traits": { "smithy.api#documentation": "Optional list of constraints describing what kind of AWS account is allowed to deploy this workload or deployment pattern. Within a single list the semantics are OR: an account satisfies the list if it satisfies any entry. Workload-level and pattern-level lists combine with AND at deployment time. An absent or empty list at this level means no constraint at this level." } } }, "traits": { "smithy.api#documentation": "Describes a workload deployment pattern.
" } }, "com.amazonaws.launchwizard#WorkloadDeploymentPatternDataSummaryList": { "type": "list", "member": { "target": "com.amazonaws.launchwizard#WorkloadDeploymentPatternDataSummary" } }, "com.amazonaws.launchwizard#WorkloadDeploymentPatternStatus": { "type": "enum", "members": { "ACTIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACTIVE" } }, "INACTIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INACTIVE" } }, "DISABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DISABLED" } }, "DELETED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETED" } } } }, "com.amazonaws.launchwizard#WorkloadName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 100 }, "smithy.api#pattern": "^[A-Za-z][a-zA-Z0-9-_]*$" } }, "com.amazonaws.launchwizard#WorkloadStatus": { "type": "enum", "members": { "ACTIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACTIVE" } }, "INACTIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INACTIVE" } }, "DISABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DISABLED" } }, "DELETED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETED" } } } }, "com.amazonaws.launchwizard#WorkloadVersionName": { "type": "string", "traits": { "smithy.api#length": { "min": 5, "max": 30 }, "smithy.api#pattern": "^(([A-Za-z0-9][a-zA-Z0-9-]*)|(\\d+\\.\\d+\\.\\d+))$" } } } }