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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-ecs/types.rb

Overview

Note:

When making an API call, you may pass ListAccountSettingsRequest data as a hash:

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#effective_settingsBoolean

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)

5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
# File 'lib/aws-sdk-ecs/types.rb', line 5858

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

#max_resultsInteger

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)

5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
# File 'lib/aws-sdk-ecs/types.rb', line 5858

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

#nameString

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

Returns:

  • (String)

5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
# File 'lib/aws-sdk-ecs/types.rb', line 5858

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

#next_tokenString

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

<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)

5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
# File 'lib/aws-sdk-ecs/types.rb', line 5858

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

#principal_arnString

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.

<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)

5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
# File 'lib/aws-sdk-ecs/types.rb', line 5858

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

#valueString

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)

5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
# File 'lib/aws-sdk-ecs/types.rb', line 5858

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