Class: Aws::Account::Types::GetRegionOptStatusRequest

Inherits:

Struct

Object
Struct
Aws::Account::Types::GetRegionOptStatusRequest

show all

Includes:: Structure

Defined in:: lib/aws-sdk-account/types.rb

Overview

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#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.
#region_name ⇒ String

Specifies the Region-code for a given Region name (for example, ‘af-south-1`).

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)

# File 'lib/aws-sdk-account/types.rb', line 568

class GetRegionOptStatusRequest < Struct.new(
  :account_id,
  :region_name)
  SENSITIVE = []
  include Aws::Structure
end

#region_name ⇒ `String`

Specifies the Region-code for a given Region name (for example, ‘af-south-1`). This function will return the status of whatever Region you pass into this parameter.