{ "smithy": "2.0", "shapes": { "com.amazonaws.m2#AccessDeniedException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The account or role doesn't have the right permissions to make the request.

", "smithy.api#error": "client", "smithy.api#httpError": 403 } }, "com.amazonaws.m2#AlternateKey": { "type": "structure", "members": { "name": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The name of the alternate key.

" } }, "offset": { "target": "com.amazonaws.m2#Integer", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "

A positive integer value representing the offset to mark the start of the alternate key\n part in the record byte array.

", "smithy.api#required": {} } }, "length": { "target": "com.amazonaws.m2#Integer", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "

A strictly positive integer value representing the length of the alternate key.

", "smithy.api#required": {} } }, "allowDuplicates": { "target": "com.amazonaws.m2#Boolean", "traits": { "smithy.api#default": false, "smithy.api#documentation": "

Indicates whether the alternate key values are supposed to be unique for the given data\n set.

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

Defines an alternate key. This value is optional. A legacy data set might not have any\n alternate key defined but if those alternate keys definitions exist, provide them, as some\n applications will make use of them.

" } }, "com.amazonaws.m2#AlternateKeyList": { "type": "list", "member": { "target": "com.amazonaws.m2#AlternateKey" } }, "com.amazonaws.m2#Application": { "type": "resource", "identifiers": { "applicationId": { "target": "com.amazonaws.m2#Identifier" } }, "create": { "target": "com.amazonaws.m2#CreateApplication" }, "read": { "target": "com.amazonaws.m2#GetApplication" }, "update": { "target": "com.amazonaws.m2#UpdateApplication" }, "delete": { "target": "com.amazonaws.m2#DeleteApplication" }, "list": { "target": "com.amazonaws.m2#ListApplications" }, "operations": [ { "target": "com.amazonaws.m2#CancelBatchJobExecution" }, { "target": "com.amazonaws.m2#CreateDataSetExportTask" }, { "target": "com.amazonaws.m2#CreateDataSetImportTask" }, { "target": "com.amazonaws.m2#CreateDeployment" }, { "target": "com.amazonaws.m2#DeleteApplicationFromEnvironment" }, { "target": "com.amazonaws.m2#GetApplicationVersion" }, { "target": "com.amazonaws.m2#GetBatchJobExecution" }, { "target": "com.amazonaws.m2#GetDataSetDetails" }, { "target": "com.amazonaws.m2#GetDataSetExportTask" }, { "target": "com.amazonaws.m2#GetDataSetImportTask" }, { "target": "com.amazonaws.m2#GetDeployment" }, { "target": "com.amazonaws.m2#ListApplicationVersions" }, { "target": "com.amazonaws.m2#ListBatchJobDefinitions" }, { "target": "com.amazonaws.m2#ListBatchJobExecutions" }, { "target": "com.amazonaws.m2#ListBatchJobRestartPoints" }, { "target": "com.amazonaws.m2#ListDataSetExportHistory" }, { "target": "com.amazonaws.m2#ListDataSetImportHistory" }, { "target": "com.amazonaws.m2#ListDataSets" }, { "target": "com.amazonaws.m2#ListDeployments" }, { "target": "com.amazonaws.m2#StartApplication" }, { "target": "com.amazonaws.m2#StartBatchJob" }, { "target": "com.amazonaws.m2#StopApplication" } ], "traits": { "aws.api#arn": { "template": "app/{applicationId}" }, "aws.iam#conditionKeys": [ "aws:ResourceTag/${TagKey}" ], "aws.iam#disableConditionKeyInference": {} } }, "com.amazonaws.m2#ApplicationDeploymentLifecycle": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "Deploying", "name": "DEPLOYING" }, { "value": "Deployed", "name": "DEPLOYED" } ] } }, "com.amazonaws.m2#ApplicationLifecycle": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "Creating", "name": "CREATING" }, { "value": "Created", "name": "CREATED" }, { "value": "Available", "name": "AVAILABLE" }, { "value": "Ready", "name": "READY" }, { "value": "Starting", "name": "STARTING" }, { "value": "Running", "name": "RUNNING" }, { "value": "Stopping", "name": "STOPPING" }, { "value": "Stopped", "name": "STOPPED" }, { "value": "Failed", "name": "FAILED" }, { "value": "Deleting", "name": "DELETING" }, { "value": "Deleting From Environment", "name": "DELETING_FROM_ENVIRONMENT" } ] } }, "com.amazonaws.m2#ApplicationSummary": { "type": "structure", "members": { "name": { "target": "com.amazonaws.m2#EntityName", "traits": { "smithy.api#documentation": "

The name of the application.

", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.m2#EntityDescription", "traits": { "smithy.api#documentation": "

The description of the application.

" } }, "applicationId": { "target": "com.amazonaws.m2#Identifier", "traits": { "smithy.api#documentation": "

The unique identifier of the application.

", "smithy.api#required": {} } }, "applicationArn": { "target": "com.amazonaws.m2#Arn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the application.

", "smithy.api#required": {} } }, "applicationVersion": { "target": "com.amazonaws.m2#Version", "traits": { "smithy.api#documentation": "

The version of the application.

", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.m2#ApplicationLifecycle", "traits": { "smithy.api#documentation": "

The status of the application.

", "smithy.api#required": {} } }, "engineType": { "target": "com.amazonaws.m2#EngineType", "traits": { "smithy.api#documentation": "

The type of the target platform for this application.

", "smithy.api#required": {} } }, "creationTime": { "target": "com.amazonaws.m2#Timestamp", "traits": { "smithy.api#documentation": "

The timestamp when the application was created.

", "smithy.api#required": {} } }, "environmentId": { "target": "com.amazonaws.m2#Identifier", "traits": { "smithy.api#documentation": "

The unique identifier of the runtime environment that hosts this application.

" } }, "lastStartTime": { "target": "com.amazonaws.m2#Timestamp", "traits": { "smithy.api#documentation": "

The timestamp when you last started the application. Null until the application runs for\n the first time.

" } }, "versionStatus": { "target": "com.amazonaws.m2#ApplicationVersionLifecycle", "traits": { "smithy.api#documentation": "

Indicates the status of the latest version of the application.

" } }, "deploymentStatus": { "target": "com.amazonaws.m2#ApplicationDeploymentLifecycle", "traits": { "smithy.api#documentation": "

Indicates either an ongoing deployment or if the application has ever deployed\n successfully.

" } }, "roleArn": { "target": "com.amazonaws.m2#Arn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the role associated with the application.

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

A subset of the possible application attributes. Used in the application list.

" } }, "com.amazonaws.m2#ApplicationSummaryList": { "type": "list", "member": { "target": "com.amazonaws.m2#ApplicationSummary" } }, "com.amazonaws.m2#ApplicationVersionLifecycle": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "Creating", "name": "CREATING" }, { "value": "Available", "name": "AVAILABLE" }, { "value": "Failed", "name": "FAILED" } ] } }, "com.amazonaws.m2#ApplicationVersionSummary": { "type": "structure", "members": { "applicationVersion": { "target": "com.amazonaws.m2#Version", "traits": { "smithy.api#documentation": "

The application version.

", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.m2#ApplicationVersionLifecycle", "traits": { "smithy.api#documentation": "

The status of the application.

", "smithy.api#required": {} } }, "statusReason": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The reason for the reported status.

" } }, "creationTime": { "target": "com.amazonaws.m2#Timestamp", "traits": { "smithy.api#documentation": "

The timestamp when the application version was created.

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

Defines an application version summary.

" } }, "com.amazonaws.m2#ApplicationVersionSummaryList": { "type": "list", "member": { "target": "com.amazonaws.m2#ApplicationVersionSummary" } }, "com.amazonaws.m2#Arn": { "type": "string", "traits": { "smithy.api#pattern": "^arn:(aws|aws-cn|aws-iso|aws-iso-[a-z]{1}|aws-us-gov):[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:([a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-[0-9]|):[0-9]{12}:[A-Za-z0-9/][A-Za-z0-9:_/+=,@.-]{0,1023}$" } }, "com.amazonaws.m2#ArnList": { "type": "list", "member": { "target": "com.amazonaws.m2#Arn" }, "traits": { "smithy.api#length": { "min": 1 } } }, "com.amazonaws.m2#AuthSecretsManagerArn": { "type": "string", "traits": { "smithy.api#length": { "min": 20, "max": 2048 } } }, "com.amazonaws.m2#AwsSupernovaControlPlaneService": { "type": "service", "version": "2021-04-28", "operations": [ { "target": "com.amazonaws.m2#GetSignedBluinsightsUrl" }, { "target": "com.amazonaws.m2#ListEngineVersions" }, { "target": "com.amazonaws.m2#ListTagsForResource" }, { "target": "com.amazonaws.m2#TagResource" }, { "target": "com.amazonaws.m2#UntagResource" } ], "resources": [ { "target": "com.amazonaws.m2#Application" }, { "target": "com.amazonaws.m2#Environment" } ], "traits": { "aws.api#service": { "sdkId": "m2", "sdkServiceId": "M2", "serviceName": "m2", "arnNamespace": "m2", "cloudFormationName": "M2", "cloudTrailEventSource": "m2.amazonaws.com", "endpointPrefix": "m2" }, "aws.auth#sigv4": { "name": "m2" }, "aws.iam#defineConditionKeys": { "aws:ResourceTag/${TagKey}": { "type": "String", "documentation": "Filters access by a tag key and value pair of a resource" }, "aws:RequestTag/${TagKey}": { "type": "String", "documentation": "Filters access by a tag key and value pair that is allowed in the request" }, "aws:TagKeys": { "type": "String", "documentation": "Filters access by a list of tag keys that are allowed in the request" } }, "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,amz-sdk-invocation-id,amz-sdk-request" ] }, "smithy.api#documentation": "

Amazon Web Services Mainframe Modernization provides tools and resources to help you plan and implement migration and\n modernization from mainframes to Amazon Web Services managed runtime environments. It provides tools for\n analyzing existing mainframe applications, developing or updating mainframe applications\n using COBOL or PL/I, and implementing an automated pipeline for continuous integration and\n continuous delivery (CI/CD) of the applications.

", "smithy.api#title": "AWSMainframeModernization", "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://m2-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://m2-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://m2.{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://m2.{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": [ { "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://m2-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://m2-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://m2.{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://m2.{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-southeast-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://m2.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://m2.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://m2.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://m2.eu-west-1.amazonaws.com" } }, "params": { "Region": "eu-west-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://m2.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://m2.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://m2.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://m2-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://m2-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://m2.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://m2-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://m2-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://m2.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://m2.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://m2-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://m2-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://m2.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://m2.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://m2-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://m2.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://m2-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://m2.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.m2#BatchJobDefinition": { "type": "union", "members": { "fileBatchJobDefinition": { "target": "com.amazonaws.m2#FileBatchJobDefinition", "traits": { "smithy.api#documentation": "

Specifies a file containing a batch job definition.

" } }, "scriptBatchJobDefinition": { "target": "com.amazonaws.m2#ScriptBatchJobDefinition", "traits": { "smithy.api#documentation": "

A script containing a batch job definition.

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

Defines the details of a batch job.

" } }, "com.amazonaws.m2#BatchJobDefinitions": { "type": "list", "member": { "target": "com.amazonaws.m2#BatchJobDefinition" } }, "com.amazonaws.m2#BatchJobExecutionStatus": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "Submitting", "name": "SUBMITTING" }, { "value": "Holding", "name": "HOLDING" }, { "value": "Dispatching", "name": "DISPATCH" }, { "value": "Running", "name": "RUNNING" }, { "value": "Cancelling", "name": "CANCELLING" }, { "value": "Cancelled", "name": "CANCELLED" }, { "value": "Succeeded", "name": "SUCCEEDED" }, { "value": "Failed", "name": "FAILED" }, { "value": "Purged", "name": "PURGED" }, { "value": "Succeeded With Warning", "name": "SUCCEEDED_WITH_WARNING" } ] } }, "com.amazonaws.m2#BatchJobExecutionSummary": { "type": "structure", "members": { "executionId": { "target": "com.amazonaws.m2#Identifier", "traits": { "smithy.api#documentation": "

The unique identifier of this execution of the batch job.

", "smithy.api#required": {} } }, "applicationId": { "target": "com.amazonaws.m2#Identifier", "traits": { "smithy.api#documentation": "

The unique identifier of the application that hosts this batch job.

", "smithy.api#required": {} } }, "jobId": { "target": "com.amazonaws.m2#String100", "traits": { "smithy.api#documentation": "

The unique identifier of a particular batch job.

" } }, "jobName": { "target": "com.amazonaws.m2#String100", "traits": { "smithy.api#documentation": "

The name of a particular batch job.

" } }, "jobType": { "target": "com.amazonaws.m2#BatchJobType", "traits": { "smithy.api#documentation": "

The type of a particular batch job execution.

" } }, "status": { "target": "com.amazonaws.m2#BatchJobExecutionStatus", "traits": { "smithy.api#documentation": "

The status of a particular batch job execution.

", "smithy.api#required": {} } }, "startTime": { "target": "com.amazonaws.m2#Timestamp", "traits": { "smithy.api#documentation": "

The timestamp when a particular batch job execution started.

", "smithy.api#required": {} } }, "endTime": { "target": "com.amazonaws.m2#Timestamp", "traits": { "smithy.api#documentation": "

The timestamp when this batch job execution ended.

" } }, "returnCode": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The batch job return code from either the Blu Age or Micro Focus runtime engines. For more\n information, see Batch return\n codes in the IBM WebSphere Application Server\n documentation.

" } }, "batchJobIdentifier": { "target": "com.amazonaws.m2#BatchJobIdentifier", "traits": { "smithy.api#documentation": "

The unique identifier of this batch job.

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

A subset of the possible batch job attributes. Used in the batch job list.

" } }, "com.amazonaws.m2#BatchJobExecutionSummaryList": { "type": "list", "member": { "target": "com.amazonaws.m2#BatchJobExecutionSummary" } }, "com.amazonaws.m2#BatchJobIdentifier": { "type": "union", "members": { "fileBatchJobIdentifier": { "target": "com.amazonaws.m2#FileBatchJobIdentifier", "traits": { "smithy.api#documentation": "

Specifies a file associated with a specific batch job.

" } }, "scriptBatchJobIdentifier": { "target": "com.amazonaws.m2#ScriptBatchJobIdentifier", "traits": { "smithy.api#documentation": "

A batch job identifier in which the batch job to run is identified by the script\n name.

" } }, "s3BatchJobIdentifier": { "target": "com.amazonaws.m2#S3BatchJobIdentifier", "traits": { "smithy.api#documentation": "

Specifies an Amazon S3 location that identifies the batch jobs that you want to run. Use this identifier to run ad hoc batch jobs.

" } }, "restartBatchJobIdentifier": { "target": "com.amazonaws.m2#RestartBatchJobIdentifier", "traits": { "smithy.api#documentation": "

Specifies the required information for restart, including executionId and JobStepRestartMarker.

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

Identifies a specific batch job.

" } }, "com.amazonaws.m2#BatchJobParametersMap": { "type": "map", "key": { "target": "com.amazonaws.m2#BatchParamKey" }, "value": { "target": "com.amazonaws.m2#BatchParamValue" }, "traits": { "smithy.api#documentation": "Job parameters are optional.\nCan contain up to 500 entries.", "smithy.api#length": { "min": 0, "max": 500 } } }, "com.amazonaws.m2#BatchJobStepList": { "type": "list", "member": { "target": "com.amazonaws.m2#JobStep" } }, "com.amazonaws.m2#BatchJobType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "VSE", "name": "VSE" }, { "value": "JES2", "name": "JES2" }, { "value": "JES3", "name": "JES3" } ] } }, "com.amazonaws.m2#BatchParamKey": { "type": "string", "traits": { "smithy.api#documentation": "See https://www.ibm.com/docs/en/workload-automation/9.3.0?topic=zos-coding-variables-in-jcl\nto get details about limits for both keys and values:\n8 for keys (variable names), 44 for values (variable values)\nIn addition, keys will be only alphabetic characters and digits, without any space\nor special characters (dash, underscore, etc ...)\n\nFor BluAge Engine:\nThere is no limit in length of keys and values.\nAdditional validation may be applied in code, per engine.\nParameter key: the first character must be alphabetic.\nCan be of up to 32 alphanumeric characters.", "smithy.api#length": { "min": 1, "max": 32 }, "smithy.api#pattern": "^[A-Za-z][A-Za-z0-9]{1,31}$" } }, "com.amazonaws.m2#BatchParamValue": { "type": "string", "traits": { "smithy.api#documentation": "Parameter value can be of up to 1024 alphanumeric characters.", "smithy.api#length": { "min": 0, "max": 1024 } } }, "com.amazonaws.m2#Boolean": { "type": "boolean", "traits": { "smithy.api#default": false } }, "com.amazonaws.m2#CancelBatchJobExecution": { "type": "operation", "input": { "target": "com.amazonaws.m2#CancelBatchJobExecutionRequest" }, "output": { "target": "com.amazonaws.m2#CancelBatchJobExecutionResponse" }, "errors": [ { "target": "com.amazonaws.m2#AccessDeniedException" }, { "target": "com.amazonaws.m2#ConflictException" }, { "target": "com.amazonaws.m2#InternalServerException" }, { "target": "com.amazonaws.m2#ResourceNotFoundException" }, { "target": "com.amazonaws.m2#ThrottlingException" }, { "target": "com.amazonaws.m2#ValidationException" } ], "traits": { "aws.api#controlPlane": {}, "smithy.api#documentation": "

Cancels the running of a specific batch job execution.

", "smithy.api#http": { "method": "POST", "uri": "/applications/{applicationId}/batch-job-executions/{executionId}/cancel", "code": 200 } } }, "com.amazonaws.m2#CancelBatchJobExecutionRequest": { "type": "structure", "members": { "applicationId": { "target": "com.amazonaws.m2#Identifier", "traits": { "smithy.api#documentation": "

The unique identifier of the application.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "executionId": { "target": "com.amazonaws.m2#Identifier", "traits": { "smithy.api#documentation": "

The unique identifier of the batch job execution.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "authSecretsManagerArn": { "target": "com.amazonaws.m2#AuthSecretsManagerArn", "traits": { "smithy.api#documentation": "

The Amazon Web Services Secrets Manager containing user's credentials for authentication and authorization for Cancel Batch Job Execution operation.

" } } } }, "com.amazonaws.m2#CancelBatchJobExecutionResponse": { "type": "structure", "members": {} }, "com.amazonaws.m2#CapacityValue": { "type": "integer" }, "com.amazonaws.m2#ClientToken": { "type": "string", "traits": { "smithy.api#documentation": "A client token is a unique, case-sensitive string of up to 128 ASCII characters with ASCII values of 33-126 inclusive.\n It is generated by the client to ensure idempotent operations, allowing safe retries without unintended side effects.", "smithy.api#length": { "max": 128 }, "smithy.api#pattern": "^[!-~]+$" } }, "com.amazonaws.m2#ConflictException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } }, "resourceId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The ID of the conflicting resource.

" } }, "resourceType": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The type of the conflicting resource.

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

The parameters provided in the request conflict with existing resources.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.m2#CreateApplication": { "type": "operation", "input": { "target": "com.amazonaws.m2#CreateApplicationRequest" }, "output": { "target": "com.amazonaws.m2#CreateApplicationResponse" }, "errors": [ { "target": "com.amazonaws.m2#AccessDeniedException" }, { "target": "com.amazonaws.m2#ConflictException" }, { "target": "com.amazonaws.m2#InternalServerException" }, { "target": "com.amazonaws.m2#ServiceQuotaExceededException" }, { "target": "com.amazonaws.m2#ThrottlingException" }, { "target": "com.amazonaws.m2#ValidationException" } ], "traits": { "aws.api#controlPlane": {}, "aws.iam#conditionKeys": [ "aws:RequestTag/${TagKey}", "aws:TagKeys" ], "aws.iam#requiredActions": [ "s3:GetObject", "s3:ListBucket" ], "smithy.api#documentation": "

Creates a new application with given parameters. Requires an existing runtime\n environment and application definition file.

", "smithy.api#http": { "method": "POST", "uri": "/applications", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.m2#CreateApplicationRequest": { "type": "structure", "members": { "name": { "target": "com.amazonaws.m2#EntityName", "traits": { "smithy.api#documentation": "

The unique identifier of the application.

", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.m2#EntityDescription", "traits": { "smithy.api#documentation": "

The description of the application.

" } }, "engineType": { "target": "com.amazonaws.m2#EngineType", "traits": { "smithy.api#documentation": "

The type of the target platform for this application.

", "smithy.api#required": {} } }, "definition": { "target": "com.amazonaws.m2#Definition", "traits": { "smithy.api#documentation": "

The application definition for this application. You can specify either inline JSON or\n an S3 bucket location.

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

A list of tags to apply to the application.

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

A client token is a unique, case-sensitive string of up to 128 ASCII characters with ASCII values of 33-126 inclusive.\n It's generated by the client to ensure idempotent operations, allowing for safe retries without unintended side effects.

", "smithy.api#idempotencyToken": {} } }, "kmsKeyId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The identifier of a customer managed key.

" } }, "roleArn": { "target": "com.amazonaws.m2#Arn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) that identifies a role that the application uses to access Amazon Web Services resources\n that are not part of the application or are in a different Amazon Web Services account.

" } } } }, "com.amazonaws.m2#CreateApplicationResponse": { "type": "structure", "members": { "applicationArn": { "target": "com.amazonaws.m2#Arn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the application.

", "smithy.api#required": {} } }, "applicationId": { "target": "com.amazonaws.m2#Identifier", "traits": { "smithy.api#documentation": "

The unique application identifier.

", "smithy.api#required": {} } }, "applicationVersion": { "target": "com.amazonaws.m2#Version", "traits": { "smithy.api#documentation": "

The version number of the application.

", "smithy.api#required": {} } } } }, "com.amazonaws.m2#CreateDataSetExportTask": { "type": "operation", "input": { "target": "com.amazonaws.m2#CreateDataSetExportTaskRequest" }, "output": { "target": "com.amazonaws.m2#CreateDataSetExportTaskResponse" }, "errors": [ { "target": "com.amazonaws.m2#AccessDeniedException" }, { "target": "com.amazonaws.m2#ConflictException" }, { "target": "com.amazonaws.m2#InternalServerException" }, { "target": "com.amazonaws.m2#ResourceNotFoundException" }, { "target": "com.amazonaws.m2#ServiceQuotaExceededException" }, { "target": "com.amazonaws.m2#ThrottlingException" }, { "target": "com.amazonaws.m2#ValidationException" } ], "traits": { "aws.api#controlPlane": {}, "aws.iam#iamAction": { "requiredActions": [ "s3:GetObject" ], "documentation": "Grants permission to create a data set export task" }, "smithy.api#documentation": "

Starts a data set export task for a specific application.

", "smithy.api#http": { "method": "POST", "uri": "/applications/{applicationId}/dataset-export-task", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.m2#CreateDataSetExportTaskRequest": { "type": "structure", "members": { "applicationId": { "target": "com.amazonaws.m2#Identifier", "traits": { "smithy.api#documentation": "

The unique identifier of the application for which you want to export data sets.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "exportConfig": { "target": "com.amazonaws.m2#DataSetExportConfig", "traits": { "smithy.api#documentation": "

The data set export task configuration.

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

Unique, case-sensitive identifier you provide to ensure the idempotency of the request to create a data set export. The service generates the clientToken when the API call is triggered. The token expires after one hour, so if you retry the API within this timeframe with the same clientToken, you will get the same response. The service also handles deleting the clientToken after it expires.

", "smithy.api#idempotencyToken": {} } }, "kmsKeyId": { "target": "com.amazonaws.m2#KMSKeyId", "traits": { "smithy.api#documentation": "

The identifier of a customer managed key.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.m2#CreateDataSetExportTaskResponse": { "type": "structure", "members": { "taskId": { "target": "com.amazonaws.m2#Identifier", "traits": { "smithy.api#documentation": "

The task identifier. This operation is asynchronous. Use this identifier with the GetDataSetExportTask operation to obtain the status of this task.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.m2#CreateDataSetImportTask": { "type": "operation", "input": { "target": "com.amazonaws.m2#CreateDataSetImportTaskRequest" }, "output": { "target": "com.amazonaws.m2#CreateDataSetImportTaskResponse" }, "errors": [ { "target": "com.amazonaws.m2#AccessDeniedException" }, { "target": "com.amazonaws.m2#ConflictException" }, { "target": "com.amazonaws.m2#InternalServerException" }, { "target": "com.amazonaws.m2#ResourceNotFoundException" }, { "target": "com.amazonaws.m2#ServiceQuotaExceededException" }, { "target": "com.amazonaws.m2#ThrottlingException" }, { "target": "com.amazonaws.m2#ValidationException" } ], "traits": { "aws.api#controlPlane": {}, "smithy.api#documentation": "

Starts a data set import task for a specific application.

", "smithy.api#http": { "method": "POST", "uri": "/applications/{applicationId}/dataset-import-task", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.m2#CreateDataSetImportTaskRequest": { "type": "structure", "members": { "applicationId": { "target": "com.amazonaws.m2#Identifier", "traits": { "smithy.api#documentation": "

The unique identifier of the application for which you want to import data sets.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "importConfig": { "target": "com.amazonaws.m2#DataSetImportConfig", "traits": { "smithy.api#documentation": "

The data set import task configuration.

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

Unique, case-sensitive identifier you provide to ensure the idempotency of the request\n to create a data set import. The service generates the clientToken when the API call is\n triggered. The token expires after one hour, so if you retry the API within this timeframe\n with the same clientToken, you will get the same response. The service also handles\n deleting the clientToken after it expires.

", "smithy.api#idempotencyToken": {} } } } }, "com.amazonaws.m2#CreateDataSetImportTaskResponse": { "type": "structure", "members": { "taskId": { "target": "com.amazonaws.m2#Identifier", "traits": { "smithy.api#documentation": "

The task identifier. This operation is asynchronous. Use this identifier with the GetDataSetImportTask operation to obtain the status of this task.

", "smithy.api#required": {} } } } }, "com.amazonaws.m2#CreateDeployment": { "type": "operation", "input": { "target": "com.amazonaws.m2#CreateDeploymentRequest" }, "output": { "target": "com.amazonaws.m2#CreateDeploymentResponse" }, "errors": [ { "target": "com.amazonaws.m2#AccessDeniedException" }, { "target": "com.amazonaws.m2#ConflictException" }, { "target": "com.amazonaws.m2#InternalServerException" }, { "target": "com.amazonaws.m2#ResourceNotFoundException" }, { "target": "com.amazonaws.m2#ServiceQuotaExceededException" }, { "target": "com.amazonaws.m2#ThrottlingException" }, { "target": "com.amazonaws.m2#ValidationException" } ], "traits": { "aws.api#controlPlane": {}, "aws.iam#requiredActions": [ "elasticloadbalancing:CreateTargetGroup", "elasticloadbalancing:CreateListener" ], "smithy.api#documentation": "

Creates and starts a deployment to deploy an application into a runtime\n environment.

", "smithy.api#http": { "method": "POST", "uri": "/applications/{applicationId}/deployments", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.m2#CreateDeploymentRequest": { "type": "structure", "members": { "environmentId": { "target": "com.amazonaws.m2#Identifier", "traits": { "smithy.api#documentation": "

The identifier of the runtime environment where you want to deploy this\n application.

", "smithy.api#required": {} } }, "applicationId": { "target": "com.amazonaws.m2#Identifier", "traits": { "smithy.api#documentation": "

The application identifier.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "applicationVersion": { "target": "com.amazonaws.m2#Version", "traits": { "smithy.api#documentation": "

The version of the application to deploy.

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

Unique, case-sensitive identifier you provide to ensure the idempotency of the request\n to create a deployment. The service generates the clientToken when the API call is\n triggered. The token expires after one hour, so if you retry the API within this timeframe\n with the same clientToken, you will get the same response. The service also handles\n deleting the clientToken after it expires.

", "smithy.api#idempotencyToken": {} } } }, "traits": { "smithy.api#references": [ { "resource": "com.amazonaws.m2#Environment" } ] } }, "com.amazonaws.m2#CreateDeploymentResponse": { "type": "structure", "members": { "deploymentId": { "target": "com.amazonaws.m2#Identifier", "traits": { "smithy.api#documentation": "

The unique identifier of the deployment.

", "smithy.api#required": {} } } } }, "com.amazonaws.m2#CreateEnvironment": { "type": "operation", "input": { "target": "com.amazonaws.m2#CreateEnvironmentRequest" }, "output": { "target": "com.amazonaws.m2#CreateEnvironmentResponse" }, "errors": [ { "target": "com.amazonaws.m2#AccessDeniedException" }, { "target": "com.amazonaws.m2#ConflictException" }, { "target": "com.amazonaws.m2#InternalServerException" }, { "target": "com.amazonaws.m2#ServiceQuotaExceededException" }, { "target": "com.amazonaws.m2#ThrottlingException" }, { "target": "com.amazonaws.m2#ValidationException" } ], "traits": { "aws.api#controlPlane": {}, "aws.iam#conditionKeys": [ "aws:RequestTag/${TagKey}", "aws:TagKeys" ], "aws.iam#requiredActions": [ "ec2:DescribeSecurityGroups", "ec2:DescribeSubnets", "ec2:DescribeVpcs", "ec2:DescribeNetworkInterfaces", "ec2:DescribeVpcAttribute", "elasticloadbalancing:CreateLoadBalancer" ], "smithy.api#documentation": "

Creates a runtime environment for a given runtime engine.

", "smithy.api#http": { "method": "POST", "uri": "/environments", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.m2#CreateEnvironmentRequest": { "type": "structure", "members": { "name": { "target": "com.amazonaws.m2#EntityName", "traits": { "smithy.api#documentation": "

The name of the runtime environment. Must be unique within the account.

", "smithy.api#required": {} } }, "instanceType": { "target": "com.amazonaws.m2#String20", "traits": { "smithy.api#documentation": "

The type of instance for the runtime environment.

", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.m2#EntityDescription", "traits": { "smithy.api#documentation": "

The description of the runtime environment.

" } }, "engineType": { "target": "com.amazonaws.m2#EngineType", "traits": { "smithy.api#documentation": "

The engine type for the runtime environment.

", "smithy.api#required": {} } }, "engineVersion": { "target": "com.amazonaws.m2#EngineVersion", "traits": { "smithy.api#documentation": "

The version of the engine type for the runtime environment.

" } }, "subnetIds": { "target": "com.amazonaws.m2#String50List", "traits": { "smithy.api#documentation": "

The list of subnets associated with the VPC for this runtime environment.

" } }, "securityGroupIds": { "target": "com.amazonaws.m2#String50List", "traits": { "smithy.api#documentation": "

The list of security groups for the VPC associated with this runtime environment.

" } }, "storageConfigurations": { "target": "com.amazonaws.m2#StorageConfigurationList", "traits": { "smithy.api#documentation": "

Optional. The storage configurations for this runtime environment.

" } }, "publiclyAccessible": { "target": "com.amazonaws.m2#Boolean", "traits": { "smithy.api#default": false, "smithy.api#documentation": "

Specifies whether the runtime environment is publicly accessible.

" } }, "highAvailabilityConfig": { "target": "com.amazonaws.m2#HighAvailabilityConfig", "traits": { "smithy.api#documentation": "

The details of a high availability configuration for this runtime environment.

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

The tags for the runtime environment.

" } }, "preferredMaintenanceWindow": { "target": "com.amazonaws.m2#String50", "traits": { "smithy.api#documentation": "

Configures the maintenance window that you want for the runtime environment. The maintenance window must have the format ddd:hh24:mi-ddd:hh24:mi and must be less than 24 hours. The following two examples are valid maintenance windows: sun:23:45-mon:00:15 or sat:01:00-sat:03:00.

\n

If you do not provide a value, a random system-generated value will be assigned.

" } }, "networkType": { "target": "com.amazonaws.m2#NetworkType", "traits": { "smithy.api#documentation": "

The network type required for the runtime environment.

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

Unique, case-sensitive identifier you provide to ensure the idempotency of the request\n to create an environment. The service generates the clientToken when the API call is\n triggered. The token expires after one hour, so if you retry the API within this timeframe\n with the same clientToken, you will get the same response. The service also handles\n deleting the clientToken after it expires.

", "smithy.api#idempotencyToken": {} } }, "kmsKeyId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The identifier of a customer managed key.

" } } } }, "com.amazonaws.m2#CreateEnvironmentResponse": { "type": "structure", "members": { "environmentId": { "target": "com.amazonaws.m2#Identifier", "traits": { "smithy.api#documentation": "

The unique identifier of the runtime environment.

", "smithy.api#required": {} } } } }, "com.amazonaws.m2#DataSet": { "type": "structure", "members": { "storageType": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The storage type of the data set: database or file system. For Micro Focus, database\n corresponds to datastore and file system corresponds to EFS/FSX. For Blu Age, there is no\n support of file system and database corresponds to Blusam.

" } }, "datasetName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The logical identifier for a specific data set (in mainframe format).

", "smithy.api#required": {} } }, "datasetOrg": { "target": "com.amazonaws.m2#DatasetOrgAttributes", "traits": { "smithy.api#documentation": "

The type of dataset. The only supported value is VSAM.

", "smithy.api#required": {} } }, "relativePath": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The relative location of the data set in the database or file system.

" } }, "recordLength": { "target": "com.amazonaws.m2#RecordLength", "traits": { "smithy.api#documentation": "

The length of a record.

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

Defines a data set.

" } }, "com.amazonaws.m2#DataSetExportConfig": { "type": "union", "members": { "s3Location": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The Amazon S3 location of the data sets.

" } }, "dataSets": { "target": "com.amazonaws.m2#DataSetExportList", "traits": { "smithy.api#documentation": "

The data sets.

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

Identifies one or more data sets you want to import with the CreateDataSetExportTask operation.

" } }, "com.amazonaws.m2#DataSetExportItem": { "type": "structure", "members": { "datasetName": { "target": "com.amazonaws.m2#String200", "traits": { "smithy.api#documentation": "

The data set.

", "smithy.api#required": {} } }, "externalLocation": { "target": "com.amazonaws.m2#ExternalLocation", "traits": { "smithy.api#documentation": "

The location of the data set.

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

Identifies a specific data set to export from an external location.

" } }, "com.amazonaws.m2#DataSetExportList": { "type": "list", "member": { "target": "com.amazonaws.m2#DataSetExportItem" }, "traits": { "smithy.api#length": { "min": 1, "max": 1024 } } }, "com.amazonaws.m2#DataSetExportSummary": { "type": "structure", "members": { "total": { "target": "com.amazonaws.m2#Integer", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "

The total number of data set exports.

", "smithy.api#required": {} } }, "succeeded": { "target": "com.amazonaws.m2#Integer", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "

The number of data set exports that have succeeded.

", "smithy.api#required": {} } }, "failed": { "target": "com.amazonaws.m2#Integer", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "

The number of data set exports that have failed.

", "smithy.api#required": {} } }, "pending": { "target": "com.amazonaws.m2#Integer", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "

The number of data set exports that are pending.

", "smithy.api#required": {} } }, "inProgress": { "target": "com.amazonaws.m2#Integer", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "

The number of data set exports that are in progress.

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

Represents a summary of data set exports.

" } }, "com.amazonaws.m2#DataSetExportTask": { "type": "structure", "members": { "taskId": { "target": "com.amazonaws.m2#Identifier", "traits": { "smithy.api#documentation": "

The identifier of the data set export task.

", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.m2#DataSetTaskLifecycle", "traits": { "smithy.api#documentation": "

The status of the data set export task.

", "smithy.api#required": {} } }, "summary": { "target": "com.amazonaws.m2#DataSetExportSummary", "traits": { "smithy.api#documentation": "

A summary of the data set export task.

", "smithy.api#required": {} } }, "statusReason": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

If dataset exports failed, the failure reason will show here.

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

Contains information about a data set export task.

" } }, "com.amazonaws.m2#DataSetExportTaskList": { "type": "list", "member": { "target": "com.amazonaws.m2#DataSetExportTask" } }, "com.amazonaws.m2#DataSetImportConfig": { "type": "union", "members": { "s3Location": { "target": "com.amazonaws.m2#String2000", "traits": { "smithy.api#documentation": "

The Amazon S3 location of the data sets.

" } }, "dataSets": { "target": "com.amazonaws.m2#DataSetImportList", "traits": { "smithy.api#documentation": "

The data sets.

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

Identifies one or more data sets you want to import with the CreateDataSetImportTask operation.

" } }, "com.amazonaws.m2#DataSetImportItem": { "type": "structure", "members": { "dataSet": { "target": "com.amazonaws.m2#DataSet", "traits": { "smithy.api#documentation": "

The data set.

", "smithy.api#required": {} } }, "externalLocation": { "target": "com.amazonaws.m2#ExternalLocation", "traits": { "smithy.api#documentation": "

The location of the data set.

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

Identifies a specific data set to import from an external location.

" } }, "com.amazonaws.m2#DataSetImportList": { "type": "list", "member": { "target": "com.amazonaws.m2#DataSetImportItem" }, "traits": { "smithy.api#length": { "min": 1, "max": 100 } } }, "com.amazonaws.m2#DataSetImportSummary": { "type": "structure", "members": { "total": { "target": "com.amazonaws.m2#Integer", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "

The total number of data set imports.

", "smithy.api#required": {} } }, "succeeded": { "target": "com.amazonaws.m2#Integer", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "

The number of data set imports that have succeeded.

", "smithy.api#required": {} } }, "failed": { "target": "com.amazonaws.m2#Integer", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "

The number of data set imports that have failed.

", "smithy.api#required": {} } }, "pending": { "target": "com.amazonaws.m2#Integer", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "

The number of data set imports that are pending.

", "smithy.api#required": {} } }, "inProgress": { "target": "com.amazonaws.m2#Integer", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "

The number of data set imports that are in progress.

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

Represents a summary of data set imports.

" } }, "com.amazonaws.m2#DataSetImportTask": { "type": "structure", "members": { "taskId": { "target": "com.amazonaws.m2#Identifier", "traits": { "smithy.api#documentation": "

The identifier of the data set import task.

", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.m2#DataSetTaskLifecycle", "traits": { "smithy.api#documentation": "

The status of the data set import task.

", "smithy.api#required": {} } }, "summary": { "target": "com.amazonaws.m2#DataSetImportSummary", "traits": { "smithy.api#documentation": "

A summary of the data set import task.

", "smithy.api#required": {} } }, "statusReason": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

If dataset import failed, the failure reason will show here.

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

Contains information about a data set import task.

" } }, "com.amazonaws.m2#DataSetImportTaskList": { "type": "list", "member": { "target": "com.amazonaws.m2#DataSetImportTask" } }, "com.amazonaws.m2#DataSetSummary": { "type": "structure", "members": { "dataSetName": { "target": "com.amazonaws.m2#String200", "traits": { "smithy.api#documentation": "

The name of the data set.

", "smithy.api#required": {} } }, "dataSetOrg": { "target": "com.amazonaws.m2#String20", "traits": { "smithy.api#documentation": "

The type of data set. The only supported value is VSAM.

" } }, "format": { "target": "com.amazonaws.m2#String20", "traits": { "smithy.api#documentation": "

The format of the data set.

" } }, "creationTime": { "target": "com.amazonaws.m2#Timestamp", "traits": { "smithy.api#documentation": "

The timestamp when the data set was created.

" } }, "lastUpdatedTime": { "target": "com.amazonaws.m2#Timestamp", "traits": { "smithy.api#documentation": "

The last time the data set was updated.

" } }, "lastReferencedTime": { "target": "com.amazonaws.m2#Timestamp", "traits": { "smithy.api#documentation": "

The last time the data set was referenced.

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

A subset of the possible data set attributes.

" } }, "com.amazonaws.m2#DataSetTaskLifecycle": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "Creating", "name": "CREATING" }, { "value": "Running", "name": "RUNNING" }, { "value": "Completed", "name": "COMPLETED" }, { "value": "Failed", "name": "FAILED" } ] } }, "com.amazonaws.m2#DataSetsSummaryList": { "type": "list", "member": { "target": "com.amazonaws.m2#DataSetSummary" } }, "com.amazonaws.m2#DatasetDetailOrgAttributes": { "type": "union", "members": { "vsam": { "target": "com.amazonaws.m2#VsamDetailAttributes", "traits": { "smithy.api#documentation": "

The details of a VSAM data set.

" } }, "gdg": { "target": "com.amazonaws.m2#GdgDetailAttributes", "traits": { "smithy.api#documentation": "

The generation data group of the data set.

" } }, "po": { "target": "com.amazonaws.m2#PoDetailAttributes", "traits": { "smithy.api#documentation": "

The details of a PO type data set.

" } }, "ps": { "target": "com.amazonaws.m2#PsDetailAttributes", "traits": { "smithy.api#documentation": "

The details of a PS type data set.

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

Additional details about the data set. Different attributes correspond to different data\n set organizations. The values are populated based on datasetOrg, storageType and backend\n (Blu Age or Micro Focus).

" } }, "com.amazonaws.m2#DatasetOrgAttributes": { "type": "union", "members": { "vsam": { "target": "com.amazonaws.m2#VsamAttributes", "traits": { "smithy.api#documentation": "

The details of a VSAM data set.

" } }, "gdg": { "target": "com.amazonaws.m2#GdgAttributes", "traits": { "smithy.api#documentation": "

The generation data group of the data set.

" } }, "po": { "target": "com.amazonaws.m2#PoAttributes", "traits": { "smithy.api#documentation": "

The details of a PO type data set.

" } }, "ps": { "target": "com.amazonaws.m2#PsAttributes", "traits": { "smithy.api#documentation": "

The details of a PS type data set.

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

Additional details about the data set. Different attributes correspond to different data\n set organizations. The values are populated based on datasetOrg, storageType and backend\n (Blu Age or Micro Focus).

" } }, "com.amazonaws.m2#Definition": { "type": "union", "members": { "s3Location": { "target": "com.amazonaws.m2#String2000", "traits": { "smithy.api#documentation": "

The S3 bucket that contains the application definition.

" } }, "content": { "target": "com.amazonaws.m2#StringFree65000", "traits": { "smithy.api#documentation": "

The content of the application definition. This is a JSON object that contains the\n resource configuration/definitions that identify an application.

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

The application definition for a particular application.

" } }, "com.amazonaws.m2#DeleteApplication": { "type": "operation", "input": { "target": "com.amazonaws.m2#DeleteApplicationRequest" }, "output": { "target": "com.amazonaws.m2#DeleteApplicationResponse" }, "errors": [ { "target": "com.amazonaws.m2#AccessDeniedException" }, { "target": "com.amazonaws.m2#ConflictException" }, { "target": "com.amazonaws.m2#InternalServerException" }, { "target": "com.amazonaws.m2#ThrottlingException" }, { "target": "com.amazonaws.m2#ValidationException" } ], "traits": { "aws.api#controlPlane": {}, "aws.iam#requiredActions": [ "elasticloadbalancing:DeleteTargetGroup", "elasticloadbalancing:DeleteListener" ], "smithy.api#documentation": "

Deletes a specific application. You cannot delete a running application.

", "smithy.api#http": { "method": "DELETE", "uri": "/applications/{applicationId}", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.m2#DeleteApplicationFromEnvironment": { "type": "operation", "input": { "target": "com.amazonaws.m2#DeleteApplicationFromEnvironmentRequest" }, "output": { "target": "com.amazonaws.m2#DeleteApplicationFromEnvironmentResponse" }, "errors": [ { "target": "com.amazonaws.m2#AccessDeniedException" }, { "target": "com.amazonaws.m2#ConflictException" }, { "target": "com.amazonaws.m2#InternalServerException" }, { "target": "com.amazonaws.m2#ResourceNotFoundException" }, { "target": "com.amazonaws.m2#ThrottlingException" }, { "target": "com.amazonaws.m2#ValidationException" } ], "traits": { "aws.api#controlPlane": {}, "smithy.api#documentation": "

Deletes a specific application from the specific runtime environment where it was\n previously deployed. You cannot delete a runtime environment using DeleteEnvironment if any\n application has ever been deployed to it. This API removes the association of the\n application with the runtime environment so you can delete the environment smoothly.

", "smithy.api#http": { "method": "DELETE", "uri": "/applications/{applicationId}/environment/{environmentId}", "code": 200 } } }, "com.amazonaws.m2#DeleteApplicationFromEnvironmentRequest": { "type": "structure", "members": { "applicationId": { "target": "com.amazonaws.m2#Identifier", "traits": { "smithy.api#documentation": "

The unique identifier of the application you want to delete.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "environmentId": { "target": "com.amazonaws.m2#Identifier", "traits": { "smithy.api#documentation": "

The unique identifier of the runtime environment where the application was previously\n deployed.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.m2#DeleteApplicationFromEnvironmentResponse": { "type": "structure", "members": {} }, "com.amazonaws.m2#DeleteApplicationRequest": { "type": "structure", "members": { "applicationId": { "target": "com.amazonaws.m2#Identifier", "traits": { "smithy.api#documentation": "

The unique identifier of the application you want to delete.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.m2#DeleteApplicationResponse": { "type": "structure", "members": {} }, "com.amazonaws.m2#DeleteEnvironment": { "type": "operation", "input": { "target": "com.amazonaws.m2#DeleteEnvironmentRequest" }, "output": { "target": "com.amazonaws.m2#DeleteEnvironmentResponse" }, "errors": [ { "target": "com.amazonaws.m2#AccessDeniedException" }, { "target": "com.amazonaws.m2#ConflictException" }, { "target": "com.amazonaws.m2#InternalServerException" }, { "target": "com.amazonaws.m2#ThrottlingException" }, { "target": "com.amazonaws.m2#ValidationException" } ], "traits": { "aws.api#controlPlane": {}, "aws.iam#requiredActions": [ "elasticloadbalancing:DeleteLoadBalancer" ], "smithy.api#documentation": "

Deletes a specific runtime environment. The environment cannot contain deployed\n applications. If it does, you must delete those applications before you delete the\n environment.

", "smithy.api#http": { "method": "DELETE", "uri": "/environments/{environmentId}", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.m2#DeleteEnvironmentRequest": { "type": "structure", "members": { "environmentId": { "target": "com.amazonaws.m2#Identifier", "traits": { "smithy.api#documentation": "

The unique identifier of the runtime environment you want to delete.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.m2#DeleteEnvironmentResponse": { "type": "structure", "members": {} }, "com.amazonaws.m2#DeployedVersionSummary": { "type": "structure", "members": { "applicationVersion": { "target": "com.amazonaws.m2#Version", "traits": { "smithy.api#documentation": "

The version of the deployed application.

", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.m2#DeploymentLifecycle", "traits": { "smithy.api#documentation": "

The status of the deployment.

", "smithy.api#required": {} } }, "statusReason": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The reason for the reported status.

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

Contains a summary of a deployed application.

" } }, "com.amazonaws.m2#DeploymentLifecycle": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "Deploying", "name": "DEPLOYING" }, { "value": "Succeeded", "name": "SUCCEEDED" }, { "value": "Failed", "name": "FAILED" }, { "value": "Updating Deployment", "name": "DEPLOY_UPDATE" } ] } }, "com.amazonaws.m2#DeploymentList": { "type": "list", "member": { "target": "com.amazonaws.m2#DeploymentSummary" } }, "com.amazonaws.m2#DeploymentSummary": { "type": "structure", "members": { "deploymentId": { "target": "com.amazonaws.m2#Identifier", "traits": { "smithy.api#documentation": "

The unique identifier of the deployment.

", "smithy.api#required": {} } }, "applicationId": { "target": "com.amazonaws.m2#Identifier", "traits": { "smithy.api#documentation": "

The unique identifier of the application.

", "smithy.api#required": {} } }, "environmentId": { "target": "com.amazonaws.m2#Identifier", "traits": { "smithy.api#documentation": "

The unique identifier of the runtime environment.

", "smithy.api#required": {} } }, "applicationVersion": { "target": "com.amazonaws.m2#Version", "traits": { "smithy.api#documentation": "

The version of the application.

", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.m2#DeploymentLifecycle", "traits": { "smithy.api#documentation": "

The current status of the deployment.

", "smithy.api#required": {} } }, "creationTime": { "target": "com.amazonaws.m2#Timestamp", "traits": { "smithy.api#documentation": "

The timestamp when the deployment was created.

", "smithy.api#required": {} } }, "statusReason": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The reason for the reported status.

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

A subset of information about a specific deployment.

" } }, "com.amazonaws.m2#EfsStorageConfiguration": { "type": "structure", "members": { "fileSystemId": { "target": "com.amazonaws.m2#String200", "traits": { "smithy.api#documentation": "

The file system identifier.

", "smithy.api#jsonName": "file-system-id", "smithy.api#required": {} } }, "mountPoint": { "target": "com.amazonaws.m2#String200", "traits": { "smithy.api#documentation": "

The mount point for the file system.

", "smithy.api#jsonName": "mount-point", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Defines the storage configuration for an Amazon EFS file system.

" } }, "com.amazonaws.m2#EngineType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "microfocus", "name": "MICROFOCUS" }, { "value": "bluage", "name": "BLUAGE" } ] } }, "com.amazonaws.m2#EngineVersion": { "type": "string", "traits": { "smithy.api#pattern": "^\\S{1,10}$" } }, "com.amazonaws.m2#EngineVersionsSummary": { "type": "structure", "members": { "engineType": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The type of target platform for the application.

", "smithy.api#required": {} } }, "engineVersion": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The version of the engine type used by the application.

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

A subset of information about the engine version for a specific application.

" } }, "com.amazonaws.m2#EngineVersionsSummaryList": { "type": "list", "member": { "target": "com.amazonaws.m2#EngineVersionsSummary" } }, "com.amazonaws.m2#EntityDescription": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 500 } } }, "com.amazonaws.m2#EntityName": { "type": "string", "traits": { "smithy.api#pattern": "^[A-Za-z0-9][A-Za-z0-9_\\-]{1,59}$" } }, "com.amazonaws.m2#EntityNameList": { "type": "list", "member": { "target": "com.amazonaws.m2#EntityName" }, "traits": { "smithy.api#length": { "min": 1, "max": 10 } } }, "com.amazonaws.m2#Environment": { "type": "resource", "identifiers": { "environmentId": { "target": "com.amazonaws.m2#Identifier" } }, "create": { "target": "com.amazonaws.m2#CreateEnvironment" }, "read": { "target": "com.amazonaws.m2#GetEnvironment" }, "update": { "target": "com.amazonaws.m2#UpdateEnvironment" }, "delete": { "target": "com.amazonaws.m2#DeleteEnvironment" }, "list": { "target": "com.amazonaws.m2#ListEnvironments" }, "traits": { "aws.api#arn": { "template": "env/{environmentId}" }, "aws.iam#conditionKeys": [ "aws:ResourceTag/${TagKey}" ], "aws.iam#disableConditionKeyInference": {} } }, "com.amazonaws.m2#EnvironmentLifecycle": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "Creating", "name": "CREATING" }, { "value": "Available", "name": "AVAILABLE" }, { "value": "Updating", "name": "UPDATING" }, { "value": "Deleting", "name": "DELETING" }, { "value": "Failed", "name": "FAILED" }, { "value": "UnHealthy", "name": "UNHEALTHY" } ] } }, "com.amazonaws.m2#EnvironmentSummary": { "type": "structure", "members": { "name": { "target": "com.amazonaws.m2#EntityName", "traits": { "smithy.api#documentation": "

The name of the runtime environment.

", "smithy.api#required": {} } }, "environmentArn": { "target": "com.amazonaws.m2#Arn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a particular runtime environment.

", "smithy.api#required": {} } }, "environmentId": { "target": "com.amazonaws.m2#Identifier", "traits": { "smithy.api#documentation": "

The unique identifier of a particular runtime environment.

", "smithy.api#required": {} } }, "instanceType": { "target": "com.amazonaws.m2#String20", "traits": { "smithy.api#documentation": "

The instance type of the runtime environment.

", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.m2#EnvironmentLifecycle", "traits": { "smithy.api#documentation": "

The status of the runtime environment

", "smithy.api#required": {} } }, "engineType": { "target": "com.amazonaws.m2#EngineType", "traits": { "smithy.api#documentation": "

The target platform for the runtime environment.

", "smithy.api#required": {} } }, "engineVersion": { "target": "com.amazonaws.m2#EngineVersion", "traits": { "smithy.api#documentation": "

The version of the runtime engine.

", "smithy.api#required": {} } }, "creationTime": { "target": "com.amazonaws.m2#Timestamp", "traits": { "smithy.api#documentation": "

The timestamp when the runtime environment was created.

", "smithy.api#required": {} } }, "networkType": { "target": "com.amazonaws.m2#NetworkType", "traits": { "smithy.api#documentation": "

The network type supported by the runtime environment.

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

Contains a subset of the possible runtime environment attributes. Used in the\n environment list.

" } }, "com.amazonaws.m2#EnvironmentSummaryList": { "type": "list", "member": { "target": "com.amazonaws.m2#EnvironmentSummary" } }, "com.amazonaws.m2#ExecutionTimeoutException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Failed to connect to server, or didn\u2019t receive response within expected time period.

", "smithy.api#error": "server", "smithy.api#httpError": 504, "smithy.api#retryable": {} } }, "com.amazonaws.m2#ExternalLocation": { "type": "union", "members": { "s3Location": { "target": "com.amazonaws.m2#String2000", "traits": { "smithy.api#documentation": "

The URI of the Amazon S3 bucket.

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

Defines an external storage location.

" } }, "com.amazonaws.m2#FileBatchJobDefinition": { "type": "structure", "members": { "fileName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The name of the file containing the batch job definition.

", "smithy.api#required": {} } }, "folderPath": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The path to the file containing the batch job definition.

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

A file containing a batch job definition.

" } }, "com.amazonaws.m2#FileBatchJobIdentifier": { "type": "structure", "members": { "fileName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The file name for the batch job identifier.

", "smithy.api#required": {} } }, "folderPath": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The relative path to the file name for the batch job identifier.

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

A batch job identifier in which the batch job to run is identified by the file name and\n the relative path to the file name.

" } }, "com.amazonaws.m2#FsxStorageConfiguration": { "type": "structure", "members": { "fileSystemId": { "target": "com.amazonaws.m2#String200", "traits": { "smithy.api#documentation": "

The file system identifier.

", "smithy.api#jsonName": "file-system-id", "smithy.api#required": {} } }, "mountPoint": { "target": "com.amazonaws.m2#String200", "traits": { "smithy.api#documentation": "

The mount point for the file system.

", "smithy.api#jsonName": "mount-point", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Defines the storage configuration for an Amazon FSx file system.

" } }, "com.amazonaws.m2#GdgAttributes": { "type": "structure", "members": { "limit": { "target": "com.amazonaws.m2#Integer", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "

The maximum number of generation data sets, up to 255, in a GDG.

" } }, "rollDisposition": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The disposition of the data set in the catalog.

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

The required attributes for a generation data group data set. A generation data set is\n one of a collection of successive, historically related, catalogued data sets that together\n are known as a generation data group (GDG). Use this structure when you want to import a\n GDG. For more information on GDG, see Generation\n data sets.

" } }, "com.amazonaws.m2#GdgDetailAttributes": { "type": "structure", "members": { "limit": { "target": "com.amazonaws.m2#Integer", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "

The maximum number of generation data sets, up to 255, in a GDG.

" } }, "rollDisposition": { "target": "com.amazonaws.m2#String50", "traits": { "smithy.api#documentation": "

The disposition of the data set in the catalog.

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

The required attributes for a generation data group data set. A generation data set is\n one of a collection of successive, historically related, catalogued data sets that together\n are known as a generation data group (GDG). Use this structure when you want to import a\n GDG. For more information on GDG, see Generation\n data sets.

" } }, "com.amazonaws.m2#GetApplication": { "type": "operation", "input": { "target": "com.amazonaws.m2#GetApplicationRequest" }, "output": { "target": "com.amazonaws.m2#GetApplicationResponse" }, "errors": [ { "target": "com.amazonaws.m2#AccessDeniedException" }, { "target": "com.amazonaws.m2#InternalServerException" }, { "target": "com.amazonaws.m2#ResourceNotFoundException" }, { "target": "com.amazonaws.m2#ThrottlingException" }, { "target": "com.amazonaws.m2#ValidationException" } ], "traits": { "aws.api#controlPlane": {}, "smithy.api#documentation": "

Describes the details of a specific application.

", "smithy.api#http": { "method": "GET", "uri": "/applications/{applicationId}", "code": 200 }, "smithy.api#readonly": {} } }, "com.amazonaws.m2#GetApplicationRequest": { "type": "structure", "members": { "applicationId": { "target": "com.amazonaws.m2#Identifier", "traits": { "smithy.api#documentation": "

The identifier of the application.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.m2#GetApplicationResponse": { "type": "structure", "members": { "name": { "target": "com.amazonaws.m2#EntityName", "traits": { "smithy.api#documentation": "

The unique identifier of the application.

", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.m2#EntityDescription", "traits": { "smithy.api#documentation": "

The description of the application.

" } }, "applicationId": { "target": "com.amazonaws.m2#Identifier", "traits": { "smithy.api#documentation": "

The identifier of the application.

", "smithy.api#required": {} } }, "applicationArn": { "target": "com.amazonaws.m2#Arn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the application.

", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.m2#ApplicationLifecycle", "traits": { "smithy.api#documentation": "

The status of the application.

", "smithy.api#required": {} } }, "latestVersion": { "target": "com.amazonaws.m2#ApplicationVersionSummary", "traits": { "smithy.api#documentation": "

The latest version of the application.

", "smithy.api#required": {} } }, "deployedVersion": { "target": "com.amazonaws.m2#DeployedVersionSummary", "traits": { "smithy.api#documentation": "

The version of the application that is deployed.

" } }, "engineType": { "target": "com.amazonaws.m2#EngineType", "traits": { "smithy.api#documentation": "

The type of the target platform for the application.

", "smithy.api#required": {} } }, "logGroups": { "target": "com.amazonaws.m2#LogGroupSummaries", "traits": { "smithy.api#documentation": "

The list of log summaries. Each log summary includes the log type as well as the log\n group identifier. These are CloudWatch logs. Amazon Web Services Mainframe Modernization pushes the application log to CloudWatch under\n the customer's account.

" } }, "creationTime": { "target": "com.amazonaws.m2#Timestamp", "traits": { "smithy.api#documentation": "

The timestamp when this application was created.

", "smithy.api#required": {} } }, "lastStartTime": { "target": "com.amazonaws.m2#Timestamp", "traits": { "smithy.api#documentation": "

The timestamp when you last started the application. Null until the application runs for\n the first time.

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

A list of tags associated with the application.

" } }, "environmentId": { "target": "com.amazonaws.m2#Identifier", "traits": { "smithy.api#documentation": "

The identifier of the runtime environment where you want to deploy the\n application.

" } }, "targetGroupArns": { "target": "com.amazonaws.m2#ArnList", "traits": { "smithy.api#documentation": "

Returns the Amazon Resource Names (ARNs) of the target groups that are attached to the\n network load balancer.

" } }, "listenerArns": { "target": "com.amazonaws.m2#ArnList", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the network load balancer listener created in your\n Amazon Web Services account. Amazon Web Services Mainframe Modernization creates this listener for you the first time you deploy an\n application.

" } }, "listenerPorts": { "target": "com.amazonaws.m2#PortList", "traits": { "smithy.api#documentation": "

The port associated with the network load balancer listener created in your Amazon Web Services\n account.

" } }, "loadBalancerDnsName": { "target": "com.amazonaws.m2#String100", "traits": { "smithy.api#documentation": "

The public DNS name of the load balancer created in your Amazon Web Services account.

" } }, "statusReason": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The reason for the reported status.

" } }, "kmsKeyId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The identifier of a customer managed key.

" } }, "roleArn": { "target": "com.amazonaws.m2#Arn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the role associated with the application.

" } } } }, "com.amazonaws.m2#GetApplicationVersion": { "type": "operation", "input": { "target": "com.amazonaws.m2#GetApplicationVersionRequest" }, "output": { "target": "com.amazonaws.m2#GetApplicationVersionResponse" }, "errors": [ { "target": "com.amazonaws.m2#AccessDeniedException" }, { "target": "com.amazonaws.m2#InternalServerException" }, { "target": "com.amazonaws.m2#ResourceNotFoundException" }, { "target": "com.amazonaws.m2#ThrottlingException" }, { "target": "com.amazonaws.m2#ValidationException" } ], "traits": { "aws.api#controlPlane": {}, "smithy.api#documentation": "

Returns details about a specific version of a specific application.

", "smithy.api#http": { "method": "GET", "uri": "/applications/{applicationId}/versions/{applicationVersion}", "code": 200 }, "smithy.api#readonly": {} } }, "com.amazonaws.m2#GetApplicationVersionRequest": { "type": "structure", "members": { "applicationId": { "target": "com.amazonaws.m2#Identifier", "traits": { "smithy.api#documentation": "

The unique identifier of the application.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "applicationVersion": { "target": "com.amazonaws.m2#Version", "traits": { "smithy.api#documentation": "

The specific version of the application.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.m2#GetApplicationVersionResponse": { "type": "structure", "members": { "name": { "target": "com.amazonaws.m2#EntityName", "traits": { "smithy.api#documentation": "

The name of the application version.

", "smithy.api#required": {} } }, "applicationVersion": { "target": "com.amazonaws.m2#Version", "traits": { "smithy.api#documentation": "

The specific version of the application.

", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.m2#EntityDescription", "traits": { "smithy.api#documentation": "

The application description.

" } }, "definitionContent": { "target": "com.amazonaws.m2#StringFree65000", "traits": { "smithy.api#documentation": "

The content of the application definition. This is a JSON object that contains the\n resource configuration and definitions that identify an application.

", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.m2#ApplicationVersionLifecycle", "traits": { "smithy.api#documentation": "

The status of the application version.

", "smithy.api#required": {} } }, "creationTime": { "target": "com.amazonaws.m2#Timestamp", "traits": { "smithy.api#documentation": "

The timestamp when the application version was created.

", "smithy.api#required": {} } }, "statusReason": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The reason for the reported status.

" } } } }, "com.amazonaws.m2#GetBatchJobExecution": { "type": "operation", "input": { "target": "com.amazonaws.m2#GetBatchJobExecutionRequest" }, "output": { "target": "com.amazonaws.m2#GetBatchJobExecutionResponse" }, "errors": [ { "target": "com.amazonaws.m2#AccessDeniedException" }, { "target": "com.amazonaws.m2#InternalServerException" }, { "target": "com.amazonaws.m2#ResourceNotFoundException" }, { "target": "com.amazonaws.m2#ThrottlingException" }, { "target": "com.amazonaws.m2#ValidationException" } ], "traits": { "aws.api#controlPlane": {}, "smithy.api#documentation": "

Gets the details of a specific batch job execution for a specific application.

", "smithy.api#http": { "method": "GET", "uri": "/applications/{applicationId}/batch-job-executions/{executionId}", "code": 200 }, "smithy.api#readonly": {} } }, "com.amazonaws.m2#GetBatchJobExecutionRequest": { "type": "structure", "members": { "applicationId": { "target": "com.amazonaws.m2#Identifier", "traits": { "smithy.api#documentation": "

The identifier of the application.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "executionId": { "target": "com.amazonaws.m2#Identifier", "traits": { "smithy.api#documentation": "

The unique identifier of the batch job execution.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.m2#GetBatchJobExecutionResponse": { "type": "structure", "members": { "executionId": { "target": "com.amazonaws.m2#Identifier", "traits": { "smithy.api#documentation": "

The unique identifier for this batch job execution.

", "smithy.api#required": {} } }, "applicationId": { "target": "com.amazonaws.m2#Identifier", "traits": { "smithy.api#documentation": "

The identifier of the application.

", "smithy.api#required": {} } }, "jobId": { "target": "com.amazonaws.m2#String100", "traits": { "smithy.api#documentation": "

The unique identifier for this batch job.

" } }, "jobName": { "target": "com.amazonaws.m2#String100", "traits": { "smithy.api#documentation": "

The name of this batch job.

" } }, "jobUser": { "target": "com.amazonaws.m2#String100", "traits": { "smithy.api#documentation": "

The user for the job.

" } }, "jobType": { "target": "com.amazonaws.m2#BatchJobType", "traits": { "smithy.api#documentation": "

The type of job.

" } }, "status": { "target": "com.amazonaws.m2#BatchJobExecutionStatus", "traits": { "smithy.api#documentation": "

The status of the batch job execution.

", "smithy.api#required": {} } }, "startTime": { "target": "com.amazonaws.m2#Timestamp", "traits": { "smithy.api#documentation": "

The timestamp when the batch job execution started.

", "smithy.api#required": {} } }, "endTime": { "target": "com.amazonaws.m2#Timestamp", "traits": { "smithy.api#documentation": "

The timestamp when the batch job execution ended.

" } }, "statusReason": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The reason for the reported status.

" } }, "returnCode": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The batch job return code from either the Blu Age or Micro Focus runtime engines. For more\n information, see Batch return\n codes in the IBM WebSphere Application Server\n documentation.

" } }, "batchJobIdentifier": { "target": "com.amazonaws.m2#BatchJobIdentifier", "traits": { "smithy.api#documentation": "

The unique identifier of this batch job.

" } }, "jobStepRestartMarker": { "target": "com.amazonaws.m2#JobStepRestartMarker", "traits": { "smithy.api#documentation": "

The step/procedure step information for the restart batch job operation.

" } } } }, "com.amazonaws.m2#GetDataSetDetails": { "type": "operation", "input": { "target": "com.amazonaws.m2#GetDataSetDetailsRequest" }, "output": { "target": "com.amazonaws.m2#GetDataSetDetailsResponse" }, "errors": [ { "target": "com.amazonaws.m2#AccessDeniedException" }, { "target": "com.amazonaws.m2#ConflictException" }, { "target": "com.amazonaws.m2#ExecutionTimeoutException" }, { "target": "com.amazonaws.m2#InternalServerException" }, { "target": "com.amazonaws.m2#ResourceNotFoundException" }, { "target": "com.amazonaws.m2#ServiceUnavailableException" }, { "target": "com.amazonaws.m2#ThrottlingException" }, { "target": "com.amazonaws.m2#ValidationException" } ], "traits": { "aws.api#controlPlane": {}, "smithy.api#documentation": "

Gets the details of a specific data set.

", "smithy.api#http": { "method": "GET", "uri": "/applications/{applicationId}/datasets/{dataSetName}", "code": 200 }, "smithy.api#readonly": {} } }, "com.amazonaws.m2#GetDataSetDetailsRequest": { "type": "structure", "members": { "applicationId": { "target": "com.amazonaws.m2#Identifier", "traits": { "smithy.api#documentation": "

The unique identifier of the application that this data set is associated with.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "dataSetName": { "target": "com.amazonaws.m2#String200", "traits": { "smithy.api#documentation": "

The name of the data set.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.m2#GetDataSetDetailsResponse": { "type": "structure", "members": { "dataSetName": { "target": "com.amazonaws.m2#String200", "traits": { "smithy.api#documentation": "

The name of the data set.

", "smithy.api#required": {} } }, "dataSetOrg": { "target": "com.amazonaws.m2#DatasetDetailOrgAttributes", "traits": { "smithy.api#documentation": "

The type of data set. The only supported value is VSAM.

" } }, "recordLength": { "target": "com.amazonaws.m2#Integer", "traits": { "smithy.api#default": null, "smithy.api#documentation": "

The length of records in the data set.

" } }, "location": { "target": "com.amazonaws.m2#String2000", "traits": { "smithy.api#documentation": "

The location where the data set is stored.

" } }, "blocksize": { "target": "com.amazonaws.m2#Integer", "traits": { "smithy.api#default": null, "smithy.api#documentation": "

The size of the block on disk.

" } }, "creationTime": { "target": "com.amazonaws.m2#Timestamp", "traits": { "smithy.api#documentation": "

The timestamp when the data set was created.

" } }, "lastUpdatedTime": { "target": "com.amazonaws.m2#Timestamp", "traits": { "smithy.api#documentation": "

The last time the data set was updated.

" } }, "lastReferencedTime": { "target": "com.amazonaws.m2#Timestamp", "traits": { "smithy.api#documentation": "

The last time the data set was referenced.

" } }, "fileSize": { "target": "smithy.api#Long", "traits": { "smithy.api#default": null, "smithy.api#documentation": "

File size of the dataset.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.m2#GetDataSetExportTask": { "type": "operation", "input": { "target": "com.amazonaws.m2#GetDataSetExportTaskRequest" }, "output": { "target": "com.amazonaws.m2#GetDataSetExportTaskResponse" }, "errors": [ { "target": "com.amazonaws.m2#AccessDeniedException" }, { "target": "com.amazonaws.m2#InternalServerException" }, { "target": "com.amazonaws.m2#ResourceNotFoundException" }, { "target": "com.amazonaws.m2#ThrottlingException" }, { "target": "com.amazonaws.m2#ValidationException" } ], "traits": { "aws.api#controlPlane": {}, "aws.iam#iamAction": { "documentation": "Grants permission to export a data set at the specified S3 location" }, "smithy.api#documentation": "

Gets the status of a data set import task initiated with the CreateDataSetExportTask operation.

", "smithy.api#http": { "method": "GET", "uri": "/applications/{applicationId}/dataset-export-tasks/{taskId}", "code": 200 }, "smithy.api#readonly": {} } }, "com.amazonaws.m2#GetDataSetExportTaskRequest": { "type": "structure", "members": { "applicationId": { "target": "com.amazonaws.m2#Identifier", "traits": { "smithy.api#documentation": "

The application identifier.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "taskId": { "target": "com.amazonaws.m2#Identifier", "traits": { "smithy.api#documentation": "

The task identifier returned by the CreateDataSetExportTask operation.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.m2#GetDataSetExportTaskResponse": { "type": "structure", "members": { "taskId": { "target": "com.amazonaws.m2#Identifier", "traits": { "smithy.api#documentation": "

The task identifier.

", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.m2#DataSetTaskLifecycle", "traits": { "smithy.api#documentation": "

The status of the task.

", "smithy.api#required": {} } }, "summary": { "target": "com.amazonaws.m2#DataSetExportSummary", "traits": { "smithy.api#documentation": "

A summary of the status of the task.

" } }, "statusReason": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

If dataset export failed, the failure reason will show here.

" } }, "kmsKeyArn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The identifier of a customer managed key used for exported data set encryption.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.m2#GetDataSetImportTask": { "type": "operation", "input": { "target": "com.amazonaws.m2#GetDataSetImportTaskRequest" }, "output": { "target": "com.amazonaws.m2#GetDataSetImportTaskResponse" }, "errors": [ { "target": "com.amazonaws.m2#AccessDeniedException" }, { "target": "com.amazonaws.m2#InternalServerException" }, { "target": "com.amazonaws.m2#ResourceNotFoundException" }, { "target": "com.amazonaws.m2#ThrottlingException" }, { "target": "com.amazonaws.m2#ValidationException" } ], "traits": { "aws.api#controlPlane": {}, "smithy.api#documentation": "

Gets the status of a data set import task initiated with the CreateDataSetImportTask operation.

", "smithy.api#http": { "method": "GET", "uri": "/applications/{applicationId}/dataset-import-tasks/{taskId}", "code": 200 }, "smithy.api#readonly": {} } }, "com.amazonaws.m2#GetDataSetImportTaskRequest": { "type": "structure", "members": { "applicationId": { "target": "com.amazonaws.m2#Identifier", "traits": { "smithy.api#documentation": "

The application identifier.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "taskId": { "target": "com.amazonaws.m2#Identifier", "traits": { "smithy.api#documentation": "

The task identifier returned by the CreateDataSetImportTask operation.\n

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.m2#GetDataSetImportTaskResponse": { "type": "structure", "members": { "taskId": { "target": "com.amazonaws.m2#Identifier", "traits": { "smithy.api#documentation": "

The task identifier.

", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.m2#DataSetTaskLifecycle", "traits": { "smithy.api#documentation": "

The status of the task.

", "smithy.api#required": {} } }, "summary": { "target": "com.amazonaws.m2#DataSetImportSummary", "traits": { "smithy.api#documentation": "

A summary of the status of the task.

" } } } }, "com.amazonaws.m2#GetDeployment": { "type": "operation", "input": { "target": "com.amazonaws.m2#GetDeploymentRequest" }, "output": { "target": "com.amazonaws.m2#GetDeploymentResponse" }, "errors": [ { "target": "com.amazonaws.m2#AccessDeniedException" }, { "target": "com.amazonaws.m2#InternalServerException" }, { "target": "com.amazonaws.m2#ResourceNotFoundException" }, { "target": "com.amazonaws.m2#ThrottlingException" }, { "target": "com.amazonaws.m2#ValidationException" } ], "traits": { "aws.api#controlPlane": {}, "smithy.api#documentation": "

Gets details of a specific deployment with a given deployment identifier.

", "smithy.api#http": { "method": "GET", "uri": "/applications/{applicationId}/deployments/{deploymentId}", "code": 200 }, "smithy.api#readonly": {} } }, "com.amazonaws.m2#GetDeploymentRequest": { "type": "structure", "members": { "deploymentId": { "target": "com.amazonaws.m2#Identifier", "traits": { "smithy.api#documentation": "

The unique identifier for the deployment.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "applicationId": { "target": "com.amazonaws.m2#Identifier", "traits": { "smithy.api#documentation": "

The unique identifier of the application.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.m2#GetDeploymentResponse": { "type": "structure", "members": { "deploymentId": { "target": "com.amazonaws.m2#Identifier", "traits": { "smithy.api#documentation": "

The unique identifier of the deployment.

", "smithy.api#required": {} } }, "applicationId": { "target": "com.amazonaws.m2#Identifier", "traits": { "smithy.api#documentation": "

The unique identifier of the application.

", "smithy.api#required": {} } }, "environmentId": { "target": "com.amazonaws.m2#Identifier", "traits": { "smithy.api#documentation": "

The unique identifier of the runtime environment.

", "smithy.api#required": {} } }, "applicationVersion": { "target": "com.amazonaws.m2#Version", "traits": { "smithy.api#documentation": "

The application version.

", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.m2#DeploymentLifecycle", "traits": { "smithy.api#documentation": "

The status of the deployment.

", "smithy.api#required": {} } }, "creationTime": { "target": "com.amazonaws.m2#Timestamp", "traits": { "smithy.api#documentation": "

The timestamp when the deployment was created.

", "smithy.api#required": {} } }, "statusReason": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The reason for the reported status.

" } } } }, "com.amazonaws.m2#GetEnvironment": { "type": "operation", "input": { "target": "com.amazonaws.m2#GetEnvironmentRequest" }, "output": { "target": "com.amazonaws.m2#GetEnvironmentResponse" }, "errors": [ { "target": "com.amazonaws.m2#AccessDeniedException" }, { "target": "com.amazonaws.m2#InternalServerException" }, { "target": "com.amazonaws.m2#ResourceNotFoundException" }, { "target": "com.amazonaws.m2#ThrottlingException" }, { "target": "com.amazonaws.m2#ValidationException" } ], "traits": { "aws.api#controlPlane": {}, "smithy.api#documentation": "

Describes a specific runtime environment.

", "smithy.api#http": { "method": "GET", "uri": "/environments/{environmentId}", "code": 200 }, "smithy.api#readonly": {} } }, "com.amazonaws.m2#GetEnvironmentRequest": { "type": "structure", "members": { "environmentId": { "target": "com.amazonaws.m2#Identifier", "traits": { "smithy.api#documentation": "

The unique identifier of the runtime environment.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.m2#GetEnvironmentResponse": { "type": "structure", "members": { "name": { "target": "com.amazonaws.m2#EntityName", "traits": { "smithy.api#documentation": "

The name of the runtime environment. Must be unique within the account.

", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.m2#EntityDescription", "traits": { "smithy.api#documentation": "

The description of the runtime environment.

" } }, "environmentArn": { "target": "com.amazonaws.m2#Arn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the runtime environment.

", "smithy.api#required": {} } }, "environmentId": { "target": "com.amazonaws.m2#Identifier", "traits": { "smithy.api#documentation": "

The unique identifier of the runtime environment.

", "smithy.api#required": {} } }, "instanceType": { "target": "com.amazonaws.m2#String20", "traits": { "smithy.api#documentation": "

The type of instance underlying the runtime environment.

", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.m2#EnvironmentLifecycle", "traits": { "smithy.api#documentation": "

The status of the runtime environment. If the Amazon Web Services Mainframe Modernization environment is missing a connection to\n the customer owned dependent resource, the status will be Unhealthy.

", "smithy.api#required": {} } }, "engineType": { "target": "com.amazonaws.m2#EngineType", "traits": { "smithy.api#documentation": "

The target platform for the runtime environment.

", "smithy.api#required": {} } }, "engineVersion": { "target": "com.amazonaws.m2#EngineVersion", "traits": { "smithy.api#documentation": "

The version of the runtime engine.

", "smithy.api#required": {} } }, "vpcId": { "target": "com.amazonaws.m2#String50", "traits": { "smithy.api#documentation": "

The unique identifier for the VPC used with this runtime environment.

", "smithy.api#required": {} } }, "subnetIds": { "target": "com.amazonaws.m2#String50List", "traits": { "smithy.api#documentation": "

The unique identifiers of the subnets assigned to this runtime environment.

", "smithy.api#required": {} } }, "securityGroupIds": { "target": "com.amazonaws.m2#String50List", "traits": { "smithy.api#documentation": "

The unique identifiers of the security groups assigned to this runtime\n environment.

", "smithy.api#required": {} } }, "creationTime": { "target": "com.amazonaws.m2#Timestamp", "traits": { "smithy.api#documentation": "

The timestamp when the runtime environment was created.

", "smithy.api#required": {} } }, "storageConfigurations": { "target": "com.amazonaws.m2#StorageConfigurationList", "traits": { "smithy.api#documentation": "

The storage configurations defined for the runtime environment.

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

The tags defined for this runtime environment.

" } }, "highAvailabilityConfig": { "target": "com.amazonaws.m2#HighAvailabilityConfig", "traits": { "smithy.api#documentation": "

The desired capacity of the high availability configuration for the runtime\n environment.

" } }, "publiclyAccessible": { "target": "com.amazonaws.m2#Boolean", "traits": { "smithy.api#default": false, "smithy.api#documentation": "

Whether applications running in this runtime environment are publicly accessible.\n

" } }, "actualCapacity": { "target": "com.amazonaws.m2#CapacityValue", "traits": { "smithy.api#documentation": "

The number of instances included in the runtime environment. A standalone runtime\n environment has a maximum of one instance. Currently, a high availability runtime\n environment has a maximum of two instances.

" } }, "loadBalancerArn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the load balancer used with the runtime\n environment.

" } }, "statusReason": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The reason for the reported status.

" } }, "preferredMaintenanceWindow": { "target": "com.amazonaws.m2#String50", "traits": { "smithy.api#documentation": "

The maintenance window for the runtime environment. If you don't\n provide a value for the maintenance window, the service assigns a random value.

" } }, "pendingMaintenance": { "target": "com.amazonaws.m2#PendingMaintenance", "traits": { "smithy.api#documentation": "

Indicates the pending maintenance scheduled on this environment.

" } }, "kmsKeyId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The identifier of a customer managed key.

" } }, "networkType": { "target": "com.amazonaws.m2#NetworkType", "traits": { "smithy.api#documentation": "

The network type supported by the runtime environment.

" } } } }, "com.amazonaws.m2#GetSignedBluinsightsUrl": { "type": "operation", "input": { "target": "smithy.api#Unit" }, "output": { "target": "com.amazonaws.m2#GetSignedBluinsightsUrlResponse" }, "errors": [ { "target": "com.amazonaws.m2#AccessDeniedException" }, { "target": "com.amazonaws.m2#InternalServerException" }, { "target": "com.amazonaws.m2#ThrottlingException" } ], "traits": { "aws.api#controlPlane": {}, "aws.iam#actionPermissionDescription": "Grants permission to create a signed Bluinsights url", "smithy.api#documentation": "

Gets a single sign-on URL that can be used to connect to AWS Blu Insights.

", "smithy.api#http": { "method": "GET", "uri": "/signed-bi-url", "code": 200 }, "smithy.api#readonly": {} } }, "com.amazonaws.m2#GetSignedBluinsightsUrlResponse": { "type": "structure", "members": { "signedBiUrl": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

Single sign-on AWS Blu Insights URL.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.m2#HighAvailabilityConfig": { "type": "structure", "members": { "desiredCapacity": { "target": "com.amazonaws.m2#CapacityValue", "traits": { "smithy.api#documentation": "

The number of instances in a high availability configuration. The minimum possible value is 1 and the maximum is 100.

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

Defines the details of a high availability configuration.

" } }, "com.amazonaws.m2#Identifier": { "type": "string", "traits": { "smithy.api#pattern": "^\\S{1,80}$" } }, "com.amazonaws.m2#IdentifierList": { "type": "list", "member": { "target": "com.amazonaws.m2#Identifier" }, "traits": { "smithy.api#length": { "min": 1, "max": 10 } } }, "com.amazonaws.m2#Integer": { "type": "integer", "traits": { "smithy.api#default": 0 } }, "com.amazonaws.m2#InternalServerException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } }, "retryAfterSeconds": { "target": "com.amazonaws.m2#Integer", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "

The number of seconds to wait before retrying the request.

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

An unexpected error occurred during the processing of the request.

", "smithy.api#error": "server", "smithy.api#httpError": 500, "smithy.api#retryable": {} } }, "com.amazonaws.m2#JobIdentifier": { "type": "union", "members": { "fileName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The name of the file that contains the batch job definition.

" } }, "scriptName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The name of the script that contains the batch job definition.

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

Identifies a specific batch job.

" } }, "com.amazonaws.m2#JobStep": { "type": "structure", "members": { "stepNumber": { "target": "com.amazonaws.m2#Integer", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "

The number of a step.

" } }, "stepName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The name of a step.

" } }, "procStepNumber": { "target": "com.amazonaws.m2#Integer", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "

The number of a procedure step.

" } }, "procStepName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The name of a procedure step.

" } }, "stepCondCode": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The condition code of a step.

" } }, "stepRestartable": { "target": "com.amazonaws.m2#Boolean", "traits": { "smithy.api#default": false, "smithy.api#documentation": "

Specifies if a step can be restarted or not.

" } }, "stepCheckpoint": { "target": "com.amazonaws.m2#Integer", "traits": { "smithy.api#default": null, "smithy.api#documentation": "

A registered step-level checkpoint identifier that can be used for restarting an Amazon Web Services Blu Age application batch job.

" } }, "stepCheckpointStatus": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The step-level checkpoint status for an Amazon Web Services Blu Age application batch job.

" } }, "stepCheckpointTime": { "target": "com.amazonaws.m2#Timestamp", "traits": { "smithy.api#documentation": "

The step-level checkpoint status for an Amazon Web Services Blu Age application batch job.

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

Provides information related to a job step.

" } }, "com.amazonaws.m2#JobStepRestartMarker": { "type": "structure", "members": { "fromStep": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The step name that a batch job was restarted from.

", "smithy.api#required": {} } }, "fromProcStep": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The procedure step name that a batch job was restarted from.

" } }, "toStep": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The step name that a batch job was restarted to.

" } }, "toProcStep": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The procedure step name that a batch job was restarted to.

" } }, "stepCheckpoint": { "target": "com.amazonaws.m2#Integer", "traits": { "smithy.api#default": null, "smithy.api#documentation": "

Skip selected step and issue a restart from immediate successor step for an Amazon Web Services Blu Age application batch job.

" } }, "skip": { "target": "com.amazonaws.m2#Boolean", "traits": { "smithy.api#default": null, "smithy.api#documentation": "

The step-level checkpoint timestamp (creation or last modification) for an Amazon Web Services Blu Age application batch job.

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

Provides step/procedure step information for a restart batch job operation.

" } }, "com.amazonaws.m2#KMSKeyId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 }, "smithy.api#pattern": "^[a-zA-Z0-9:/_-]+$" } }, "com.amazonaws.m2#ListApplicationVersions": { "type": "operation", "input": { "target": "com.amazonaws.m2#ListApplicationVersionsRequest" }, "output": { "target": "com.amazonaws.m2#ListApplicationVersionsResponse" }, "errors": [ { "target": "com.amazonaws.m2#AccessDeniedException" }, { "target": "com.amazonaws.m2#InternalServerException" }, { "target": "com.amazonaws.m2#ResourceNotFoundException" }, { "target": "com.amazonaws.m2#ThrottlingException" }, { "target": "com.amazonaws.m2#ValidationException" } ], "traits": { "aws.api#controlPlane": {}, "smithy.api#documentation": "

Returns a list of the application versions for a specific application.

", "smithy.api#http": { "method": "GET", "uri": "/applications/{applicationId}/versions", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "applicationVersions" }, "smithy.api#readonly": {} } }, "com.amazonaws.m2#ListApplicationVersionsRequest": { "type": "structure", "members": { "nextToken": { "target": "com.amazonaws.m2#NextToken", "traits": { "smithy.api#documentation": "

A pagination token returned from a previous call to\n this operation. This specifies the next item to return. To return to the beginning of the \n list, exclude this parameter.

", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.m2#MaxResults", "traits": { "smithy.api#default": null, "smithy.api#documentation": "

The maximum number of application versions to return.

", "smithy.api#httpQuery": "maxResults" } }, "applicationId": { "target": "com.amazonaws.m2#Identifier", "traits": { "smithy.api#documentation": "

The unique identifier of the application.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.m2#ListApplicationVersionsResponse": { "type": "structure", "members": { "applicationVersions": { "target": "com.amazonaws.m2#ApplicationVersionSummaryList", "traits": { "smithy.api#documentation": "

The list of application versions.

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

If there are more items to return, this contains a token \n that is passed to a subsequent call to this operation to retrieve the next set of items.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.m2#ListApplications": { "type": "operation", "input": { "target": "com.amazonaws.m2#ListApplicationsRequest" }, "output": { "target": "com.amazonaws.m2#ListApplicationsResponse" }, "errors": [ { "target": "com.amazonaws.m2#AccessDeniedException" }, { "target": "com.amazonaws.m2#InternalServerException" }, { "target": "com.amazonaws.m2#ThrottlingException" }, { "target": "com.amazonaws.m2#ValidationException" } ], "traits": { "aws.api#controlPlane": {}, "smithy.api#documentation": "

Lists the applications associated with a specific Amazon Web Services account. You can provide the\n unique identifier of a specific runtime environment in a query parameter to see all\n applications associated with that environment.

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

A pagination token to control the number of applications displayed in the list.

", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.m2#MaxResults", "traits": { "smithy.api#default": null, "smithy.api#documentation": "

The maximum number of applications to return.

", "smithy.api#httpQuery": "maxResults" } }, "names": { "target": "com.amazonaws.m2#EntityNameList", "traits": { "smithy.api#documentation": "

The names of the applications.

", "smithy.api#httpQuery": "names" } }, "environmentId": { "target": "com.amazonaws.m2#Identifier", "traits": { "smithy.api#documentation": "

The unique identifier of the runtime environment where the applications are\n deployed.

", "smithy.api#httpQuery": "environmentId" } } }, "traits": { "smithy.api#input": {}, "smithy.api#references": [ { "resource": "com.amazonaws.m2#Environment" } ] } }, "com.amazonaws.m2#ListApplicationsResponse": { "type": "structure", "members": { "applications": { "target": "com.amazonaws.m2#ApplicationSummaryList", "traits": { "smithy.api#documentation": "

Returns a list of summary details for all the applications in a runtime\n environment.

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

A pagination token that's returned when the response doesn't contain all\n applications.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.m2#ListBatchJobDefinitions": { "type": "operation", "input": { "target": "com.amazonaws.m2#ListBatchJobDefinitionsRequest" }, "output": { "target": "com.amazonaws.m2#ListBatchJobDefinitionsResponse" }, "errors": [ { "target": "com.amazonaws.m2#AccessDeniedException" }, { "target": "com.amazonaws.m2#InternalServerException" }, { "target": "com.amazonaws.m2#ResourceNotFoundException" }, { "target": "com.amazonaws.m2#ThrottlingException" }, { "target": "com.amazonaws.m2#ValidationException" } ], "traits": { "aws.api#controlPlane": {}, "smithy.api#documentation": "

Lists all the available batch job definitions based on the batch job resources uploaded\n during the application creation. You can use the batch job definitions in the list to start\n a batch job.

", "smithy.api#http": { "method": "GET", "uri": "/applications/{applicationId}/batch-job-definitions", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "batchJobDefinitions" }, "smithy.api#readonly": {} } }, "com.amazonaws.m2#ListBatchJobDefinitionsRequest": { "type": "structure", "members": { "nextToken": { "target": "com.amazonaws.m2#NextToken", "traits": { "smithy.api#documentation": "

A pagination token returned from a previous call to\n this operation. This specifies the next item to return. To return to the beginning of the \n list, exclude this parameter.

", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.m2#MaxResults", "traits": { "smithy.api#default": null, "smithy.api#documentation": "

The maximum number of batch job definitions to return.

", "smithy.api#httpQuery": "maxResults" } }, "applicationId": { "target": "com.amazonaws.m2#Identifier", "traits": { "smithy.api#documentation": "

The identifier of the application.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "prefix": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

If the batch job definition is a FileBatchJobDefinition, the prefix allows you to search\n on the file names of FileBatchJobDefinitions.

", "smithy.api#httpQuery": "prefix" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.m2#ListBatchJobDefinitionsResponse": { "type": "structure", "members": { "batchJobDefinitions": { "target": "com.amazonaws.m2#BatchJobDefinitions", "traits": { "smithy.api#documentation": "

The list of batch job definitions.

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

If there are more items to return, this contains a token \n that is passed to a subsequent call to this operation to retrieve the next set of items.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.m2#ListBatchJobExecutions": { "type": "operation", "input": { "target": "com.amazonaws.m2#ListBatchJobExecutionsRequest" }, "output": { "target": "com.amazonaws.m2#ListBatchJobExecutionsResponse" }, "errors": [ { "target": "com.amazonaws.m2#AccessDeniedException" }, { "target": "com.amazonaws.m2#InternalServerException" }, { "target": "com.amazonaws.m2#ResourceNotFoundException" }, { "target": "com.amazonaws.m2#ThrottlingException" }, { "target": "com.amazonaws.m2#ValidationException" } ], "traits": { "aws.api#controlPlane": {}, "smithy.api#documentation": "

Lists historical, current, and scheduled batch job executions for a specific\n application.

", "smithy.api#http": { "method": "GET", "uri": "/applications/{applicationId}/batch-job-executions", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "batchJobExecutions" }, "smithy.api#readonly": {} } }, "com.amazonaws.m2#ListBatchJobExecutionsRequest": { "type": "structure", "members": { "nextToken": { "target": "com.amazonaws.m2#NextToken", "traits": { "smithy.api#documentation": "

A pagination token to control the number of batch job executions displayed in the\n list.

", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.m2#MaxResults", "traits": { "smithy.api#default": null, "smithy.api#documentation": "

The maximum number of batch job executions to return.

", "smithy.api#httpQuery": "maxResults" } }, "applicationId": { "target": "com.amazonaws.m2#Identifier", "traits": { "smithy.api#documentation": "

The unique identifier of the application.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "executionIds": { "target": "com.amazonaws.m2#IdentifierList", "traits": { "smithy.api#documentation": "

The unique identifier of each batch job execution.

", "smithy.api#httpQuery": "executionIds" } }, "jobName": { "target": "com.amazonaws.m2#String100", "traits": { "smithy.api#documentation": "

The name of each batch job execution.

", "smithy.api#httpQuery": "jobName" } }, "status": { "target": "com.amazonaws.m2#BatchJobExecutionStatus", "traits": { "smithy.api#documentation": "

The status of the batch job executions.

", "smithy.api#httpQuery": "status" } }, "startedAfter": { "target": "com.amazonaws.m2#Timestamp", "traits": { "smithy.api#documentation": "

The time after which the batch job executions started.

", "smithy.api#httpQuery": "startedAfter" } }, "startedBefore": { "target": "com.amazonaws.m2#Timestamp", "traits": { "smithy.api#documentation": "

The time before the batch job executions started.

", "smithy.api#httpQuery": "startedBefore" } } } }, "com.amazonaws.m2#ListBatchJobExecutionsResponse": { "type": "structure", "members": { "batchJobExecutions": { "target": "com.amazonaws.m2#BatchJobExecutionSummaryList", "traits": { "smithy.api#documentation": "

Returns a list of batch job executions for an application.

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

A pagination token that's returned when the response doesn't contain all batch job\n executions.

" } } } }, "com.amazonaws.m2#ListBatchJobRestartPoints": { "type": "operation", "input": { "target": "com.amazonaws.m2#ListBatchJobRestartPointsRequest" }, "output": { "target": "com.amazonaws.m2#ListBatchJobRestartPointsResponse" }, "errors": [ { "target": "com.amazonaws.m2#AccessDeniedException" }, { "target": "com.amazonaws.m2#ConflictException" }, { "target": "com.amazonaws.m2#InternalServerException" }, { "target": "com.amazonaws.m2#ResourceNotFoundException" }, { "target": "com.amazonaws.m2#ThrottlingException" }, { "target": "com.amazonaws.m2#ValidationException" } ], "traits": { "aws.api#controlPlane": {}, "smithy.api#documentation": "

Lists all the job steps for a JCL file to restart a batch job. This is only applicable for Micro Focus engine with versions 8.0.6 and above.

", "smithy.api#http": { "method": "GET", "uri": "/applications/{applicationId}/batch-job-executions/{executionId}/steps", "code": 200 }, "smithy.api#readonly": {} } }, "com.amazonaws.m2#ListBatchJobRestartPointsRequest": { "type": "structure", "members": { "applicationId": { "target": "com.amazonaws.m2#Identifier", "traits": { "smithy.api#documentation": "

The unique identifier of the application.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "executionId": { "target": "com.amazonaws.m2#Identifier", "traits": { "smithy.api#documentation": "

The unique identifier of the batch job execution.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "authSecretsManagerArn": { "target": "com.amazonaws.m2#AuthSecretsManagerArn", "traits": { "smithy.api#documentation": "

The Amazon Web Services Secrets Manager containing user's credentials for authentication and authorization for List Batch Job Restart Points operation.

", "smithy.api#httpQuery": "authSecretsManagerArn" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.m2#ListBatchJobRestartPointsResponse": { "type": "structure", "members": { "batchJobSteps": { "target": "com.amazonaws.m2#BatchJobStepList", "traits": { "smithy.api#documentation": "

Returns all the batch job steps and related information for a batch job that previously ran.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.m2#ListDataSetExportHistory": { "type": "operation", "input": { "target": "com.amazonaws.m2#ListDataSetExportHistoryRequest" }, "output": { "target": "com.amazonaws.m2#ListDataSetExportHistoryResponse" }, "errors": [ { "target": "com.amazonaws.m2#AccessDeniedException" }, { "target": "com.amazonaws.m2#InternalServerException" }, { "target": "com.amazonaws.m2#ResourceNotFoundException" }, { "target": "com.amazonaws.m2#ThrottlingException" }, { "target": "com.amazonaws.m2#ValidationException" } ], "traits": { "aws.api#controlPlane": {}, "aws.iam#iamAction": { "documentation": "Grants permission to list data set export history" }, "smithy.api#documentation": "

Lists the data set exports for the specified application.

", "smithy.api#http": { "method": "GET", "uri": "/applications/{applicationId}/dataset-export-tasks", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "dataSetExportTasks" }, "smithy.api#readonly": {} } }, "com.amazonaws.m2#ListDataSetExportHistoryRequest": { "type": "structure", "members": { "nextToken": { "target": "com.amazonaws.m2#NextToken", "traits": { "smithy.api#documentation": "

A pagination token returned from a previous call to\n this operation. This specifies the next item to return. To return to the beginning of the \n list, exclude this parameter.

", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.m2#MaxResults", "traits": { "smithy.api#default": null, "smithy.api#documentation": "

The maximum number of objects to return.

", "smithy.api#httpQuery": "maxResults" } }, "applicationId": { "target": "com.amazonaws.m2#Identifier", "traits": { "smithy.api#documentation": "

The unique identifier of the application.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.m2#ListDataSetExportHistoryResponse": { "type": "structure", "members": { "dataSetExportTasks": { "target": "com.amazonaws.m2#DataSetExportTaskList", "traits": { "smithy.api#documentation": "

The data set export tasks.

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

If there are more items to return, this contains a token \n that is passed to a subsequent call to this operation to retrieve the next set of items.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.m2#ListDataSetImportHistory": { "type": "operation", "input": { "target": "com.amazonaws.m2#ListDataSetImportHistoryRequest" }, "output": { "target": "com.amazonaws.m2#ListDataSetImportHistoryResponse" }, "errors": [ { "target": "com.amazonaws.m2#AccessDeniedException" }, { "target": "com.amazonaws.m2#InternalServerException" }, { "target": "com.amazonaws.m2#ResourceNotFoundException" }, { "target": "com.amazonaws.m2#ThrottlingException" }, { "target": "com.amazonaws.m2#ValidationException" } ], "traits": { "aws.api#controlPlane": {}, "smithy.api#documentation": "

Lists the data set imports for the specified application.

", "smithy.api#http": { "method": "GET", "uri": "/applications/{applicationId}/dataset-import-tasks", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "dataSetImportTasks" }, "smithy.api#readonly": {} } }, "com.amazonaws.m2#ListDataSetImportHistoryRequest": { "type": "structure", "members": { "nextToken": { "target": "com.amazonaws.m2#NextToken", "traits": { "smithy.api#documentation": "

A pagination token returned from a previous call to\n this operation. This specifies the next item to return. To return to the beginning of the \n list, exclude this parameter.

", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.m2#MaxResults", "traits": { "smithy.api#default": null, "smithy.api#documentation": "

The maximum number of objects to return.

", "smithy.api#httpQuery": "maxResults" } }, "applicationId": { "target": "com.amazonaws.m2#Identifier", "traits": { "smithy.api#documentation": "

The unique identifier of the application.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.m2#ListDataSetImportHistoryResponse": { "type": "structure", "members": { "dataSetImportTasks": { "target": "com.amazonaws.m2#DataSetImportTaskList", "traits": { "smithy.api#documentation": "

The data set import tasks.

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

If there are more items to return, this contains a token \n that is passed to a subsequent call to this operation to retrieve the next set of items.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.m2#ListDataSets": { "type": "operation", "input": { "target": "com.amazonaws.m2#ListDataSetsRequest" }, "output": { "target": "com.amazonaws.m2#ListDataSetsResponse" }, "errors": [ { "target": "com.amazonaws.m2#AccessDeniedException" }, { "target": "com.amazonaws.m2#ConflictException" }, { "target": "com.amazonaws.m2#ExecutionTimeoutException" }, { "target": "com.amazonaws.m2#InternalServerException" }, { "target": "com.amazonaws.m2#ResourceNotFoundException" }, { "target": "com.amazonaws.m2#ServiceUnavailableException" }, { "target": "com.amazonaws.m2#ThrottlingException" }, { "target": "com.amazonaws.m2#ValidationException" } ], "traits": { "aws.api#controlPlane": {}, "smithy.api#documentation": "

Lists the data sets imported for a specific application. In Amazon Web Services Mainframe Modernization, data sets are\n associated with applications deployed on runtime environments. This is known as importing\n data sets. Currently, Amazon Web Services Mainframe Modernization can import data sets into catalogs using CreateDataSetImportTask.

", "smithy.api#http": { "method": "GET", "uri": "/applications/{applicationId}/datasets", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "dataSets" }, "smithy.api#readonly": {} } }, "com.amazonaws.m2#ListDataSetsRequest": { "type": "structure", "members": { "applicationId": { "target": "com.amazonaws.m2#Identifier", "traits": { "smithy.api#documentation": "

The unique identifier of the application for which you want to list the associated data\n sets.

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

A pagination token returned from a previous call to\n this operation. This specifies the next item to return. To return to the beginning of the \n list, exclude this parameter.

", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.m2#MaxResults", "traits": { "smithy.api#default": null, "smithy.api#documentation": "

The maximum number of objects to return.

", "smithy.api#httpQuery": "maxResults" } }, "prefix": { "target": "com.amazonaws.m2#String200", "traits": { "smithy.api#documentation": "

The prefix of the data set name, which you can use to filter the list of data\n sets.

", "smithy.api#httpQuery": "prefix" } }, "nameFilter": { "target": "com.amazonaws.m2#String200", "traits": { "smithy.api#documentation": "

Filter dataset name matching the specified pattern. Can use * and % as wild cards.

", "smithy.api#httpQuery": "nameFilter" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.m2#ListDataSetsResponse": { "type": "structure", "members": { "dataSets": { "target": "com.amazonaws.m2#DataSetsSummaryList", "traits": { "smithy.api#documentation": "

The list of data sets, containing information including the creation time, the data set\n name, the data set organization, the data set format, and the last time the data set was\n referenced or updated.

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

If there are more items to return, this contains a token \n that is passed to a subsequent call to this operation to retrieve the next set of items.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.m2#ListDeployments": { "type": "operation", "input": { "target": "com.amazonaws.m2#ListDeploymentsRequest" }, "output": { "target": "com.amazonaws.m2#ListDeploymentsResponse" }, "errors": [ { "target": "com.amazonaws.m2#AccessDeniedException" }, { "target": "com.amazonaws.m2#InternalServerException" }, { "target": "com.amazonaws.m2#ResourceNotFoundException" }, { "target": "com.amazonaws.m2#ThrottlingException" }, { "target": "com.amazonaws.m2#ValidationException" } ], "traits": { "aws.api#controlPlane": {}, "smithy.api#documentation": "

Returns a list of all deployments of a specific application. A deployment is a\n combination of a specific application and a specific version of that application. Each\n deployment is mapped to a particular application version.

", "smithy.api#http": { "method": "GET", "uri": "/applications/{applicationId}/deployments", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "deployments" }, "smithy.api#readonly": {} } }, "com.amazonaws.m2#ListDeploymentsRequest": { "type": "structure", "members": { "nextToken": { "target": "com.amazonaws.m2#NextToken", "traits": { "smithy.api#documentation": "

A pagination token returned from a previous call to\n this operation. This specifies the next item to return. To return to the beginning of the \n list, exclude this parameter.

", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.m2#MaxResults", "traits": { "smithy.api#default": null, "smithy.api#documentation": "

The maximum number of objects to return.

", "smithy.api#httpQuery": "maxResults" } }, "applicationId": { "target": "com.amazonaws.m2#Identifier", "traits": { "smithy.api#documentation": "

The application identifier.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.m2#ListDeploymentsResponse": { "type": "structure", "members": { "deployments": { "target": "com.amazonaws.m2#DeploymentList", "traits": { "smithy.api#documentation": "

The list of deployments that is returned.

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

If there are more items to return, this contains a token \n that is passed to a subsequent call to this operation to retrieve the next set of items.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.m2#ListEngineVersions": { "type": "operation", "input": { "target": "com.amazonaws.m2#ListEngineVersionsRequest" }, "output": { "target": "com.amazonaws.m2#ListEngineVersionsResponse" }, "errors": [ { "target": "com.amazonaws.m2#AccessDeniedException" }, { "target": "com.amazonaws.m2#InternalServerException" }, { "target": "com.amazonaws.m2#ThrottlingException" }, { "target": "com.amazonaws.m2#ValidationException" } ], "traits": { "aws.api#controlPlane": {}, "smithy.api#documentation": "

Lists the available engine versions.

", "smithy.api#http": { "method": "GET", "uri": "/engine-versions", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "engineVersions" }, "smithy.api#readonly": {} } }, "com.amazonaws.m2#ListEngineVersionsRequest": { "type": "structure", "members": { "engineType": { "target": "com.amazonaws.m2#EngineType", "traits": { "smithy.api#documentation": "

The type of target platform.

", "smithy.api#httpQuery": "engineType" } }, "nextToken": { "target": "com.amazonaws.m2#NextToken", "traits": { "smithy.api#documentation": "

A pagination token returned from a previous call to\n this operation. This specifies the next item to return. To return to the beginning of the \n list, exclude this parameter.

", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.m2#MaxResults", "traits": { "smithy.api#default": null, "smithy.api#documentation": "

The maximum number of objects to return.

", "smithy.api#httpQuery": "maxResults" } } } }, "com.amazonaws.m2#ListEngineVersionsResponse": { "type": "structure", "members": { "engineVersions": { "target": "com.amazonaws.m2#EngineVersionsSummaryList", "traits": { "smithy.api#documentation": "

Returns the engine versions.

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

If there are more items to return, this contains a token \n that is passed to a subsequent call to this operation to retrieve the next set of items.

" } } } }, "com.amazonaws.m2#ListEnvironments": { "type": "operation", "input": { "target": "com.amazonaws.m2#ListEnvironmentsRequest" }, "output": { "target": "com.amazonaws.m2#ListEnvironmentsResponse" }, "errors": [ { "target": "com.amazonaws.m2#AccessDeniedException" }, { "target": "com.amazonaws.m2#InternalServerException" }, { "target": "com.amazonaws.m2#ThrottlingException" }, { "target": "com.amazonaws.m2#ValidationException" } ], "traits": { "aws.api#controlPlane": {}, "smithy.api#documentation": "

Lists the runtime environments.

", "smithy.api#http": { "method": "GET", "uri": "/environments", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "environments" }, "smithy.api#readonly": {} } }, "com.amazonaws.m2#ListEnvironmentsRequest": { "type": "structure", "members": { "nextToken": { "target": "com.amazonaws.m2#NextToken", "traits": { "smithy.api#documentation": "

A pagination token to control the number of runtime environments displayed in the\n list.

", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.m2#MaxResults", "traits": { "smithy.api#default": null, "smithy.api#documentation": "

The maximum number of runtime environments to return.

", "smithy.api#httpQuery": "maxResults" } }, "names": { "target": "com.amazonaws.m2#EntityNameList", "traits": { "smithy.api#documentation": "

The names of the runtime environments. Must be unique within the account.

", "smithy.api#httpQuery": "names" } }, "engineType": { "target": "com.amazonaws.m2#EngineType", "traits": { "smithy.api#documentation": "

The engine type for the runtime environment.

", "smithy.api#httpQuery": "engineType" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.m2#ListEnvironmentsResponse": { "type": "structure", "members": { "environments": { "target": "com.amazonaws.m2#EnvironmentSummaryList", "traits": { "smithy.api#documentation": "

Returns a list of summary details for all the runtime environments in your account.\n

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

A pagination token that's returned when the response doesn't contain all the runtime\n environments.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.m2#ListTagsForResource": { "type": "operation", "input": { "target": "com.amazonaws.m2#ListTagsForResourceRequest" }, "output": { "target": "com.amazonaws.m2#ListTagsForResourceResponse" }, "errors": [ { "target": "com.amazonaws.m2#AccessDeniedException" }, { "target": "com.amazonaws.m2#InternalServerException" }, { "target": "com.amazonaws.m2#ResourceNotFoundException" }, { "target": "com.amazonaws.m2#ThrottlingException" }, { "target": "com.amazonaws.m2#ValidationException" } ], "traits": { "aws.api#controlPlane": {}, "smithy.api#documentation": "

Lists the tags for the specified resource.

", "smithy.api#http": { "method": "GET", "uri": "/tags/{resourceArn}", "code": 200 } } }, "com.amazonaws.m2#ListTagsForResourceRequest": { "type": "structure", "members": { "resourceArn": { "target": "com.amazonaws.m2#Arn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

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

The tags for the resource.

", "smithy.api#required": {} } } } }, "com.amazonaws.m2#LogGroupIdentifier": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 512 } } }, "com.amazonaws.m2#LogGroupSummaries": { "type": "list", "member": { "target": "com.amazonaws.m2#LogGroupSummary" } }, "com.amazonaws.m2#LogGroupSummary": { "type": "structure", "members": { "logType": { "target": "com.amazonaws.m2#String20", "traits": { "smithy.api#documentation": "

The type of log.

", "smithy.api#required": {} } }, "logGroupName": { "target": "com.amazonaws.m2#LogGroupIdentifier", "traits": { "smithy.api#documentation": "

The name of the log group.

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

A subset of the attributes that describe a log group. In CloudWatch a log group is a group of\n log streams that share the same retention, monitoring, and access control settings.

" } }, "com.amazonaws.m2#MaintenanceSchedule": { "type": "structure", "members": { "startTime": { "target": "com.amazonaws.m2#Timestamp", "traits": { "smithy.api#documentation": "

The time the scheduled maintenance is to start.

" } }, "endTime": { "target": "com.amazonaws.m2#Timestamp", "traits": { "smithy.api#documentation": "

The time the scheduled maintenance is to end.

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

The information about the maintenance schedule.

" } }, "com.amazonaws.m2#MaxResults": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 2000 } } }, "com.amazonaws.m2#NetworkType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "ipv4", "name": "IPV4" }, { "value": "dual", "name": "DUAL" } ] } }, "com.amazonaws.m2#NextToken": { "type": "string", "traits": { "smithy.api#pattern": "^\\S{1,2000}$" } }, "com.amazonaws.m2#PendingMaintenance": { "type": "structure", "members": { "schedule": { "target": "com.amazonaws.m2#MaintenanceSchedule", "traits": { "smithy.api#documentation": "

The maintenance schedule for the runtime engine version.

" } }, "engineVersion": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The specific runtime engine that the maintenance schedule applies to.

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

The scheduled maintenance for a runtime engine.

" } }, "com.amazonaws.m2#PoAttributes": { "type": "structure", "members": { "format": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The format of the data set records.

", "smithy.api#required": {} } }, "encoding": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The character set encoding of the data set.

" } }, "memberFileExtensions": { "target": "com.amazonaws.m2#String20List", "traits": { "smithy.api#documentation": "

An array containing one or more filename extensions, allowing you to specify which files\n to be included as PDS member.

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

The supported properties for a PO type data set.

" } }, "com.amazonaws.m2#PoDetailAttributes": { "type": "structure", "members": { "format": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The format of the data set records.

", "smithy.api#required": {} } }, "encoding": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The character set encoding of the data set.

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

The supported properties for a PO type data set.

" } }, "com.amazonaws.m2#PortList": { "type": "list", "member": { "target": "com.amazonaws.m2#Integer" }, "traits": { "smithy.api#length": { "min": 1 } } }, "com.amazonaws.m2#PrimaryKey": { "type": "structure", "members": { "name": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

A name for the Primary Key.

" } }, "offset": { "target": "com.amazonaws.m2#Integer", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "

A positive integer value representing the offset to mark the start of the primary key in\n the record byte array.

", "smithy.api#required": {} } }, "length": { "target": "com.amazonaws.m2#Integer", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "

A strictly positive integer value representing the length of the primary key.

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

The primary key for a KSDS data set.

" } }, "com.amazonaws.m2#PsAttributes": { "type": "structure", "members": { "format": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The format of the data set records.

", "smithy.api#required": {} } }, "encoding": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The character set encoding of the data set.

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

The supported properties for a PS type data set.

" } }, "com.amazonaws.m2#PsDetailAttributes": { "type": "structure", "members": { "format": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The format of the data set records.

", "smithy.api#required": {} } }, "encoding": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The character set encoding of the data set.

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

The supported properties for a PS type data set.

" } }, "com.amazonaws.m2#RecordLength": { "type": "structure", "members": { "min": { "target": "com.amazonaws.m2#Integer", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "

The minimum record length of a record.

", "smithy.api#required": {} } }, "max": { "target": "com.amazonaws.m2#Integer", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "

The maximum record length. In case of fixed, both minimum and maximum are the\n same.

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

The length of the records in the data set.

" } }, "com.amazonaws.m2#ResourceNotFoundException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } }, "resourceId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The ID of the missing resource.

" } }, "resourceType": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The type of the missing resource.

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

The specified resource was not found.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.m2#RestartBatchJobIdentifier": { "type": "structure", "members": { "executionId": { "target": "com.amazonaws.m2#Identifier", "traits": { "smithy.api#documentation": "

The executionId from the StartBatchJob response when the job ran for the first time.

", "smithy.api#required": {} } }, "jobStepRestartMarker": { "target": "com.amazonaws.m2#JobStepRestartMarker", "traits": { "smithy.api#documentation": "

The step/procedure step information for a restart batch job operation.

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

An identifier for the StartBatchJob API to show that it is a restart operation.

" } }, "com.amazonaws.m2#S3BatchJobIdentifier": { "type": "structure", "members": { "bucket": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The Amazon S3 bucket that contains the batch job definitions.

", "smithy.api#required": {} } }, "keyPrefix": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The key prefix that specifies the path to the folder in the S3 bucket that has the batch job definitions.

" } }, "identifier": { "target": "com.amazonaws.m2#JobIdentifier", "traits": { "smithy.api#documentation": "

Identifies the batch job definition. This identifier can also point to any batch job definition that already exists in the application or to one of the batch job definitions within the directory that is specified in keyPrefix.

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

A batch job identifier in which the batch jobs to run are identified by an Amazon S3 location.

" } }, "com.amazonaws.m2#ScriptBatchJobDefinition": { "type": "structure", "members": { "scriptName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The name of the script containing the batch job definition.

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

A batch job definition contained in a script.

" } }, "com.amazonaws.m2#ScriptBatchJobIdentifier": { "type": "structure", "members": { "scriptName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The name of the script containing the batch job definition.

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

A batch job identifier in which the batch job to run is identified by the script\n name.

" } }, "com.amazonaws.m2#ServiceQuotaExceededException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } }, "resourceId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The ID of the resource that is exceeding the quota limit.

" } }, "resourceType": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The type of resource that is exceeding the quota limit for Amazon Web Services Mainframe Modernization.

" } }, "serviceCode": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

A code that identifies the service that the exceeded quota belongs to.

" } }, "quotaCode": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The identifier of the exceeded quota.

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

One or more quotas for Amazon Web Services Mainframe Modernization exceeds the limit.

", "smithy.api#error": "client", "smithy.api#httpError": 402 } }, "com.amazonaws.m2#ServiceUnavailableException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Server cannot process the request at the moment.

", "smithy.api#error": "server", "smithy.api#httpError": 503, "smithy.api#retryable": {} } }, "com.amazonaws.m2#StartApplication": { "type": "operation", "input": { "target": "com.amazonaws.m2#StartApplicationRequest" }, "output": { "target": "com.amazonaws.m2#StartApplicationResponse" }, "errors": [ { "target": "com.amazonaws.m2#AccessDeniedException" }, { "target": "com.amazonaws.m2#ConflictException" }, { "target": "com.amazonaws.m2#InternalServerException" }, { "target": "com.amazonaws.m2#ResourceNotFoundException" }, { "target": "com.amazonaws.m2#ThrottlingException" }, { "target": "com.amazonaws.m2#ValidationException" } ], "traits": { "aws.api#controlPlane": {}, "smithy.api#documentation": "

Starts an application that is currently stopped.

", "smithy.api#http": { "method": "POST", "uri": "/applications/{applicationId}/start", "code": 200 } } }, "com.amazonaws.m2#StartApplicationRequest": { "type": "structure", "members": { "applicationId": { "target": "com.amazonaws.m2#Identifier", "traits": { "smithy.api#documentation": "

The unique identifier of the application you want to start.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.m2#StartApplicationResponse": { "type": "structure", "members": {} }, "com.amazonaws.m2#StartBatchJob": { "type": "operation", "input": { "target": "com.amazonaws.m2#StartBatchJobRequest" }, "output": { "target": "com.amazonaws.m2#StartBatchJobResponse" }, "errors": [ { "target": "com.amazonaws.m2#AccessDeniedException" }, { "target": "com.amazonaws.m2#ConflictException" }, { "target": "com.amazonaws.m2#InternalServerException" }, { "target": "com.amazonaws.m2#ResourceNotFoundException" }, { "target": "com.amazonaws.m2#ThrottlingException" }, { "target": "com.amazonaws.m2#ValidationException" } ], "traits": { "aws.api#controlPlane": {}, "smithy.api#documentation": "

Starts a batch job and returns the unique identifier of this execution of the batch job.\n The associated application must be running in order to start the batch job.

", "smithy.api#http": { "method": "POST", "uri": "/applications/{applicationId}/batch-job", "code": 200 } } }, "com.amazonaws.m2#StartBatchJobRequest": { "type": "structure", "members": { "applicationId": { "target": "com.amazonaws.m2#Identifier", "traits": { "smithy.api#documentation": "

The unique identifier of the application associated with this batch job.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "batchJobIdentifier": { "target": "com.amazonaws.m2#BatchJobIdentifier", "traits": { "smithy.api#documentation": "

The unique identifier of the batch job.

", "smithy.api#required": {} } }, "jobParams": { "target": "com.amazonaws.m2#BatchJobParametersMap", "traits": { "smithy.api#documentation": "

The collection of batch job parameters. For details about limits for keys and values,\n see Coding variables in JCL.

" } }, "authSecretsManagerArn": { "target": "com.amazonaws.m2#AuthSecretsManagerArn", "traits": { "smithy.api#documentation": "

The Amazon Web Services Secrets Manager containing user's credentials for authentication and authorization for Start Batch Job execution operation.

" } } } }, "com.amazonaws.m2#StartBatchJobResponse": { "type": "structure", "members": { "executionId": { "target": "com.amazonaws.m2#Identifier", "traits": { "smithy.api#documentation": "

The unique identifier of this execution of the batch job.

", "smithy.api#required": {} } } } }, "com.amazonaws.m2#StopApplication": { "type": "operation", "input": { "target": "com.amazonaws.m2#StopApplicationRequest" }, "output": { "target": "com.amazonaws.m2#StopApplicationResponse" }, "errors": [ { "target": "com.amazonaws.m2#AccessDeniedException" }, { "target": "com.amazonaws.m2#ConflictException" }, { "target": "com.amazonaws.m2#InternalServerException" }, { "target": "com.amazonaws.m2#ResourceNotFoundException" }, { "target": "com.amazonaws.m2#ThrottlingException" }, { "target": "com.amazonaws.m2#ValidationException" } ], "traits": { "aws.api#controlPlane": {}, "smithy.api#documentation": "

Stops a running application.

", "smithy.api#http": { "method": "POST", "uri": "/applications/{applicationId}/stop", "code": 200 } } }, "com.amazonaws.m2#StopApplicationRequest": { "type": "structure", "members": { "applicationId": { "target": "com.amazonaws.m2#Identifier", "traits": { "smithy.api#documentation": "

The unique identifier of the application you want to stop.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "forceStop": { "target": "com.amazonaws.m2#Boolean", "traits": { "smithy.api#default": false, "smithy.api#documentation": "

Stopping an application process can take a long time. Setting this parameter to true\n lets you force stop the application so you don't need to wait until the process finishes to\n apply another action on the application. The default value is false.

" } } } }, "com.amazonaws.m2#StopApplicationResponse": { "type": "structure", "members": {} }, "com.amazonaws.m2#StorageConfiguration": { "type": "union", "members": { "efs": { "target": "com.amazonaws.m2#EfsStorageConfiguration", "traits": { "smithy.api#documentation": "

Defines the storage configuration for an Amazon EFS file system.

" } }, "fsx": { "target": "com.amazonaws.m2#FsxStorageConfiguration", "traits": { "smithy.api#documentation": "

Defines the storage configuration for an Amazon FSx file system.

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

Defines the storage configuration for a runtime environment.

" } }, "com.amazonaws.m2#StorageConfigurationList": { "type": "list", "member": { "target": "com.amazonaws.m2#StorageConfiguration" } }, "com.amazonaws.m2#String100": { "type": "string", "traits": { "smithy.api#pattern": "^\\S{1,100}$" } }, "com.amazonaws.m2#String20": { "type": "string", "traits": { "smithy.api#pattern": "^\\S{1,20}$" } }, "com.amazonaws.m2#String200": { "type": "string", "traits": { "smithy.api#pattern": "^\\S{1,200}$" } }, "com.amazonaws.m2#String2000": { "type": "string", "traits": { "smithy.api#pattern": "^\\S{1,2000}$" } }, "com.amazonaws.m2#String20List": { "type": "list", "member": { "target": "com.amazonaws.m2#String20" }, "traits": { "smithy.api#length": { "min": 1, "max": 10 } } }, "com.amazonaws.m2#String50": { "type": "string", "traits": { "smithy.api#pattern": "^\\S{1,50}$" } }, "com.amazonaws.m2#String50List": { "type": "list", "member": { "target": "com.amazonaws.m2#String50" } }, "com.amazonaws.m2#StringFree65000": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 65000 } } }, "com.amazonaws.m2#TagKey": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^(?!aws:).+$" } }, "com.amazonaws.m2#TagKeyList": { "type": "list", "member": { "target": "com.amazonaws.m2#TagKey" } }, "com.amazonaws.m2#TagMap": { "type": "map", "key": { "target": "com.amazonaws.m2#TagKey" }, "value": { "target": "com.amazonaws.m2#TagValue" }, "traits": { "smithy.api#length": { "min": 0, "max": 200 } } }, "com.amazonaws.m2#TagResource": { "type": "operation", "input": { "target": "com.amazonaws.m2#TagResourceRequest" }, "output": { "target": "com.amazonaws.m2#TagResourceResponse" }, "errors": [ { "target": "com.amazonaws.m2#AccessDeniedException" }, { "target": "com.amazonaws.m2#InternalServerException" }, { "target": "com.amazonaws.m2#ResourceNotFoundException" }, { "target": "com.amazonaws.m2#ServiceQuotaExceededException" }, { "target": "com.amazonaws.m2#ThrottlingException" }, { "target": "com.amazonaws.m2#ValidationException" } ], "traits": { "aws.api#controlPlane": {}, "aws.iam#conditionKeys": [ "aws:RequestTag/${TagKey}", "aws:TagKeys" ], "smithy.api#documentation": "

Adds one or more tags to the specified resource.

", "smithy.api#http": { "method": "POST", "uri": "/tags/{resourceArn}", "code": 200 } } }, "com.amazonaws.m2#TagResourceRequest": { "type": "structure", "members": { "resourceArn": { "target": "com.amazonaws.m2#Arn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

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

The tags to add to the resource.

", "smithy.api#required": {} } } } }, "com.amazonaws.m2#TagResourceResponse": { "type": "structure", "members": {} }, "com.amazonaws.m2#TagValue": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 } } }, "com.amazonaws.m2#ThrottlingException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } }, "serviceCode": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The identifier of the service that the throttled request was made to.

" } }, "quotaCode": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The identifier of the throttled request.

" } }, "retryAfterSeconds": { "target": "com.amazonaws.m2#Integer", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "

The number of seconds to wait before retrying the request.

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

The number of requests made exceeds the limit.

", "smithy.api#error": "client", "smithy.api#httpError": 429, "smithy.api#retryable": { "throttling": true } } }, "com.amazonaws.m2#Timestamp": { "type": "timestamp" }, "com.amazonaws.m2#UntagResource": { "type": "operation", "input": { "target": "com.amazonaws.m2#UntagResourceRequest" }, "output": { "target": "com.amazonaws.m2#UntagResourceResponse" }, "errors": [ { "target": "com.amazonaws.m2#AccessDeniedException" }, { "target": "com.amazonaws.m2#InternalServerException" }, { "target": "com.amazonaws.m2#ResourceNotFoundException" }, { "target": "com.amazonaws.m2#ThrottlingException" }, { "target": "com.amazonaws.m2#ValidationException" } ], "traits": { "aws.api#controlPlane": {}, "aws.iam#conditionKeys": [ "aws:TagKeys" ], "smithy.api#documentation": "

Removes one or more tags from the specified resource.

", "smithy.api#http": { "method": "DELETE", "uri": "/tags/{resourceArn}", "code": 200 } } }, "com.amazonaws.m2#UntagResourceRequest": { "type": "structure", "members": { "resourceArn": { "target": "com.amazonaws.m2#Arn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

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

The keys of the tags to remove.

", "smithy.api#httpQuery": "tagKeys", "smithy.api#required": {} } } } }, "com.amazonaws.m2#UntagResourceResponse": { "type": "structure", "members": {} }, "com.amazonaws.m2#UpdateApplication": { "type": "operation", "input": { "target": "com.amazonaws.m2#UpdateApplicationRequest" }, "output": { "target": "com.amazonaws.m2#UpdateApplicationResponse" }, "errors": [ { "target": "com.amazonaws.m2#AccessDeniedException" }, { "target": "com.amazonaws.m2#ConflictException" }, { "target": "com.amazonaws.m2#InternalServerException" }, { "target": "com.amazonaws.m2#ResourceNotFoundException" }, { "target": "com.amazonaws.m2#ThrottlingException" }, { "target": "com.amazonaws.m2#ValidationException" } ], "traits": { "aws.api#controlPlane": {}, "aws.iam#requiredActions": [ "s3:GetObject", "s3:ListBucket" ], "smithy.api#documentation": "

Updates an application and creates a new version.

", "smithy.api#http": { "method": "PATCH", "uri": "/applications/{applicationId}", "code": 200 } } }, "com.amazonaws.m2#UpdateApplicationRequest": { "type": "structure", "members": { "applicationId": { "target": "com.amazonaws.m2#Identifier", "traits": { "smithy.api#documentation": "

The unique identifier of the application you want to update.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.m2#EntityDescription", "traits": { "smithy.api#documentation": "

The description of the application to update.

" } }, "currentApplicationVersion": { "target": "com.amazonaws.m2#Version", "traits": { "smithy.api#documentation": "

The current version of the application to update.

", "smithy.api#required": {} } }, "definition": { "target": "com.amazonaws.m2#Definition", "traits": { "smithy.api#documentation": "

The application definition for this application. You can specify either inline JSON or\n an S3 bucket location.

" } } } }, "com.amazonaws.m2#UpdateApplicationResponse": { "type": "structure", "members": { "applicationVersion": { "target": "com.amazonaws.m2#Version", "traits": { "smithy.api#documentation": "

The new version of the application.

", "smithy.api#required": {} } } } }, "com.amazonaws.m2#UpdateEnvironment": { "type": "operation", "input": { "target": "com.amazonaws.m2#UpdateEnvironmentRequest" }, "output": { "target": "com.amazonaws.m2#UpdateEnvironmentResponse" }, "errors": [ { "target": "com.amazonaws.m2#AccessDeniedException" }, { "target": "com.amazonaws.m2#ConflictException" }, { "target": "com.amazonaws.m2#InternalServerException" }, { "target": "com.amazonaws.m2#ResourceNotFoundException" }, { "target": "com.amazonaws.m2#ServiceQuotaExceededException" }, { "target": "com.amazonaws.m2#ThrottlingException" }, { "target": "com.amazonaws.m2#ValidationException" } ], "traits": { "aws.api#controlPlane": {}, "smithy.api#documentation": "

Updates the configuration details for a specific runtime environment.

", "smithy.api#http": { "method": "PATCH", "uri": "/environments/{environmentId}", "code": 200 } } }, "com.amazonaws.m2#UpdateEnvironmentRequest": { "type": "structure", "members": { "environmentId": { "target": "com.amazonaws.m2#Identifier", "traits": { "smithy.api#documentation": "

The unique identifier of the runtime environment that you want to update.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "desiredCapacity": { "target": "com.amazonaws.m2#CapacityValue", "traits": { "smithy.api#default": null, "smithy.api#documentation": "

The desired capacity for the runtime environment to update. The minimum possible value is 0 and the maximum is 100.

" } }, "instanceType": { "target": "com.amazonaws.m2#String20", "traits": { "smithy.api#documentation": "

The instance type for the runtime environment to update.

" } }, "engineVersion": { "target": "com.amazonaws.m2#EngineVersion", "traits": { "smithy.api#documentation": "

The version of the runtime engine for the runtime environment.

" } }, "preferredMaintenanceWindow": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

Configures the maintenance window that you want for the runtime environment. The maintenance window must have the format ddd:hh24:mi-ddd:hh24:mi and must be less than 24 hours. The following two examples are valid maintenance windows: sun:23:45-mon:00:15 or sat:01:00-sat:03:00.

\n

If you do not provide a value, a random system-generated value will be assigned.

" } }, "applyDuringMaintenanceWindow": { "target": "com.amazonaws.m2#Boolean", "traits": { "smithy.api#default": false, "smithy.api#documentation": "

Indicates whether to update the runtime environment during the maintenance window. The\n default is false. Currently, Amazon Web Services Mainframe Modernization accepts the engineVersion parameter\n only if applyDuringMaintenanceWindow is true. If any parameter other than\n engineVersion is provided in UpdateEnvironmentRequest, it will\n fail if applyDuringMaintenanceWindow is set to true.

" } }, "forceUpdate": { "target": "com.amazonaws.m2#Boolean", "traits": { "smithy.api#default": false, "smithy.api#documentation": "

Forces the updates on the environment. This option is needed if the applications in the environment are not stopped or if there are ongoing application-related activities in the environment.

\n

If you use this option, be aware that it could lead to data corruption in the applications, and that you might need to perform repair and recovery procedures for the applications.

\n

This option is not needed if the attribute being updated is preferredMaintenanceWindow.

" } } } }, "com.amazonaws.m2#UpdateEnvironmentResponse": { "type": "structure", "members": { "environmentId": { "target": "com.amazonaws.m2#Identifier", "traits": { "smithy.api#documentation": "

The unique identifier of the runtime environment that was updated.

", "smithy.api#required": {} } } } }, "com.amazonaws.m2#ValidationException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } }, "reason": { "target": "com.amazonaws.m2#ValidationExceptionReason", "traits": { "smithy.api#documentation": "

The reason why it failed service validation.

" } }, "fieldList": { "target": "com.amazonaws.m2#ValidationExceptionFieldList", "traits": { "smithy.api#documentation": "

The list of fields that failed service validation.

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

One or more parameters provided in the request is not valid.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.m2#ValidationExceptionField": { "type": "structure", "members": { "name": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The name of the exception field.

", "smithy.api#required": {} } }, "message": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The message of the exception field.

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

Contains information about a validation exception field.

" } }, "com.amazonaws.m2#ValidationExceptionFieldList": { "type": "list", "member": { "target": "com.amazonaws.m2#ValidationExceptionField" } }, "com.amazonaws.m2#ValidationExceptionReason": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "unknownOperation", "name": "UNKNOWN_OPERATION" }, { "value": "cannotParse", "name": "CANNOT_PARSE" }, { "value": "featureNotAvailable", "name": "FEATURE_NOT_AVAILABLE" }, { "value": "unsupportedEngineVersion", "name": "UNSUPPORTED_ENGINE_VERSION" }, { "value": "fieldValidationFailed", "name": "FIELD_VALIDATION_FAILED" }, { "value": "other", "name": "OTHER" } ] } }, "com.amazonaws.m2#Version": { "type": "integer", "traits": { "smithy.api#range": { "min": 1 } } }, "com.amazonaws.m2#VsamAttributes": { "type": "structure", "members": { "format": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The record format of the data set.

", "smithy.api#required": {} } }, "encoding": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The character set used by the data set. Can be ASCII, EBCDIC, or unknown.

" } }, "compressed": { "target": "com.amazonaws.m2#Boolean", "traits": { "smithy.api#default": false, "smithy.api#documentation": "

Indicates whether indexes for this dataset are stored as compressed values. If you have\n a large data set (typically > 100 Mb), consider setting this flag to True.

" } }, "primaryKey": { "target": "com.amazonaws.m2#PrimaryKey", "traits": { "smithy.api#documentation": "

The primary key of the data set.

" } }, "alternateKeys": { "target": "com.amazonaws.m2#AlternateKeyList", "traits": { "smithy.api#documentation": "

The alternate key definitions, if any. A legacy dataset might not have any alternate key\n defined, but if those alternate keys definitions exist, provide them as some applications\n will make use of them.

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

The attributes of a VSAM type data set.

" } }, "com.amazonaws.m2#VsamDetailAttributes": { "type": "structure", "members": { "encoding": { "target": "com.amazonaws.m2#String20", "traits": { "smithy.api#documentation": "

The character set used by the data set. Can be ASCII, EBCDIC, or unknown.

" } }, "recordFormat": { "target": "com.amazonaws.m2#String20", "traits": { "smithy.api#documentation": "

The record format of the data set.

" } }, "compressed": { "target": "com.amazonaws.m2#Boolean", "traits": { "smithy.api#default": null, "smithy.api#documentation": "

Indicates whether indexes for this dataset are stored as compressed values. If you have\n a large data set (typically > 100 Mb), consider setting this flag to True.

" } }, "cacheAtStartup": { "target": "com.amazonaws.m2#Boolean", "traits": { "smithy.api#default": null, "smithy.api#documentation": "

If set to True, enforces loading the data set into cache before it\u2019s used by the\n application.

" } }, "primaryKey": { "target": "com.amazonaws.m2#PrimaryKey", "traits": { "smithy.api#documentation": "

The primary key of the data set.

" } }, "alternateKeys": { "target": "com.amazonaws.m2#AlternateKeyList", "traits": { "smithy.api#documentation": "

The alternate key definitions, if any. A legacy dataset might not have any alternate key\n defined, but if those alternate keys definitions exist, provide them as some applications\n will make use of them.

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

The attributes of a VSAM type data set.

" } } } }