ListAccountSettingsRequest Class | AWS SDK for .NET V3

Container for the parameters to the ListAccountSettings operation. Lists the account settings for a specified principal.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.ECS.AmazonECSRequest
      Amazon.ECS.Model.ListAccountSettingsRequest

Namespace: Amazon.ECS.Model
Assembly: AWSSDK.ECS.dll
Version: 3.x.y.z

Syntax

public class ListAccountSettingsRequest : AmazonECSRequest
         IAmazonWebServiceRequest

The ListAccountSettingsRequest type exposes the following members

Constructors

	Name	Description
	ListAccountSettingsRequest()

Properties

Name	Type	Description
EffectiveSettings	System.Boolean	Gets and sets the property EffectiveSettings. 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.
MaxResults	System.Int32	Gets and sets the property MaxResults. 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.
Name	Amazon.ECS.SettingName	Gets and sets the property Name. The name of the account setting you want to list the settings for.
NextToken	System.String	Gets and sets the property NextToken. 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.
PrincipalArn	System.String	Gets and sets the property 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. 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.
Value	System.String	Gets and sets the property Value. The value of the account settings to filter results with. You must also specify an account setting name to use this parameter.

Examples

This example displays the effective account settings for your account.

To view your effective account settings


var client = new AmazonECSClient();
var response = client.ListAccountSettings(new ListAccountSettingsRequest 
{
    EffectiveSettings = true
});

List<Setting> settings = response.Settings;

This example displays the effective account settings for the specified user or role.

To view the effective account settings for a specific IAM user or IAM role


var client = new AmazonECSClient();
var response = client.ListAccountSettings(new ListAccountSettingsRequest 
{
    EffectiveSettings = true,
    PrincipalArn = "arn:aws:iam::<aws_account_id>:user/principalName"
});

List<Setting> settings = response.Settings;

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5