You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::ECS::Types::ListAccountSettingsRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing ListAccountSettingsRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  name: "serviceLongArnFormat", # accepts serviceLongArnFormat, taskLongArnFormat, containerInstanceLongArnFormat, awsvpcTrunking, containerInsights
  value: "String",
  principal_arn: "String",
  effective_settings: false,
  next_token: "String",
  max_results: 1,
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#effective_settings ⇒ Boolean

Specifies 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 are set. Otherwise, no account settings are returned.

Returns:

  • (Boolean) —

    Specifies whether to return the effective settings.

#max_results ⇒ Integer

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 is not used, then ListAccountSettings returns up to 10 results and a nextToken value if applicable.

Returns:

  • (Integer) —

    The maximum number of account setting results returned by ListAccountSettings in paginated output.

#name ⇒ String

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

Possible values:

  • serviceLongArnFormat
  • taskLongArnFormat
  • containerInstanceLongArnFormat
  • awsvpcTrunking
  • containerInsights

Returns:

  • (String) —

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

#next_token ⇒ String

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 is 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.

Returns:

  • (String) —

    The nextToken value returned from a ListAccountSettings request indicating that more results are available to fulfill the request and further calls will be needed.

#principal_arn ⇒ String

The ARN of the principal, which can be an IAM user, IAM role, or the root user. If this field is omitted, the account settings are listed only for the authenticated user.

Returns:

  • (String) —

    The ARN of the principal, which can be an IAM user, IAM role, or the root user.

#value ⇒ String

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

Returns:

  • (String) —

    The value of the account settings with which to filter results.