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-account-setting-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 Account Setting 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: Account Setting
paths:
  /#DeleteAccountSetting:
    post:
      operationId: DeleteAccountSetting
      summary: Delete Account Setting
      description: Disables an account setting for a specified user, role, or the root user for an account.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DeleteAccountSettingResponse'
              example:
                setting:
                  name: serviceLongArnFormat
                  value: enabled
                  principalArn: arn:aws:iam::<aws_account_id>:user/principalName
        '403':
          description: AccessDeniedException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '400':
          description: ClientException; 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.DeleteAccountSetting
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteAccountSettingRequest'
            example:
              name: serviceLongArnFormat
      tags:
      - Account Setting
  /#ListAccountSettings:
    post:
      operationId: ListAccountSettings
      summary: List Account Settings
      description: Lists the account settings for a specified principal.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListAccountSettingsResponse'
              example:
                settings:
                - name: containerInstanceLongArnFormat
                  value: disabled
                  principalArn: arn:aws:iam::<aws_account_id>:user/principalName
                - name: serviceLongArnFormat
                  value: enabled
                  principalArn: arn:aws:iam::<aws_account_id>:user/principalName
                - name: taskLongArnFormat
                  value: disabled
                  principalArn: arn:aws:iam::<aws_account_id>:user/principalName
        '403':
          description: AccessDeniedException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '400':
          description: ClientException; 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.ListAccountSettings
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListAccountSettingsRequest'
            example:
              effectiveSettings: true
      tags:
      - Account Setting
  /#PutAccountSetting:
    post:
      operationId: PutAccountSetting
      summary: Put Account Setting
      description: Modifies an account setting. Account settings are set on a per-Region basis. If you change the root user account setting, the default settings are reset for users and roles that do not have specified individual account settings. For more information, see Account Settings in the Amazon Elastic Container Service Developer Guide.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/PutAccountSettingResponse'
              example:
                setting:
                  name: serviceLongArnFormat
                  value: enabled
                  principalArn: arn:aws:iam::<aws_account_id>:user/principalName
        '403':
          description: AccessDeniedException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '400':
          description: ClientException; 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.PutAccountSetting
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/PutAccountSettingRequest'
            example:
              name: serviceLongArnFormat
              value: enabled
      tags:
      - Account Setting
components:
  schemas:
    Setting:
      type: object
      properties:
        name:
          type: string
          enum:
          - serviceLongArnFormat
          - taskLongArnFormat
          - containerInstanceLongArnFormat
          - awsvpcTrunking
          - containerInsights
          - fargateFIPSMode
          - tagResourceAuthorization
          - fargateTaskRetirementWaitPeriod
          - guardDutyActivate
          - defaultLogDriverMode
          - fargateEventWindows
          description: The Amazon ECS resource name.
        value:
          type: string
          description: Determines whether the account setting is on or off for the specified resource.
        principalArn:
          type: string
          description: The ARN of the principal. It can be a user, role, or the root user. If this field is omitted, the authenticated user is assumed.
        type:
          type: string
          enum:
          - user
          - aws_managed
          description: Indicates whether Amazon Web Services manages the account setting, or if the user manages it. aws_managed account settings are read-only, as Amazon Web Services manages such on the customer's behalf. Currently, the guardDutyActivate account setting is the only one Amazon Web Services manages.
    PutAccountSettingResponse:
      type: object
      properties:
        setting:
          $ref: '#/components/schemas/Setting'
    ListAccountSettingsResponse:
      type: object
      properties:
        settings:
          type: array
          items:
            $ref: '#/components/schemas/Setting'
          description: The account settings for the resource.
        nextToken:
          type: string
          description: The nextToken value to include in a future ListAccountSettings request. When the results of a ListAccountSettings 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.
    ListAccountSettingsRequest:
      type: object
      properties:
        name:
          type: string
          enum:
          - serviceLongArnFormat
          - taskLongArnFormat
          - containerInstanceLongArnFormat
          - awsvpcTrunking
          - containerInsights
          - fargateFIPSMode
          - tagResourceAuthorization
          - fargateTaskRetirementWaitPeriod
          - guardDutyActivate
          - defaultLogDriverMode
          - fargateEventWindows
          description: The name of the account setting you want to list the settings for.
        value:
          type: string
          description: The value of the account settings to filter results with. You must also specify an account setting name to use this parameter.
        principalArn:
          type: string
          description: The ARN of the principal, which can be a user, role, or the root user. If this field is omitted, the account settings are listed only for the authenticated user. In order to use this parameter, you must be the root user, or the principal. Federated users assume the account setting of the root user and can't have explicit account settings set for them.
        effectiveSettings:
          type: boolean
          description: Determines whether to return the effective settings. If true, the account settings for the root user or the default setting for the principalArn are returned. If false, the account settings for the principalArn are returned if they're set. Otherwise, no account settings are returned.
        nextToken:
          type: string
          description: The nextToken value returned from a ListAccountSettings request indicating that more results are available to fulfill the request and further calls will be 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 account setting results returned by ListAccountSettings in paginated output. When this parameter is used, ListAccountSettings 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 ListAccountSettings request with the returned nextToken value. This value can be between 1 and 10. If this parameter isn't used, then ListAccountSettings returns up to 10 results and a nextToken value if applicable.
    DeleteAccountSettingResponse:
      type: object
      properties:
        setting:
          $ref: '#/components/schemas/Setting'
    ClientException:
      type: object
      properties:
        message:
          type: string
          description: Message that describes the cause of the exception.
    DeleteAccountSettingRequest:
      type: object
      properties:
        name:
          type: string
          enum:
          - serviceLongArnFormat
          - taskLongArnFormat
          - containerInstanceLongArnFormat
          - awsvpcTrunking
          - containerInsights
          - fargateFIPSMode
          - tagResourceAuthorization
          - fargateTaskRetirementWaitPeriod
          - guardDutyActivate
          - defaultLogDriverMode
          - fargateEventWindows
          description: The resource name to disable the account setting for. If serviceLongArnFormat is specified, the ARN for your Amazon ECS services is affected. If taskLongArnFormat is specified, the ARN and resource ID for your Amazon ECS tasks is affected. If containerInstanceLongArnFormat is specified, the ARN and resource ID for your Amazon ECS container instances is affected. If awsvpcTrunking is specified, the ENI limit for your Amazon ECS container instances is affected.
        principalArn:
          type: string
          description: The Amazon Resource Name (ARN) of the principal. It can be a user, role, or the root user. If you specify the root user, it disables the account setting for all users, roles, and the root user of the account unless a user or role explicitly overrides these settings. If this field is omitted, the setting is changed only for the authenticated user. In order to use this parameter, you must be the root user, or the principal.
      required:
      - name
    PutAccountSettingRequest:
      type: object
      properties:
        name:
          type: string
          enum:
          - serviceLongArnFormat
          - taskLongArnFormat
          - containerInstanceLongArnFormat
          - awsvpcTrunking
          - containerInsights
          - fargateFIPSMode
          - tagResourceAuthorization
          - fargateTaskRetirementWaitPeriod
          - guardDutyActivate
          - defaultLogDriverMode
          - fargateEventWindows
          description: The Amazon ECS account setting name to modify. The following are the valid values for the account setting name. serviceLongArnFormat - When modified, the Amazon Resource Name (ARN) and resource ID format of the resource type for a specified user, role, or the root user for an account is affected. The opt-in and opt-out account setting must be set for each Amazon ECS resource separately. The ARN and resource ID format of a resource is defined by the opt-in status of the user or role that created the resource. You must turn on this setting to use Amazon ECS features such as resource tagging. tas
        value:
          type: string
          description: 'The account setting value for the specified principal ARN. Accepted values are enabled, disabled, enhanced, on, and off. When you specify fargateTaskRetirementWaitPeriod for the name, the following are the valid values: 0 - Amazon Web Services sends the notification, and immediately retires the affected tasks. 7 - Amazon Web Services sends the notification, and waits 7 calendar days to retire the tasks. 14 - Amazon Web Services sends the notification, and waits 14 calendar days to retire the tasks.'
        principalArn:
          type: string
          description: The ARN of the principal, which can be a user, role, or the root user. If you specify the root user, it modifies the account setting for all users, roles, and the root user of the account unless a user or role explicitly overrides these settings. If this field is omitted, the setting is changed only for the authenticated user. In order to use this parameter, you must be the root user, or the principal. You must use the root user when you set the Fargate wait time (fargateTaskRetirementWaitPeriod). Federated users assume the account setting of the root user and can't have explicit account setti
      required:
      - name
      - value
  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)