AWS Native

v0.42.0 published on Wednesday, Nov 23, 2022 by Pulumi

getAccount

You can use AWS::Organizations::Account to manage accounts in organization.

Using getAccount

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getAccount(args: GetAccountArgs, opts?: InvokeOptions): Promise<GetAccountResult>
function getAccountOutput(args: GetAccountOutputArgs, opts?: InvokeOptions): Output<GetAccountResult>
def get_account(account_id: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetAccountResult
def get_account_output(account_id: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetAccountResult]
func LookupAccount(ctx *Context, args *LookupAccountArgs, opts ...InvokeOption) (*LookupAccountResult, error)
func LookupAccountOutput(ctx *Context, args *LookupAccountOutputArgs, opts ...InvokeOption) LookupAccountResultOutput

> Note: This function is named LookupAccount in the Go SDK.

public static class GetAccount 
{
    public static Task<GetAccountResult> InvokeAsync(GetAccountArgs args, InvokeOptions? opts = null)
    public static Output<GetAccountResult> Invoke(GetAccountInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetAccountResult> getAccount(GetAccountArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
  function: aws-native:organizations:getAccount
  arguments:
    # arguments dictionary

The following arguments are supported:

AccountId string

If the account was created successfully, the unique identifier (ID) of the new account.

AccountId string

If the account was created successfully, the unique identifier (ID) of the new account.

accountId String

If the account was created successfully, the unique identifier (ID) of the new account.

accountId string

If the account was created successfully, the unique identifier (ID) of the new account.

account_id str

If the account was created successfully, the unique identifier (ID) of the new account.

accountId String

If the account was created successfully, the unique identifier (ID) of the new account.

getAccount Result

The following output properties are available:

AccountId string

If the account was created successfully, the unique identifier (ID) of the new account.

AccountName string

The friendly name of the member account.

Arn string

The Amazon Resource Name (ARN) of the account.

Email string

The email address of the owner to assign to the new member account.

JoinedMethod Pulumi.AwsNative.Organizations.AccountJoinedMethod

The method by which the account joined the organization.

JoinedTimestamp string

The date the account became a part of the organization.

ParentIds List<string>

List of parent nodes for the member account. Currently only one parent at a time is supported. Default is root.

Status Pulumi.AwsNative.Organizations.AccountStatus

The status of the account in the organization.

Tags List<Pulumi.AwsNative.Organizations.Outputs.AccountTag>

A list of tags that you want to attach to the newly created account. For each tag in the list, you must specify both a tag key and a value.

AccountId string

If the account was created successfully, the unique identifier (ID) of the new account.

AccountName string

The friendly name of the member account.

Arn string

The Amazon Resource Name (ARN) of the account.

Email string

The email address of the owner to assign to the new member account.

JoinedMethod AccountJoinedMethod

The method by which the account joined the organization.

JoinedTimestamp string

The date the account became a part of the organization.

ParentIds []string

List of parent nodes for the member account. Currently only one parent at a time is supported. Default is root.

Status AccountStatus

The status of the account in the organization.

Tags []AccountTag

A list of tags that you want to attach to the newly created account. For each tag in the list, you must specify both a tag key and a value.

accountId String

If the account was created successfully, the unique identifier (ID) of the new account.

accountName String

The friendly name of the member account.

arn String

The Amazon Resource Name (ARN) of the account.

email String

The email address of the owner to assign to the new member account.

joinedMethod AccountJoinedMethod

The method by which the account joined the organization.

joinedTimestamp String

The date the account became a part of the organization.

parentIds List<String>

List of parent nodes for the member account. Currently only one parent at a time is supported. Default is root.

status AccountStatus

The status of the account in the organization.

tags List<AccountTag>

A list of tags that you want to attach to the newly created account. For each tag in the list, you must specify both a tag key and a value.

accountId string

If the account was created successfully, the unique identifier (ID) of the new account.

accountName string

The friendly name of the member account.

arn string

The Amazon Resource Name (ARN) of the account.

email string

The email address of the owner to assign to the new member account.

joinedMethod AccountJoinedMethod

The method by which the account joined the organization.

joinedTimestamp string

The date the account became a part of the organization.

parentIds string[]

List of parent nodes for the member account. Currently only one parent at a time is supported. Default is root.

status AccountStatus

The status of the account in the organization.

tags AccountTag[]

A list of tags that you want to attach to the newly created account. For each tag in the list, you must specify both a tag key and a value.

account_id str

If the account was created successfully, the unique identifier (ID) of the new account.

account_name str

The friendly name of the member account.

arn str

The Amazon Resource Name (ARN) of the account.

email str

The email address of the owner to assign to the new member account.

joined_method AccountJoinedMethod

The method by which the account joined the organization.

joined_timestamp str

The date the account became a part of the organization.

parent_ids Sequence[str]

List of parent nodes for the member account. Currently only one parent at a time is supported. Default is root.

status AccountStatus

The status of the account in the organization.

tags Sequence[AccountTag]

A list of tags that you want to attach to the newly created account. For each tag in the list, you must specify both a tag key and a value.

accountId String

If the account was created successfully, the unique identifier (ID) of the new account.

accountName String

The friendly name of the member account.

arn String

The Amazon Resource Name (ARN) of the account.

email String

The email address of the owner to assign to the new member account.

joinedMethod "INVITED" | "CREATED"

The method by which the account joined the organization.

joinedTimestamp String

The date the account became a part of the organization.

parentIds List<String>

List of parent nodes for the member account. Currently only one parent at a time is supported. Default is root.

status "ACTIVE" | "SUSPENDED" | "PENDING_CLOSURE"

The status of the account in the organization.

tags List<Property Map>

A list of tags that you want to attach to the newly created account. For each tag in the list, you must specify both a tag key and a value.

Supporting Types

AccountJoinedMethod

AccountStatus

AccountTag

Key string

The key identifier, or name, of the tag.

Value string

The string value that's associated with the key of the tag. You can set the value of a tag to an empty string, but you can't set the value of a tag to null.

Key string

The key identifier, or name, of the tag.

Value string

The string value that's associated with the key of the tag. You can set the value of a tag to an empty string, but you can't set the value of a tag to null.

key String

The key identifier, or name, of the tag.

value String

The string value that's associated with the key of the tag. You can set the value of a tag to an empty string, but you can't set the value of a tag to null.

key string

The key identifier, or name, of the tag.

value string

The string value that's associated with the key of the tag. You can set the value of a tag to an empty string, but you can't set the value of a tag to null.

key str

The key identifier, or name, of the tag.

value str

The string value that's associated with the key of the tag. You can set the value of a tag to an empty string, but you can't set the value of a tag to null.

key String

The key identifier, or name, of the tag.

value String

The string value that's associated with the key of the tag. You can set the value of a tag to an empty string, but you can't set the value of a tag to null.

Package Details

Repository
https://github.com/pulumi/pulumi-aws-native
License
Apache-2.0