Post x amz targetamazonec2containerservicev20141113.listaccountsettings

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1456373564.1 KB

Lists the account settings for a specified principal.

post/#X-Amz-Target=AmazonEC2ContainerServiceV20141113.ListAccountSettings

Query parameters

maxResultsstring

Pagination limit

nextTokenstring

Pagination token

Headers

X-Amz-Target'AmazonEC2ContainerServiceV20141113.ListAccountSettings' required

Request body

The name of the account setting you want to list the settings for.

valuestring

The value of the account settings to filter results with. You must also specify an account setting name to use this parameter.

principalArnstring

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. <note> Federated users assume the account setting of the root user and can't have explicit account settings set for them. </note>

effectiveSettingsboolean

Determines whether to return the effective settings. If <code>true</code>, the account settings for the root user or the default setting for the <code>principalArn</code> are returned. If <code>false</code>, the account settings for the <code>principalArn</code> are returned if they're set. Otherwise, no account settings are returned.

nextTokenstring

The <code>nextToken</code> value returned from a <code>ListAccountSettings</code> request indicating that more results are available to fulfill the request and further calls will be needed. If <code>maxResults</code> was provided, it's possible the number of results to be fewer than <code>maxResults</code>. <note> 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. </note>

maxResultsinteger

The maximum number of account setting results returned by <code>ListAccountSettings</code> in paginated output. When this parameter is used, <code>ListAccountSettings</code> only returns <code>maxResults</code> results in a single page along with a <code>nextToken</code> response element. The remaining results of the initial request can be seen by sending another <code>ListAccountSettings</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 10. If this parameter isn't used, then <code>ListAccountSettings</code> returns up to 10 results and a <code>nextToken</code> value if applicable.

Response

Success

nextTokenstring

The <code>nextToken</code> value to include in a future <code>ListAccountSettings</code> request. When the results of a <code>ListAccountSettings</code> request exceed <code>maxResults</code>, this value can be used to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.

Example response

{
  "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"
    }
  ]
}