Amazon Mainframe Modernization Environments API

openapi: 3.1.0
info:
  title: AWSMainframeModernization Environments API
  version: '2021-04-28'
  description: Generated from AWS's published Smithy model for AWSMainframeModernization. 6 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://m2.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /applications/{applicationId}/environment/{environmentId}:
    delete:
      operationId: DeleteApplicationFromEnvironment
      summary: Delete Application From Environment
      description: Deletes a specific application from the specific runtime environment where it was previously deployed.
        You cannot delete a runtime environment using DeleteEnvironment if any application has ever been deployed to it. This
        API removes the association of the application with the runtime environment so you can delete the environment smoothly.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteApplicationFromEnvironmentResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteApplicationFromEnvironmentRequest'
      tags:
      - Environments
  /environments:
    post:
      operationId: CreateEnvironment
      summary: Create Environment
      description: Creates a runtime environment for a given runtime engine.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateEnvironmentResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '402':
          description: ServiceQuotaExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceQuotaExceededException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateEnvironmentRequest'
      tags:
      - Environments
    get:
      operationId: ListEnvironments
      summary: List Environments
      description: Lists the runtime environments.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListEnvironmentsResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListEnvironmentsRequest'
      tags:
      - Environments
  /environments/{environmentId}:
    get:
      operationId: GetEnvironment
      summary: Get Environment
      description: Describes a specific runtime environment.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetEnvironmentResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetEnvironmentRequest'
      tags:
      - Environments
    patch:
      operationId: UpdateEnvironment
      summary: Update Environment
      description: Updates the configuration details for a specific runtime environment.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateEnvironmentResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '402':
          description: ServiceQuotaExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceQuotaExceededException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateEnvironmentRequest'
      tags:
      - Environments
    delete:
      operationId: DeleteEnvironment
      summary: Delete Environment
      description: Deletes a specific runtime environment. The environment cannot contain deployed applications. If it does,
        you must delete those applications before you delete the environment.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteEnvironmentResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteEnvironmentRequest'
      tags:
      - Environments
components:
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical
        request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: m2
  schemas:
    AccessDeniedException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    ConflictException:
      type: object
      properties:
        message:
          type: string
        resourceId:
          type: string
          description: The ID of the conflicting resource.
        resourceType:
          type: string
          description: The type of the conflicting resource.
      required:
      - message
    CreateEnvironmentRequest:
      type: object
      properties:
        name:
          type: string
          description: The name of the runtime environment. Must be unique within the account.
        instanceType:
          type: string
          description: The type of instance for the runtime environment.
        description:
          type: string
          description: The description of the runtime environment.
        engineType:
          type: string
          description: The engine type for the runtime environment.
        engineVersion:
          type: string
          description: The version of the engine type for the runtime environment.
        subnetIds:
          type: array
          items:
            type: string
          description: The list of subnets associated with the VPC for this runtime environment.
        securityGroupIds:
          type: array
          items:
            type: string
          description: The list of security groups for the VPC associated with this runtime environment.
        storageConfigurations:
          type: array
          items:
            $ref: '#/components/schemas/StorageConfiguration'
          description: Optional. The storage configurations for this runtime environment.
        publiclyAccessible:
          type: boolean
          description: Specifies whether the runtime environment is publicly accessible.
        highAvailabilityConfig:
          $ref: '#/components/schemas/HighAvailabilityConfig'
        tags:
          type: object
          additionalProperties:
            type: string
          description: The tags for the runtime environment.
        preferredMaintenanceWindow:
          type: string
          description: '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. If you do not provide a value, a random system-generated
            value will be assigned.'
        networkType:
          type: string
          description: The network type required for the runtime environment.
        clientToken:
          type: string
          description: Unique, case-sensitive identifier you provide to ensure the idempotency of the request to create an
            environment. 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.
        kmsKeyId:
          type: string
          description: The identifier of a customer managed key.
      required:
      - name
      - instanceType
      - engineType
    CreateEnvironmentResponse:
      type: object
      properties:
        environmentId:
          type: string
          description: The unique identifier of the runtime environment.
      required:
      - environmentId
    DeleteApplicationFromEnvironmentRequest:
      type: object
      properties:
        applicationId:
          type: string
          description: The unique identifier of the application you want to delete.
        environmentId:
          type: string
          description: The unique identifier of the runtime environment where the application was previously deployed.
      required:
      - applicationId
      - environmentId
    DeleteApplicationFromEnvironmentResponse:
      type: object
      properties: {}
    DeleteEnvironmentRequest:
      type: object
      properties:
        environmentId:
          type: string
          description: The unique identifier of the runtime environment you want to delete.
      required:
      - environmentId
    DeleteEnvironmentResponse:
      type: object
      properties: {}
    EfsStorageConfiguration:
      type: object
      properties:
        fileSystemId:
          type: string
          description: The file system identifier.
        mountPoint:
          type: string
          description: The mount point for the file system.
      required:
      - fileSystemId
      - mountPoint
    EnvironmentSummary:
      type: object
      properties:
        name:
          type: string
          description: The name of the runtime environment.
        environmentArn:
          type: string
          description: The Amazon Resource Name (ARN) of a particular runtime environment.
        environmentId:
          type: string
          description: The unique identifier of a particular runtime environment.
        instanceType:
          type: string
          description: The instance type of the runtime environment.
        status:
          type: string
          description: The status of the runtime environment
        engineType:
          type: string
          description: The target platform for the runtime environment.
        engineVersion:
          type: string
          description: The version of the runtime engine.
        creationTime:
          type: string
          format: date-time
          description: The timestamp when the runtime environment was created.
        networkType:
          type: string
          description: The network type supported by the runtime environment.
      required:
      - name
      - environmentArn
      - environmentId
      - instanceType
      - status
      - engineType
      - engineVersion
      - creationTime
    FsxStorageConfiguration:
      type: object
      properties:
        fileSystemId:
          type: string
          description: The file system identifier.
        mountPoint:
          type: string
          description: The mount point for the file system.
      required:
      - fileSystemId
      - mountPoint
    GetEnvironmentRequest:
      type: object
      properties:
        environmentId:
          type: string
          description: The unique identifier of the runtime environment.
      required:
      - environmentId
    GetEnvironmentResponse:
      type: object
      properties:
        name:
          type: string
          description: The name of the runtime environment. Must be unique within the account.
        description:
          type: string
          description: The description of the runtime environment.
        environmentArn:
          type: string
          description: The Amazon Resource Name (ARN) of the runtime environment.
        environmentId:
          type: string
          description: The unique identifier of the runtime environment.
        instanceType:
          type: string
          description: The type of instance underlying the runtime environment.
        status:
          type: string
          description: The status of the runtime environment. If the Amazon Web Services Mainframe Modernization environment
            is missing a connection to the customer owned dependent resource, the status will be Unhealthy.
        engineType:
          type: string
          description: The target platform for the runtime environment.
        engineVersion:
          type: string
          description: The version of the runtime engine.
        vpcId:
          type: string
          description: The unique identifier for the VPC used with this runtime environment.
        subnetIds:
          type: array
          items:
            type: string
          description: The unique identifiers of the subnets assigned to this runtime environment.
        securityGroupIds:
          type: array
          items:
            type: string
          description: The unique identifiers of the security groups assigned to this runtime environment.
        creationTime:
          type: string
          format: date-time
          description: The timestamp when the runtime environment was created.
        storageConfigurations:
          type: array
          items:
            $ref: '#/components/schemas/StorageConfiguration'
          description: The storage configurations defined for the runtime environment.
        tags:
          type: object
          additionalProperties:
            type: string
          description: The tags defined for this runtime environment.
        highAvailabilityConfig:
          $ref: '#/components/schemas/HighAvailabilityConfig'
        publiclyAccessible:
          type: boolean
          description: Whether applications running in this runtime environment are publicly accessible.
        actualCapacity:
          type: integer
          description: The number of instances included in the runtime environment. A standalone runtime environment has a
            maximum of one instance. Currently, a high availability runtime environment has a maximum of two instances.
        loadBalancerArn:
          type: string
          description: The Amazon Resource Name (ARN) for the load balancer used with the runtime environment.
        statusReason:
          type: string
          description: The reason for the reported status.
        preferredMaintenanceWindow:
          type: string
          description: The maintenance window for the runtime environment. If you don't provide a value for the maintenance
            window, the service assigns a random value.
        pendingMaintenance:
          $ref: '#/components/schemas/PendingMaintenance'
        kmsKeyId:
          type: string
          description: The identifier of a customer managed key.
        networkType:
          type: string
          description: The network type supported by the runtime environment.
      required:
      - name
      - environmentArn
      - environmentId
      - instanceType
      - status
      - engineType
      - engineVersion
      - vpcId
      - subnetIds
      - securityGroupIds
      - creationTime
    HighAvailabilityConfig:
      type: object
      properties:
        desiredCapacity:
          type: integer
          description: The number of instances in a high availability configuration. The minimum possible value is 1 and the
            maximum is 100.
      required:
      - desiredCapacity
    InternalServerException:
      type: object
      properties:
        message:
          type: string
        retryAfterSeconds:
          type: integer
          description: The number of seconds to wait before retrying the request.
      required:
      - message
    ListEnvironmentsRequest:
      type: object
      properties:
        nextToken:
          type: string
          description: A pagination token to control the number of runtime environments displayed in the list.
        maxResults:
          type: integer
          description: The maximum number of runtime environments to return.
        names:
          type: array
          items:
            type: string
          description: The names of the runtime environments. Must be unique within the account.
        engineType:
          type: string
          description: The engine type for the runtime environment.
    ListEnvironmentsResponse:
      type: object
      properties:
        environments:
          type: array
          items:
            $ref: '#/components/schemas/EnvironmentSummary'
          description: Returns a list of summary details for all the runtime environments in your account.
        nextToken:
          type: string
          description: A pagination token that's returned when the response doesn't contain all the runtime environments.
      required:
      - environments
    MaintenanceSchedule:
      type: object
      properties:
        startTime:
          type: string
          format: date-time
          description: The time the scheduled maintenance is to start.
        endTime:
          type: string
          format: date-time
          description: The time the scheduled maintenance is to end.
    PendingMaintenance:
      type: object
      properties:
        schedule:
          $ref: '#/components/schemas/MaintenanceSchedule'
        engineVersion:
          type: string
          description: The specific runtime engine that the maintenance schedule applies to.
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
        resourceId:
          type: string
          description: The ID of the missing resource.
        resourceType:
          type: string
          description: The type of the missing resource.
      required:
      - message
    ServiceQuotaExceededException:
      type: object
      properties:
        message:
          type: string
        resourceId:
          type: string
          description: The ID of the resource that is exceeding the quota limit.
        resourceType:
          type: string
          description: The type of resource that is exceeding the quota limit for Amazon Web Services Mainframe Modernization.
        serviceCode:
          type: string
          description: A code that identifies the service that the exceeded quota belongs to.
        quotaCode:
          type: string
          description: The identifier of the exceeded quota.
      required:
      - message
    StorageConfiguration:
      type: object
      properties:
        efs:
          $ref: '#/components/schemas/EfsStorageConfiguration'
        fsx:
          $ref: '#/components/schemas/FsxStorageConfiguration'
      description: Exactly one member is set.
    ThrottlingException:
      type: object
      properties:
        message:
          type: string
        serviceCode:
          type: string
          description: The identifier of the service that the throttled request was made to.
        quotaCode:
          type: string
          description: The identifier of the throttled request.
        retryAfterSeconds:
          type: integer
          description: The number of seconds to wait before retrying the request.
      required:
      - message
    UpdateEnvironmentRequest:
      type: object
      properties:
        environmentId:
          type: string
          description: The unique identifier of the runtime environment that you want to update.
        desiredCapacity:
          type: integer
          description: The desired capacity for the runtime environment to update. The minimum possible value is 0 and the
            maximum is 100.
        instanceType:
          type: string
          description: The instance type for the runtime environment to update.
        engineVersion:
          type: string
          description: The version of the runtime engine for the runtime environment.
        preferredMaintenanceWindow:
          type: string
          description: '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. If you do not provide a value, a random system-generated
            value will be assigned.'
        applyDuringMaintenanceWindow:
          type: boolean
          description: Indicates whether to update the runtime environment during the maintenance window. The default is false.
            Currently, Amazon Web Services Mainframe Modernization accepts the engineVersion parameter only if applyDuringMaintenanceWindow
            is true. If any parameter other than engineVersion is provided in UpdateEnvironmentRequest, it will fail if applyDuringMaintenanceWindow
            is set to true.
        forceUpdate:
          type: boolean
          description: 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. 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. This option is not needed if the attribute being updated is preferredMaintenanceWindow.
      required:
      - environmentId
    UpdateEnvironmentResponse:
      type: object
      properties:
        environmentId:
          type: string
          description: The unique identifier of the runtime environment that was updated.
      required:
      - environmentId
    ValidationException:
      type: object
      properties:
        message:
          type: string
        reason:
          type: string
          description: The reason why it failed service validation.
        fieldList:
          type: array
          items:
            $ref: '#/components/schemas/ValidationExceptionField'
          description: The list of fields that failed service validation.
      required:
      - message
    ValidationExceptionField:
      type: object
      properties:
        name:
          type: string
          description: The name of the exception field.
        message:
          type: string
          description: The message of the exception field.
      required:
      - name
      - message
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/m2/service/2021-04-28/m2-2021-04-28.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)