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

Inherits:

Struct

• Object
• Struct
• Aws::ECS::Types::ListAccountSettingsRequest

Includes:

Structure

Defined in:

lib/aws-sdk-ecs/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #effective_settings ⇒ Boolean

  Determines whether to return the effective settings.

• #max_results ⇒ 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.

• #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.

• #principal_arn ⇒ String

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

• #value ⇒ String

  The value of the account settings to filter results with.

Instance Attribute Details

#effective_settings ⇒ Boolean

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.

Returns:

• (Boolean)

# File 'lib/aws-sdk-ecs/types.rb', line 5745

class ListAccountSettingsRequest < Struct.new(
  :name,
  :value,
  :principal_arn,
  :effective_settings,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#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 isn’t used, then ‘ListAccountSettings` returns up to 10 results and a `nextToken` value if applicable.

Returns:

• (Integer)

# File 'lib/aws-sdk-ecs/types.rb', line 5745

class ListAccountSettingsRequest < Struct.new(
  :name,
  :value,
  :principal_arn,
  :effective_settings,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-ecs/types.rb', line 5745

class ListAccountSettingsRequest < Struct.new(
  :name,
  :value,
  :principal_arn,
  :effective_settings,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#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’s possible the number of results to be fewer than ‘maxResults`.

<note markdown=“1”> 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>

Returns:

• (String)

# File 'lib/aws-sdk-ecs/types.rb', line 5745

class ListAccountSettingsRequest < Struct.new(
  :name,
  :value,
  :principal_arn,
  :effective_settings,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#principal_arn ⇒ String

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 markdown=“1”> Federated users assume the account setting of the root user and can’t have explicit account settings set for them.

</note>

Returns:

• (String)

# File 'lib/aws-sdk-ecs/types.rb', line 5745

class ListAccountSettingsRequest < Struct.new(
  :name,
  :value,
  :principal_arn,
  :effective_settings,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#value ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-ecs/types.rb', line 5745

class ListAccountSettingsRequest < Struct.new(
  :name,
  :value,
  :principal_arn,
  :effective_settings,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end