Amazon Systems Manager Systems Manager Environments API

openapi: 3.1.0
info:
  title: Amazon Simple Systems Manager (SSM) Environments API
  version: '2014-11-06'
  description: Generated from AWS's published Smithy model for Amazon Simple Systems Manager (SSM). 5 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://appconfig.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /applications/{ApplicationId}/environments:
    post:
      operationId: CreateEnvironment
      summary: Create Environment
      description: Creates an environment. For each application, you define one or more environments. An environment is a
        deployment group of AppConfig targets, such as applications in a Beta or Production environment. You can also define
        environments for application subcomponents such as the Web, Mobile and Back-end components for your application. You
        can configure Amazon CloudWatch alarms for each environment. The system monitors alarms during a configuration deployment.
        If an alarm is triggered, the system rolls back the configuration.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Environment'
              example:
                ApplicationId: 339ohji
                Id: 54j1r29
                Name: Example-Environment
                State: READY_FOR_DEPLOYMENT
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppconfigInternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppconfigResourceNotFoundException'
        '402':
          description: ServiceQuotaExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppconfigServiceQuotaExceededException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateEnvironmentRequest'
            example:
              ApplicationId: 339ohji
              Name: Example-Environment
      tags:
      - Environments
    get:
      operationId: ListEnvironments
      summary: List Environments
      description: Lists the environments for an application.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Environments'
              example:
                Items:
                - ApplicationId: 339ohji
                  Id: 54j1r29
                  Name: Example-Environment
                  State: READY_FOR_DEPLOYMENT
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppconfigInternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppconfigResourceNotFoundException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListEnvironmentsRequest'
            example:
              ApplicationId: 339ohji
      tags:
      - Environments
  /applications/{ApplicationId}/environments/{EnvironmentId}:
    delete:
      operationId: DeleteEnvironment
      summary: Delete Environment
      description: Deletes an environment. To prevent users from unintentionally deleting actively-used environments, enable
        deletion protection.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: string
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppconfigInternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppconfigResourceNotFoundException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteEnvironmentRequest'
            example:
              ApplicationId: 339ohji
              EnvironmentId: 54j1r29
      tags:
      - Environments
    get:
      operationId: GetEnvironment
      summary: Get Environment
      description: Retrieves information about an environment. An environment is a deployment group of AppConfig applications,
        such as applications in a Production environment or in an EU_Region environment. Each configuration deployment targets
        an environment. You can enable one or more Amazon CloudWatch alarms for an environment. If an alarm is triggered during
        a deployment, AppConfig roles back the configuration.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Environment'
              example:
                ApplicationId: 339ohji
                Id: 54j1r29
                Name: Example-Environment
                State: READY_FOR_DEPLOYMENT
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppconfigInternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppconfigResourceNotFoundException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetEnvironmentRequest'
            example:
              ApplicationId: 339ohji
              EnvironmentId: 54j1r29
      tags:
      - Environments
    patch:
      operationId: UpdateEnvironment
      summary: Update Environment
      description: Updates an environment.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Environment'
              example:
                ApplicationId: 339ohji
                Id: 54j1r29
                Name: Example-Environment
                Description: An environment for examples.
                State: ROLLED_BACK
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppconfigInternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppconfigResourceNotFoundException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateEnvironmentRequest'
            example:
              ApplicationId: 339ohji
              EnvironmentId: 54j1r29
              Description: An environment for examples.
      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: appconfig
  schemas:
    AppconfigInternalServerException:
      type: object
      properties:
        Message:
          type: string
    AppconfigResourceNotFoundException:
      type: object
      properties:
        Message:
          type: string
        ResourceName:
          type: string
    AppconfigServiceQuotaExceededException:
      type: object
      properties:
        Message:
          type: string
    BadRequestDetails:
      type: object
      properties:
        InvalidConfiguration:
          type: array
          items:
            $ref: '#/components/schemas/InvalidConfigurationDetail'
          description: Detailed information about the bad request exception error when creating a hosted configuration version.
      description: Exactly one member is set.
    BadRequestException:
      type: object
      properties:
        Message:
          type: string
        Reason:
          type: string
          enum:
          - InvalidConfiguration
        Details:
          $ref: '#/components/schemas/BadRequestDetails'
    ConflictException:
      type: object
      properties:
        Message:
          type: string
    CreateEnvironmentRequest:
      type: object
      properties:
        ApplicationId:
          type: string
          description: The application ID.
        Name:
          type: string
          description: A name for the environment.
        Description:
          type: string
          description: A description of the environment.
        Monitors:
          type: array
          items:
            $ref: '#/components/schemas/Monitor'
          description: Amazon CloudWatch alarms to monitor during the deployment process.
        Tags:
          type: object
          additionalProperties:
            type: string
          description: Metadata to assign to the environment. Tags help organize and categorize your AppConfig resources.
            Each tag consists of a key and an optional value, both of which you define.
      required:
      - ApplicationId
      - Name
    DeleteEnvironmentRequest:
      type: object
      properties:
        EnvironmentId:
          type: string
          description: The ID of the environment that you want to delete.
        ApplicationId:
          type: string
          description: The application ID that includes the environment that you want to delete.
        DeletionProtectionCheck:
          type: string
          enum:
          - ACCOUNT_DEFAULT
          - APPLY
          - BYPASS
          description: 'A parameter to configure deletion protection. Deletion protection prevents a user from deleting an
            environment if your application called either GetLatestConfiguration or in the environment during the specified
            interval. This parameter supports the following values: BYPASS: Instructs AppConfig to bypass the deletion protection
            check and delete a configuration profile even if deletion protection would have otherwise prevented it. APPLY:
            Instructs the deletion protection check to run, even if deletion protection is disabled at the account level.
            APPLY also forces the deletion protection check to'
      required:
      - EnvironmentId
      - ApplicationId
    Environment:
      type: object
      properties:
        ApplicationId:
          type: string
          description: The application ID.
        Id:
          type: string
          description: The environment ID.
        Name:
          type: string
          description: The name of the environment.
        Description:
          type: string
          description: The description of the environment.
        State:
          type: string
          enum:
          - READY_FOR_DEPLOYMENT
          - DEPLOYING
          - ROLLING_BACK
          - ROLLED_BACK
          - REVERTED
          description: 'The state of the environment. An environment can be in one of the following states: READY_FOR_DEPLOYMENT,
            DEPLOYING, ROLLING_BACK, or ROLLED_BACK'
        Monitors:
          type: array
          items:
            $ref: '#/components/schemas/Monitor'
          description: Amazon CloudWatch alarms monitored during the deployment.
    Environments:
      type: object
      properties:
        Items:
          type: array
          items:
            $ref: '#/components/schemas/Environment'
          description: The elements from this collection.
        NextToken:
          type: string
          description: The token for the next set of items to return. Use this token to get the next set of results.
    GetEnvironmentRequest:
      type: object
      properties:
        ApplicationId:
          type: string
          description: The ID of the application that includes the environment you want to get.
        EnvironmentId:
          type: string
          description: The ID of the environment that you want to get.
      required:
      - ApplicationId
      - EnvironmentId
    InvalidConfigurationDetail:
      type: object
      properties:
        Constraint:
          type: string
          description: The invalid or out-of-range validation constraint in your JSON schema that failed validation.
        Location:
          type: string
          description: Location of the validation constraint in the configuration JSON schema that failed validation.
        Reason:
          type: string
          description: The reason for an invalid configuration error.
        Type:
          type: string
          description: The type of error for an invalid configuration.
        Value:
          type: string
          description: Details about an error with Lambda when a synchronous extension experiences an error during an invocation.
    ListEnvironmentsRequest:
      type: object
      properties:
        ApplicationId:
          type: string
          description: The application ID.
        MaxResults:
          type: integer
          description: The maximum number of items to return for this call. The call also returns a token that you can specify
            in a subsequent call to get the next set of results.
        NextToken:
          type: string
          description: A token to start the list. Use this token to get the next set of results.
      required:
      - ApplicationId
    Monitor:
      type: object
      properties:
        AlarmArn:
          type: string
          description: Amazon Resource Name (ARN) of the Amazon CloudWatch alarm.
        AlarmRoleArn:
          type: string
          description: ARN of an Identity and Access Management (IAM) role for AppConfig to monitor AlarmArn.
      required:
      - AlarmArn
    UpdateEnvironmentRequest:
      type: object
      properties:
        ApplicationId:
          type: string
          description: The application ID.
        EnvironmentId:
          type: string
          description: The environment ID.
        Name:
          type: string
          description: The name of the environment.
        Description:
          type: string
          description: A description of the environment.
        Monitors:
          type: array
          items:
            $ref: '#/components/schemas/Monitor'
          description: Amazon CloudWatch alarms to monitor during the deployment process.
      required:
      - ApplicationId
      - EnvironmentId
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/appconfig/service/2019-10-09/appconfig-2019-10-09.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)