Amazon Proton #X Amz Target=AwsProton20200720.ListEnvironments API

openapi: 3.2.0
info:
  version: 2020-07-20
  x-release: v4
  title: 'AWS Proton #X Amz Target=AwsProton20200720.ListEnvironments…'
  description: This is the Proton Service API Reference.
  x-logo:
    url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png
    backgroundColor: '#FFFFFF'
  termsOfService: https://aws.amazon.com/service-terms/
  contact:
    name: Mike Ralphson
    email: mike.ralphson@gmail.com
    url: https://github.com/mermade/aws2openapi
    x-twitter: PermittedSoc
  license:
    name: Apache 2.0 License
    url: http://www.apache.org/licenses/
  x-providerName: amazonaws.com
  x-serviceName: proton
  x-aws-signingName: proton
  x-origin:
  - contentType: application/json
    url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/proton-2020-07-20.normal.json
    converter:
      url: https://github.com/mermade/aws2openapi
      version: 1.0.0
    x-apisguru-driver: external
  x-apiClientRegistration:
    url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
  x-apisguru-categories:
  - cloud
  x-preferred: true
servers:
- url: http://proton.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The AWS Proton multi-region endpoint
- url: https://proton.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The AWS Proton multi-region endpoint
- url: http://proton.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The AWS Proton endpoint for China (Beijing) and China (Ningxia)
- url: https://proton.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The AWS Proton endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: '#X Amz Target=AwsProton20200720.ListEnvironments'
paths:
  /#X-Amz-Target=AwsProton20200720.ListEnvironments:
    parameters:
    - $ref: '#/components/parameters/X-Amz-Content-Sha256'
    - $ref: '#/components/parameters/X-Amz-Date'
    - $ref: '#/components/parameters/X-Amz-Algorithm'
    - $ref: '#/components/parameters/X-Amz-Credential'
    - $ref: '#/components/parameters/X-Amz-Security-Token'
    - $ref: '#/components/parameters/X-Amz-Signature'
    - $ref: '#/components/parameters/X-Amz-SignedHeaders'
    post:
      operationId: ListEnvironments
      description: List environments with detail data summaries.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListEnvironmentsOutput'
        '480':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
        '481':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '482':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '483':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '484':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListEnvironmentsInput'
      parameters:
      - name: maxResults
        in: query
        schema:
          type: string
        description: Pagination limit
        required: false
      - name: nextToken
        in: query
        schema:
          type: string
        description: Pagination token
        required: false
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AwsProton20200720.ListEnvironments
      summary: Amazon Proton List Environments
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - '#X Amz Target=AwsProton20200720.ListEnvironments'
components:
  schemas:
    ListEnvironmentsOutput:
      type: object
      required:
      - environments
      properties:
        environments:
          allOf:
          - $ref: '#/components/schemas/EnvironmentSummaryList'
          - description: An array of environment detail data summaries.
        nextToken:
          allOf:
          - $ref: '#/components/schemas/NextToken'
          - description: A token that indicates the location of the next environment in the array of environments, after the current requested list of environments.
    ResourceName:
      type: string
      pattern: ^[0-9A-Za-z]+[0-9A-Za-z_\-]*$
      minLength: 1
      maxLength: 100
    ValidationException: {}
    ResourceNotFoundException: {}
    TemplateVersionPart:
      type: string
      pattern: ^(0|([1-9]{1}\d*))$
      minLength: 1
      maxLength: 20
    EnvironmentArn:
      type: string
    EnvironmentAccountConnectionId:
      type: string
      pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
    NextToken:
      type: string
      pattern: ^[A-Za-z0-9+=/]+$
    Arn:
      type: string
      pattern: ^arn:(aws|aws-cn|aws-us-gov):[a-zA-Z0-9-]+:[a-zA-Z0-9-]*:\d{12}:([\w+=,.@-]+[/:])*[\w+=,.@-]+$
      minLength: 1
      maxLength: 200
    ThrottlingException: {}
    StatusMessage:
      type: string
      format: password
    EnvironmentTemplateFilter:
      type: object
      required:
      - majorVersion
      - templateName
      properties:
        majorVersion:
          allOf:
          - $ref: '#/components/schemas/TemplateVersionPart'
          - description: Include <code>majorVersion</code> to filter search for a major version.
        templateName:
          allOf:
          - $ref: '#/components/schemas/ResourceName'
          - description: Include <code>templateName</code> to filter search for a template name.
      description: A search filter for environment templates.
    EnvironmentTemplateFilterList:
      type: array
      items:
        $ref: '#/components/schemas/EnvironmentTemplateFilter'
    Description:
      type: string
      minLength: 0
      maxLength: 500
      format: password
    Timestamp:
      type: string
      format: date-time
    DeploymentStatus:
      type: string
      enum:
      - IN_PROGRESS
      - FAILED
      - SUCCEEDED
      - DELETE_IN_PROGRESS
      - DELETE_FAILED
      - DELETE_COMPLETE
      - CANCELLING
      - CANCELLED
    MaxPageResults:
      type: integer
      minimum: 1
      maximum: 100
    EnvironmentSummary:
      type: object
      required:
      - arn
      - createdAt
      - deploymentStatus
      - lastDeploymentAttemptedAt
      - lastDeploymentSucceededAt
      - name
      - templateMajorVersion
      - templateMinorVersion
      - templateName
      properties:
        arn:
          allOf:
          - $ref: '#/components/schemas/EnvironmentArn'
          - description: The Amazon Resource Name (ARN) of the environment.
        componentRoleArn:
          allOf:
          - $ref: '#/components/schemas/Arn'
          - description: <p>The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in this environment. It determines the scope of infrastructure that a component can provision.</p> <p>The environment must have a <code>componentRoleArn</code> to allow directly defined components to be associated with the environment.</p> <p>For more information about components, see <a href="https://docs.aws.amazon.com/proton/latest/userguide/ag-components.html">Proton components</a> in the <i>Proton User Guide</i>.</p>
        createdAt:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: The time when the environment was created.
        deploymentStatus:
          allOf:
          - $ref: '#/components/schemas/DeploymentStatus'
          - description: The environment deployment status.
        deploymentStatusMessage:
          allOf:
          - $ref: '#/components/schemas/StatusMessage'
          - description: An environment deployment status message.
        description:
          allOf:
          - $ref: '#/components/schemas/Description'
          - description: The description of the environment.
        environmentAccountConnectionId:
          allOf:
          - $ref: '#/components/schemas/EnvironmentAccountConnectionId'
          - description: The ID of the environment account connection that the environment is associated with.
        environmentAccountId:
          allOf:
          - $ref: '#/components/schemas/AwsAccountId'
          - description: The ID of the environment account that the environment infrastructure resources are provisioned in.
        lastDeploymentAttemptedAt:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: The time when a deployment of the environment was last attempted.
        lastDeploymentSucceededAt:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: The time when the environment was last deployed successfully.
        name:
          allOf:
          - $ref: '#/components/schemas/ResourceName'
          - description: The name of the environment.
        protonServiceRoleArn:
          allOf:
          - $ref: '#/components/schemas/Arn'
          - description: The Amazon Resource Name (ARN) of the Proton service role that allows Proton to make calls to other services on your behalf.
        provisioning:
          allOf:
          - $ref: '#/components/schemas/Provisioning'
          - description: When included, indicates that the environment template is for customer provisioned and managed infrastructure.
        templateMajorVersion:
          allOf:
          - $ref: '#/components/schemas/TemplateVersionPart'
          - description: The major version of the environment template.
        templateMinorVersion:
          allOf:
          - $ref: '#/components/schemas/TemplateVersionPart'
          - description: The minor version of the environment template.
        templateName:
          allOf:
          - $ref: '#/components/schemas/ResourceName'
          - description: The name of the environment template.
      description: Summary data of an Proton environment resource. An Proton environment is a set of resources shared across Proton services.
    Provisioning:
      type: string
      enum:
      - CUSTOMER_MANAGED
    EnvironmentSummaryList:
      type: array
      items:
        $ref: '#/components/schemas/EnvironmentSummary'
    AwsAccountId:
      type: string
      pattern: ^\d{12}$
    ListEnvironmentsInput:
      type: object
      title: ListEnvironmentsInput
      properties:
        environmentTemplates:
          allOf:
          - $ref: '#/components/schemas/EnvironmentTemplateFilterList'
          - description: An array of the versions of the environment template.
        maxResults:
          allOf:
          - $ref: '#/components/schemas/MaxPageResults'
          - description: The maximum number of environments to list.
        nextToken:
          allOf:
          - $ref: '#/components/schemas/NextToken'
          - description: A token that indicates the location of the next environment in the array of environments, after the list of environments that was previously requested.
    AccessDeniedException: {}
    InternalServerException: {}
  parameters:
    X-Amz-Content-Sha256:
      name: X-Amz-Content-Sha256
      in: header
      schema:
        type: string
      required: false
    X-Amz-Algorithm:
      name: X-Amz-Algorithm
      in: header
      schema:
        type: string
      required: false
    X-Amz-Credential:
      name: X-Amz-Credential
      in: header
      schema:
        type: string
      required: false
    X-Amz-SignedHeaders:
      name: X-Amz-SignedHeaders
      in: header
      schema:
        type: string
      required: false
    X-Amz-Signature:
      name: X-Amz-Signature
      in: header
      schema:
        type: string
      required: false
    X-Amz-Security-Token:
      name: X-Amz-Security-Token
      in: header
      schema:
        type: string
      required: false
    X-Amz-Date:
      name: X-Amz-Date
      in: header
      schema:
        type: string
      required: false
  securitySchemes:
    hmac:
      type: apiKey
      name: Authorization
      in: header
      description: Amazon Signature authorization v4
      x-amazon-apigateway-authtype: awsSigv4
externalDocs:
  description: Amazon Web Services documentation
  url: https://docs.aws.amazon.com/proton/
x-hasEquivalentPaths: true