find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/amazon-ecs:amazon-ecs-attribute-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Amazon EC2 Container Service Attribute API
  version: '2014-11-13'
  description: Generated from AWS's published Smithy model for Amazon EC2 Container Service. 3 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://ecs.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Attribute
paths:
  /#ListAttributes:
    post:
      operationId: ListAttributes
      summary: List Attributes
      description: Lists the attributes for Amazon ECS resources within a specified target type and cluster. When you specify a target type and cluster, ListAttributes returns a list of attribute objects, one for each attribute on each resource. You can filter the list of results to a single attribute name to only return results that have that name. You can also filter the results by attribute name and value. You can do this, for example, to see which container instances in a cluster are running a Linux AMI (ecs.os-type=linux).
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListAttributesResponse'
              example:
                attributes:
                - name: stack
                  targetId: arn:aws:ecs:us-west-2:123456789012:container-instance/1c3be8ed-df30-47b4-8f1e-6e68ebd01f34
                  value: production
        '403':
          description: AccessDeniedException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '400':
          description: ClientException; ClusterNotFoundException; InvalidParameterException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ClientException'
        '500':
          description: ServerException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ServerException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AmazonEC2ContainerServiceV20141113.ListAttributes
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListAttributesRequest'
            example:
              cluster: MyCluster
              targetType: container-instance
              attributeName: stack
              attributeValue: production
      tags:
      - Attribute
  /#DeleteAttributes:
    post:
      operationId: DeleteAttributes
      summary: Delete Attributes
      description: Deletes one or more custom attributes from an Amazon ECS resource.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DeleteAttributesResponse'
              example:
                attributes:
                - name: stack
                  targetId: aws:ecs:us-west-2:130757420319:container-instance/1c3be8ed-df30-47b4-8f1e-6e68ebd01f34
                  value: production
        '403':
          description: AccessDeniedException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '400':
          description: ClientException; ClusterNotFoundException; InvalidParameterException; TargetNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ClientException'
        '500':
          description: ServerException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ServerException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AmazonEC2ContainerServiceV20141113.DeleteAttributes
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteAttributesRequest'
            example:
              attributes:
              - name: stack
                targetId: aws:ecs:us-west-2:130757420319:container-instance/1c3be8ed-df30-47b4-8f1e-6e68ebd01f34
      tags:
      - Attribute
  /#PutAttributes:
    post:
      operationId: PutAttributes
      summary: Put Attributes
      description: Create or update an attribute on an Amazon ECS resource. If the attribute doesn't exist, it's created. If the attribute exists, its value is replaced with the specified value. To delete an attribute, use DeleteAttributes. For more information, see Attributes in the Amazon Elastic Container Service Developer Guide.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/PutAttributesResponse'
              example:
                attributes:
                - name: stack
                  targetId: arn:aws:ecs:us-west-2:123456789012:container-instance/1c3be8ed-df30-47b4-8f1e-6e68ebd01f34
                  value: production
        '403':
          description: AccessDeniedException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '400':
          description: AttributeLimitExceededException; ClientException; ClusterNotFoundException; InvalidParameterException; TargetNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AttributeLimitExceededException'
        '500':
          description: ServerException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ServerException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AmazonEC2ContainerServiceV20141113.PutAttributes
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/PutAttributesRequest'
            example:
              cluster: MyCluster
              attributes:
              - targetId: arn:aws:ecs:us-west-2:123456789012:container-instance/1c3be8ed-df30-47b4-8f1e-6e68ebd01f34
                name: stack
                value: production
      tags:
      - Attribute
components:
  schemas:
    PutAttributesResponse:
      type: object
      properties:
        attributes:
          type: array
          items:
            $ref: '#/components/schemas/Attribute'
          description: The attributes applied to your resource.
    Attribute:
      type: object
      properties:
        name:
          type: string
          description: The name of the attribute. The name must contain between 1 and 128 characters. The name may contain letters (uppercase and lowercase), numbers, hyphens (-), underscores (_), forward slashes (/), back slashes (\), or periods (.).
        value:
          type: string
          description: The value of the attribute. The value must contain between 1 and 128 characters. It can contain letters (uppercase and lowercase), numbers, hyphens (-), underscores (_), periods (.), at signs (@), forward slashes (/), back slashes (\), colons (:), or spaces. The value can't start or end with a space.
        targetType:
          type: string
          enum:
          - container-instance
          description: The type of the target to attach the attribute with. This parameter is required if you use the short form ID for a resource instead of the full ARN.
        targetId:
          type: string
          description: The ID of the target. You can specify the short form ID for a resource or the full Amazon Resource Name (ARN).
      required:
      - name
    DeleteAttributesResponse:
      type: object
      properties:
        attributes:
          type: array
          items:
            $ref: '#/components/schemas/Attribute'
          description: A list of attribute objects that were successfully deleted from your resource.
    PutAttributesRequest:
      type: object
      properties:
        cluster:
          type: string
          description: The short name or full Amazon Resource Name (ARN) of the cluster that contains the resource to apply attributes. If you do not specify a cluster, the default cluster is assumed.
        attributes:
          type: array
          items:
            $ref: '#/components/schemas/Attribute'
          description: The attributes to apply to your resource. You can specify up to 10 custom attributes for each resource. You can specify up to 10 attributes in a single call.
      required:
      - attributes
    ListAttributesResponse:
      type: object
      properties:
        attributes:
          type: array
          items:
            $ref: '#/components/schemas/Attribute'
          description: A list of attribute objects that meet the criteria of the request.
        nextToken:
          type: string
          description: The nextToken value to include in a future ListAttributes request. When the results of a ListAttributes request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
    ServerException:
      type: object
      properties:
        message:
          type: string
          description: Message that describes the cause of the exception.
    AccessDeniedException:
      type: object
      properties:
        message:
          type: string
          description: Message that describes the cause of the exception.
    DeleteAttributesRequest:
      type: object
      properties:
        cluster:
          type: string
          description: The short name or full Amazon Resource Name (ARN) of the cluster that contains the resource to delete attributes. If you do not specify a cluster, the default cluster is assumed.
        attributes:
          type: array
          items:
            $ref: '#/components/schemas/Attribute'
          description: The attributes to delete from your resource. You can specify up to 10 attributes for each request. For custom attributes, specify the attribute name and target ID, but don't specify the value. If you specify the target ID using the short form, you must also specify the target type.
      required:
      - attributes
    ListAttributesRequest:
      type: object
      properties:
        cluster:
          type: string
          description: The short name or full Amazon Resource Name (ARN) of the cluster to list attributes. If you do not specify a cluster, the default cluster is assumed.
        targetType:
          type: string
          enum:
          - container-instance
          description: The type of the target to list attributes with.
        attributeName:
          type: string
          description: The name of the attribute to filter the results with.
        attributeValue:
          type: string
          description: The value of the attribute to filter results with. You must also specify an attribute name to use this parameter.
        nextToken:
          type: string
          description: The nextToken value returned from a ListAttributes request indicating that more results are available to fulfill the request and further calls are needed. If maxResults was provided, it's possible the number of results to be fewer than maxResults. This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
        maxResults:
          type: integer
          description: The maximum number of cluster results that ListAttributes returned in paginated output. When this parameter is used, ListAttributes only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListAttributes request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then ListAttributes returns up to 100 results and a nextToken value if applicable.
      required:
      - targetType
    AttributeLimitExceededException:
      type: object
      properties:
        message:
          type: string
          description: Message that describes the cause of the exception.
    ClientException:
      type: object
      properties:
        message:
          type: string
          description: Message that describes the cause of the exception.
  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: ecs
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/ecs/service/2014-11-13/ecs-2014-11-13.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)