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

Inherits:

Struct

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

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
  value: "String",
  principal_arn: "String",
  effective_settings: false,
  next_token: "String",
  max_results: 1,
}

See Also:

• AWS API Documentation

Instance Attribute Summary

• #effective_settings ⇒ Boolean

  Specifies 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 resource name you want to list the account settings for.

• #next_token ⇒ String

  The ‘nextToken` value returned from a previous paginated `ListAccountSettings` request where `maxResults` was used and the results exceeded the value of that parameter.

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

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`. If `false`, the account settings for the `principalArn` are returned if they are set. Otherwise, no account settings are returned.

Returns:

• (Boolean)

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

class ListAccountSettingsRequest < Struct.new(
  :name,
  :value,
  :principal_arn,
  :effective_settings,
  :next_token,
  :max_results)
  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 is not used, then `ListAccountSettings` returns up to 10 results and a `nextToken` value if applicable.

Returns:

• (Integer)

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

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

#name ⇒ String

The resource name you want to list the account settings for.

Returns:

• (String)

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

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

#next_token ⇒ String

The ‘nextToken` value returned from a previous paginated `ListAccountSettings` request where `maxResults` was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the `nextToken` value.

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

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

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

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

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

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

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

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