Amazon Proton · Schema

ListComponentsInput

ListComponentsInput schema from Amazon Proton API

DevOpsInfrastructure as CodePlatform EngineeringServerlessTemplatesSelf-ServiceCI/CD

Properties

Name Type Description
environmentName object
maxResults object
nextToken object
serviceInstanceName object
serviceName object
View JSON Schema on GitHub

JSON Schema

amazon-proton-list-components-input-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-proton/refs/heads/main/json-schema/amazon-proton-list-components-input-schema.json",
  "title": "ListComponentsInput",
  "description": "ListComponentsInput schema from Amazon Proton API",
  "type": "object",
  "properties": {
    "environmentName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ResourceName"
        },
        {
          "description": "The name of an environment for result list filtering. Proton returns components associated with the environment or attached to service instances running in it."
        }
      ]
    },
    "maxResults": {
      "allOf": [
        {
          "$ref": "#/components/schemas/MaxPageResults"
        },
        {
          "description": "The maximum number of components to list."
        }
      ]
    },
    "nextToken": {
      "allOf": [
        {
          "$ref": "#/components/schemas/NextToken"
        },
        {
          "description": "A token that indicates the location of the next component in the array of components, after the list of components that was previously requested."
        }
      ]
    },
    "serviceInstanceName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ResourceName"
        },
        {
          "description": "The name of a service instance for result list filtering. Proton returns the component attached to the service instance, if any."
        }
      ]
    },
    "serviceName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ResourceName"
        },
        {
          "description": "The name of a service for result list filtering. Proton returns components attached to service instances of the service."
        }
      ]
    }
  }
}