Class: Aws::Account::Types::ListRegionsRequest

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#account_id ⇒ String

Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access or modify with this operation. If you don’t specify this parameter, it defaults to the Amazon Web Services account of the identity used to call the operation. To use this parameter, the caller must be an identity in the

organization’s management account][1

or a delegated administrator

account. The specified account ID must be a member account in the same organization. The organization must have [all features enabled], and the organization must have [trusted access] enabled for the Account Management service, and optionally a

delegated admin][4

account assigned.

<note markdown=“1”> The management account can’t specify its own ‘AccountId`. It must call the operation in standalone context by not including the `AccountId` parameter.

</note>

To call this operation on an account that is not a member of an organization, don’t specify this parameter. Instead, call the operation using an identity belonging to the account whose contacts you wish to retrieve or modify.

[1]: docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#account [2]: docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html [3]: docs.aws.amazon.com/organizations/latest/userguide/using-orgs-trusted-access.html [4]: docs.aws.amazon.com/organizations/latest/userguide/using-orgs-delegated-admin.html

Returns:

  • (String) 


674
675
676
677
678
679
680
681
 
# File 'lib/aws-sdk-account/types.rb', line 674

class ListRegionsRequest < Struct.new(
  :account_id,
  :max_results,
  :next_token,
  :region_opt_status_contains)
  SENSITIVE = []
  include Aws::Structure
end

#max_results ⇒ Integer

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a ‘NextToken` is provided in the command’s output. To resume pagination, provide the `NextToken` value in the `starting-token` argument of a subsequent command. Do not use the `NextToken` response element directly outside of the Amazon Web Services CLI. For usage examples, see [Pagination] in the *Amazon Web Services Command Line Interface User Guide*.

[1]: docs.aws.amazon.com/cli/latest/userguide/pagination.html

Returns:

  • (Integer) 


674
675
676
677
678
679
680
681
 
# File 'lib/aws-sdk-account/types.rb', line 674

class ListRegionsRequest < Struct.new(
  :account_id,
  :max_results,
  :next_token,
  :region_opt_status_contains)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

A token used to specify where to start paginating. This is the ‘NextToken` from a previously truncated response. For usage examples, see [Pagination] in the *Amazon Web Services Command Line Interface User Guide*.

[1]: docs.aws.amazon.com/cli/latest/userguide/pagination.html

Returns:

  • (String) 


674
675
676
677
678
679
680
681
 
# File 'lib/aws-sdk-account/types.rb', line 674

class ListRegionsRequest < Struct.new(
  :account_id,
  :max_results,
  :next_token,
  :region_opt_status_contains)
  SENSITIVE = []
  include Aws::Structure
end

#region_opt_status_contains ⇒ Array<String>

A list of Region statuses (Enabling, Enabled, Disabling, Disabled, Enabled_by_default) to use to filter the list of Regions for a given account. For example, passing in a value of ENABLING will only return a list of Regions with a Region status of ENABLING.

Returns:

  • (Array<String>) 


674
675
676
677
678
679
680
681
 
# File 'lib/aws-sdk-account/types.rb', line 674

class ListRegionsRequest < Struct.new(
  :account_id,
  :max_results,
  :next_token,
  :region_opt_status_contains)
  SENSITIVE = []
  include Aws::Structure
end