ListAccountSettings
Lists the account settings for a specified principal.
Request Syntax
{
"effectiveSettings": boolean
,
"maxResults": number
,
"name": "string
",
"nextToken": "string
",
"principalArn": "string
",
"value": "string
"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- effectiveSettings
-
Determines whether to return the effective settings. If
true
, the account settings for the root user or the default setting for theprincipalArn
are returned. Iffalse
, the account settings for theprincipalArn
are returned if they're set. Otherwise, no account settings are returned.Type: Boolean
Required: No
- maxResults
-
The maximum number of account setting results returned by
ListAccountSettings
in paginated output. When this parameter is used,ListAccountSettings
only returnsmaxResults
results in a single page along with anextToken
response element. The remaining results of the initial request can be seen by sending anotherListAccountSettings
request with the returnednextToken
value. This value can be between 1 and 10. If this parameter isn't used, thenListAccountSettings
returns up to 10 results and anextToken
value if applicable.Type: Integer
Required: No
- name
-
The name of the account setting you want to list the settings for.
Type: String
Valid Values:
serviceLongArnFormat | taskLongArnFormat | containerInstanceLongArnFormat | awsvpcTrunking | containerInsights | fargateFIPSMode | tagResourceAuthorization | fargateTaskRetirementWaitPeriod | guardDutyActivate
Required: No
- nextToken
-
The
nextToken
value returned from aListAccountSettings
request indicating that more results are available to fulfill the request and further calls will be needed. IfmaxResults
was provided, it's possible the number of results to be fewer thanmaxResults
.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.
Type: String
Required: No
- principalArn
-
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.
Type: String
Required: No
- value
-
The value of the account settings to filter results with. You must also specify an account setting name to use this parameter.
Type: String
Required: No
Response Syntax
{
"nextToken": "string",
"settings": [
{
"name": "string",
"principalArn": "string",
"type": "string",
"value": "string"
}
]
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- nextToken
-
The
nextToken
value to include in a futureListAccountSettings
request. When the results of aListAccountSettings
request exceedmaxResults
, this value can be used to retrieve the next page of results. This value isnull
when there are no more results to return.Type: String
- settings
-
The account settings for the resource.
Type: Array of Setting objects
Errors
For information about the errors that are common to all actions, see Common Errors.
- ClientException
-
These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.
The following list includes additional causes for the error:
-
The
RunTask
could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in thePROVISIONING
per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.
HTTP Status Code: 400
-
- InvalidParameterException
-
The specified parameter isn't valid. Review the available parameters for the API request.
HTTP Status Code: 400
- ServerException
-
These errors are usually caused by a server issue.
HTTP Status Code: 500
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: