@aws-sdk/client-account

import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client"; import { AccountServiceException as __BaseException } from "./AccountServiceException"; /** * @public */ export interface AcceptPrimaryEmailUpdateRequest { /** * Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access * or modify with this operation. To use this parameter, the caller must be an identity in * the <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#account">organization's * management account</a> or a delegated administrator account. The specified * account ID must be a member account in the same organization. The organization must have * <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html">all features * enabled</a>, and the organization must have <a href="https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-trusted-access.html">trusted access</a> enabled * for the Account Management service, and optionally a <a href="https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-delegated-admin.html">delegated admin</a> account * assigned. * This operation can only be called from the management account or the delegated * administrator account of an organization for a member account. * <note> * The management account can't specify its own <code>AccountId</code>. * </note> * @public */ AccountId: string | undefined; /** * The new primary email address for use with the specified account. This must * match the <code>PrimaryEmail</code> from the <code>StartPrimaryEmailUpdate</code> API * call. * @public */ PrimaryEmail: string | undefined; /** * The OTP code sent to the <code>PrimaryEmail</code> specified on the * <code>StartPrimaryEmailUpdate</code> API call. * @public */ Otp: string | undefined; } /** * @public * @enum */ export declare const PrimaryEmailUpdateStatus: { readonly ACCEPTED: "ACCEPTED"; readonly PENDING: "PENDING"; }; /** * @public */ export type PrimaryEmailUpdateStatus = (typeof PrimaryEmailUpdateStatus)[keyof typeof PrimaryEmailUpdateStatus]; /** * @public */ export interface AcceptPrimaryEmailUpdateResponse { /** * Retrieves the status of the accepted primary email update request. * @public */ Status?: PrimaryEmailUpdateStatus | undefined; } /** * The operation failed because the calling identity doesn't have the minimum required * permissions. * @public */ export declare class AccessDeniedException extends __BaseException { readonly name: "AccessDeniedException"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>); } /** * The request could not be processed because of a conflict in the current status of the * resource. For example, this happens if you try to enable a Region that is currently being disabled * (in a status of DISABLING). * @public */ export declare class ConflictException extends __BaseException { readonly name: "ConflictException"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>); } /** * The operation failed because of an error internal to Amazon Web Services. Try your operation again * later. * @public */ export declare class InternalServerException extends __BaseException { readonly name: "InternalServerException"; readonly $fault: "server"; $retryable: {}; /** * @internal */ constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>); } /** * The operation failed because it specified a resource that can't be found. * @public */ export declare class ResourceNotFoundException extends __BaseException { readonly name: "ResourceNotFoundException"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>); } /** * The operation failed because it was called too frequently and exceeded a throttle * limit. * @public */ export declare class TooManyRequestsException extends __BaseException { readonly name: "TooManyRequestsException"; readonly $fault: "client"; $retryable: { throttling: boolean; }; /** * @internal */ constructor(opts: __ExceptionOptionType<TooManyRequestsException, __BaseException>); } /** * The input failed to meet the constraints specified by the Amazon Web Services service in a specified field. * @public */ export interface ValidationExceptionField { /** * The field name where the invalid entry was detected. * @public */ name: string | undefined; /** * A message about the validation exception. * @public */ message: string | undefined; } /** * @public * @enum */ export declare const ValidationExceptionReason: { readonly FIELD_VALIDATION_FAILED: "fieldValidationFailed"; readonly INVALID_REGION_OPT_TARGET: "invalidRegionOptTarget"; }; /** * @public */ export type ValidationExceptionReason = (typeof ValidationExceptionReason)[keyof typeof ValidationExceptionReason]; /** * The operation failed because one of the input parameters was invalid. * @public */ export declare class ValidationException extends __BaseException { readonly name: "ValidationException"; readonly $fault: "client"; /** * The reason that validation failed. * @public */ reason?: ValidationExceptionReason | undefined; /** * The field where the invalid entry was detected. * @public */ fieldList?: ValidationExceptionField[] | undefined; /** * @internal */ constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>); } /** * @public * @enum */ export declare const AlternateContactType: { readonly BILLING: "BILLING"; readonly OPERATIONS: "OPERATIONS"; readonly SECURITY: "SECURITY"; }; /** * @public */ export type AlternateContactType = (typeof AlternateContactType)[keyof typeof AlternateContactType]; /** * @public */ export interface DeleteAlternateContactRequest { /** * Specifies which of the alternate contacts to delete. * @public */ AlternateContactType: AlternateContactType | undefined; /** * 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 do not 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 <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#account">organization's management account</a> or a delegated administrator account, and * the specified account ID must be a member account in the same organization. The * organization must have <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html">all features * enabled</a>, and the organization must have <a href="https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-trusted-access.html">trusted access</a> enabled for the * Account Management service, and optionally a <a href="https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-delegated-admin.html">delegated admin</a> account * assigned. * <note> * The management account can't specify its own <code>AccountId</code>; it must call * the operation in standalone context by not including the <code>AccountId</code> * parameter. * </note> * To call this operation on an account that is not a member of an organization, then * don't specify this parameter, and call the operation using an identity belonging to * the account whose contacts you wish to retrieve or modify. * @public */ AccountId?: string | undefined; } /** * @public */ export interface GetAlternateContactRequest { /** * Specifies which alternate contact you want to retrieve. * @public */ AlternateContactType: AlternateContactType | undefined; /** * 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 do not 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 <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#account">organization's management account</a> or a delegated administrator account, and * the specified account ID must be a member account in the same organization. The * organization must have <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html">all features * enabled</a>, and the organization must have <a href="https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-trusted-access.html">trusted access</a> enabled for the * Account Management service, and optionally a <a href="https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-delegated-admin.html">delegated admin</a> account * assigned. * <note> * The management account can't specify its own <code>AccountId</code>; it must call * the operation in standalone context by not including the <code>AccountId</code> * parameter. * </note> * To call this operation on an account that is not a member of an organization, then * don't specify this parameter, and call the operation using an identity belonging to * the account whose contacts you wish to retrieve or modify. * @public */ AccountId?: string | undefined; } /** * A structure that contains the details of an alternate contact associated with an Amazon Web Services * account * @public */ export interface AlternateContact { /** * The name associated with this alternate contact. * @public */ Name?: string | undefined; /** * The title associated with this alternate contact. * @public */ Title?: string | undefined; /** * The email address associated with this alternate contact. * @public */ EmailAddress?: string | undefined; /** * The phone number associated with this alternate contact. * @public */ PhoneNumber?: string | undefined; /** * The type of alternate contact. * @public */ AlternateContactType?: AlternateContactType | undefined; } /** * @public */ export interface GetAlternateContactResponse { /** * A structure that contains the details for the specified alternate contact. * @public */ AlternateContact?: AlternateContact | undefined; } /** * @public */ export interface PutAlternateContactRequest { /** * Specifies a name for the alternate contact. * @public */ Name: string | undefined; /** * Specifies a title for the alternate contact. * @public */ Title: string | undefined; /** * Specifies an email address for the alternate contact. * @public */ EmailAddress: string | undefined; /** * Specifies a phone number for the alternate contact. * @public */ PhoneNumber: string | undefined; /** * Specifies which alternate contact you want to create or update. * @public */ AlternateContactType: AlternateContactType | undefined; /** * 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 do not 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 <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#account">organization's management account</a> or a delegated administrator account, and * the specified account ID must be a member account in the same organization. The * organization must have <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html">all features * enabled</a>, and the organization must have <a href="https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-trusted-access.html">trusted access</a> enabled for the * Account Management service, and optionally a <a href="https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-delegated-admin.html">delegated admin</a> account * assigned. * <note> * The management account can't specify its own <code>AccountId</code>; it must call * the operation in standalone context by not including the <code>AccountId</code> * parameter. * </note> * To call this operation on an account that is not a member of an organization, then * don't specify this parameter, and call the operation using an identity belonging to * the account whose contacts you wish to retrieve or modify. * @public */ AccountId?: string | undefined; } /** * @public */ export interface GetContactInformationRequest { /** * 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 <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#account">organization's * management account</a> or a delegated administrator account. The specified * account ID must be a member account in the same organization. The organization must have * <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html">all features * enabled</a>, and the organization must have <a href="https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-trusted-access.html">trusted access</a> enabled * for the Account Management service, and optionally a <a href="https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-delegated-admin.html">delegated admin</a> account * assigned. * <note> * The management account can't specify its own <code>AccountId</code>. It must call * the operation in standalone context by not including the <code>AccountId</code> * 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. * @public */ AccountId?: string | undefined; } /** * Contains the details of the primary contact information associated with an * Amazon Web Services account. * @public */ export interface ContactInformation { /** * The full name of the primary contact address. * @public */ FullName: string | undefined; /** * The first line of the primary contact address. * @public */ AddressLine1: string | undefined; /** * The second line of the primary contact address, if any. * @public */ AddressLine2?: string | undefined; /** * The third line of the primary contact address, if any. * @public */ AddressLine3?: string | undefined; /** * The city of the primary contact address. * @public */ City: string | undefined; /** * The state or region of the primary contact address. If the mailing address is within the United States (US), the * value in this field can be either a two character state code (for example, <code>NJ</code>) or the full state name * (for example, <code>New Jersey</code>). This field is required in the following countries: <code>US</code>, * <code>CA</code>, <code>GB</code>, <code>DE</code>, <code>JP</code>, <code>IN</code>, * and <code>BR</code>. * @public */ StateOrRegion?: string | undefined; /** * The district or county of the primary contact address, if any. * @public */ DistrictOrCounty?: string | undefined; /** * The postal code of the primary contact address. * @public */ PostalCode: string | undefined; /** * The ISO-3166 two-letter country code for the primary contact address. * @public */ CountryCode: string | undefined; /** * The phone number of the primary contact information. The number will be validated and, * in some countries, checked for activation. * @public */ PhoneNumber: string | undefined; /** * The name of the company associated with the primary contact information, if * any. * @public */ CompanyName?: string | undefined; /** * The URL of the website associated with the primary contact information, if any. * @public */ WebsiteUrl?: string | undefined; } /** * @public */ export interface GetContactInformationResponse { /** * Contains the details of the primary contact information associated with an * Amazon Web Services account. * @public */ ContactInformation?: ContactInformation | undefined; } /** * @public */ export interface PutContactInformationRequest { /** * Contains the details of the primary contact information associated with an * Amazon Web Services account. * @public */ ContactInformation: ContactInformation | undefined; /** * 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 <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#account">organization's * management account</a> or a delegated administrator account. The specified * account ID must be a member account in the same organization. The organization must have * <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html">all features * enabled</a>, and the organization must have <a href="https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-trusted-access.html">trusted access</a> enabled * for the Account Management service, and optionally a <a href="https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-delegated-admin.html">delegated admin</a> account * assigned. * <note> * The management account can't specify its own <code>AccountId</code>. It must call * the operation in standalone context by not including the <code>AccountId</code> * 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. * @public */ AccountId?: string | undefined; } /** * @public */ export interface GetPrimaryEmailRequest { /** * Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access * or modify with this operation. To use this parameter, the caller must be an identity in * the <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#account">organization's * management account</a> or a delegated administrator account. The specified * account ID must be a member account in the same organization. The organization must have * <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html">all features * enabled</a>, and the organization must have <a href="https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-trusted-access.html">trusted access</a> enabled * for the Account Management service, and optionally a <a href="https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-delegated-admin.html">delegated admin</a> account * assigned. * This operation can only be called from the management account or the delegated * administrator account of an organization for a member account. * <note> * The management account can't specify its own <code>AccountId</code>. * </note> * @public */ AccountId: string | undefined; } /** * @public */ export interface GetPrimaryEmailResponse { /** * Retrieves the primary email address associated with the specified * account. * @public */ PrimaryEmail?: string | undefined; } /** * @public */ export interface StartPrimaryEmailUpdateRequest { /** * Specifies the 12-digit account ID number of the Amazon Web Services account that you want to access * or modify with this operation. To use this parameter, the caller must be an identity in * the <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#account">organization's * management account</a> or a delegated administrator account. The specified * account ID must be a member account in the same organization. The organization must have * <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html">all features * enabled</a>, and the organization must have <a href="https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-trusted-access.html">trusted access</a> enabled * for the Account Management service, and optionally a <a href="https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-delegated-admin.html">delegated admin</a> account * assigned. * This operation can only be called from the management account or the delegated * administrator account of an organization for a member account. * <note> * The management account can't specify its own <code>AccountId</code>. * </note> * @public */ AccountId: string | undefined; /** * The new primary email address (also known as the root user email address) to * use in the specified account. * @public */ PrimaryEmail: string | undefined; } /** * @public */ export interface StartPrimaryEmailUpdateResponse { /** * The status of the primary email update request. * @public */ Status?: PrimaryEmailUpdateStatus | undefined; } /** * @public */ export interface DisableRegionRequest { /** * 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 <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#account">organization's * management account</a> or a delegated administrator account. The specified * account ID must be a member account in the same organization. The organization must have * <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html">all features * enabled</a>, and the organization must have <a href="https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-trusted-access.html">trusted access</a> enabled * for the Account Management service, and optionally a <a href="https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-delegated-admin.html">delegated admin</a> account * assigned. * <note> * The management account can't specify its own <code>AccountId</code>. It must call * the operation in standalone context by not including the <code>AccountId</code> * 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. * @public */ AccountId?: string | undefined; /** * Specifies the Region-code for a given Region name (for example, * <code>af-south-1</code>). When you disable a Region, Amazon Web Services performs actions to * deactivate that Region in your account, such as destroying IAM resources in the Region. * This process takes a few minutes for most accounts, but this can take several hours. You * cannot enable the Region until the disabling process is fully completed. * @public */ RegionName: string | undefined; } /** * @public */ export interface EnableRegionRequest { /** * 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 <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#account">organization's * management account</a> or a delegated administrator account. The specified * account ID must be a member account in the same organization. The organization must have * <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html">all features * enabled</a>, and the organization must have <a href="https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-trusted-access.html">trusted access</a> enabled * for the Account Management service, and optionally a <a href="https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-delegated-admin.html">delegated admin</a> account * assigned. * <note> * The management account can't specify its own <code>AccountId</code>. It must call * the operation in standalone context by not including the <code>AccountId</code> * 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. * @public */ AccountId?: string | undefined; /** * Specifies the Region-code for a given Region name (for example, * <code>af-south-1</code>). When you enable a Region, Amazon Web Services performs actions to * prepare your account in that Region, such as distributing your IAM resources to the * Region. This process takes a few minutes for most accounts, but it can take several * hours. You cannot use the Region until this process is complete. Furthermore, you cannot * disable the Region until the enabling process is fully completed. * @public */ RegionName: string | undefined; } /** * @public */ export interface GetRegionOptStatusRequest { /** * 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 <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#account">organization's * management account</a> or a delegated administrator account. The specified * account ID must be a member account in the same organization. The organization must have * <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html">all features * enabled</a>, and the organization must have <a href="https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-trusted-access.html">trusted access</a> enabled * for the Account Management service, and optionally a <a href="https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-delegated-admin.html">delegated admin</a> account * assigned. * <note> * The management account can't specify its own <code>AccountId</code>. It must call * the operation in standalone context by not including the <code>AccountId</code> * 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. * @public */ AccountId?: string | undefined; /** * Specifies the Region-code for a given Region name (for example, * <code>af-south-1</code>). This function will return the status of whatever Region * you pass into this parameter. * @public */ RegionName: string | undefined; } /** * @public * @enum */ export declare const RegionOptStatus: { readonly DISABLED: "DISABLED"; readonly DISABLING: "DISABLING"; readonly ENABLED: "ENABLED"; readonly ENABLED_BY_DEFAULT: "ENABLED_BY_DEFAULT"; readonly ENABLING: "ENABLING"; }; /** * @public */ export type RegionOptStatus = (typeof RegionOptStatus)[keyof typeof RegionOptStatus]; /** * @public */ export interface GetRegionOptStatusResponse { /** * The Region code that was passed in. * @public */ RegionName?: string | undefined; /** * One of the potential statuses a Region can undergo (Enabled, Enabling, Disabled, * Disabling, Enabled_By_Default). * @public */ RegionOptStatus?: RegionOptStatus | undefined; } /** * @public */ export interface ListRegionsRequest { /** * 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 <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_getting-started_concepts.html#account">organization's * management account</a> or a delegated administrator account. The specified * account ID must be a member account in the same organization. The organization must have * <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_org_support-all-features.html">all features * enabled</a>, and the organization must have <a href="https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-trusted-access.html">trusted access</a> enabled * for the Account Management service, and optionally a <a href="https://docs.aws.amazon.com/organizations/latest/userguide/using-orgs-delegated-admin.html">delegated admin</a> account * assigned. * <note> * The management account can't specify its own <code>AccountId</code>. It must call * the operation in standalone context by not including the <code>AccountId</code> * 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. * @public */ AccountId?: string | undefined; /** * 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 <code>NextToken</code> is provided * in the command’s output. To resume pagination, provide the <code>NextToken</code> value * in the <code>starting-token</code> argument of a subsequent command. Do not use the * <code>NextToken</code> response element directly outside of the Amazon Web Services CLI. For usage * examples, see <a href="http://docs.aws.amazon.com/cli/latest/userguide/pagination.html">Pagination</a> in the Amazon Web Services Command Line Interface User * Guide. * @public */ MaxResults?: number | undefined; /** * A token used to specify where to start paginating. This is the <code>NextToken</code> * from a previously truncated response. For usage examples, see <a href="http://docs.aws.amazon.com/cli/latest/userguide/pagination.html">Pagination</a> in the * Amazon Web Services Command Line Interface User Guide. * @public */ NextToken?: string | undefined; /** * 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. * @public */ RegionOptStatusContains?: RegionOptStatus[] | undefined; } /** * This is a structure that expresses the Region for a given account, consisting of a * name and opt-in status. * @public */ export interface Region { /** * The Region code of a given Region (for example, <code>us-east-1</code>). * @public */ RegionName?: string | undefined; /** * One of potential statuses a Region can undergo (Enabled, Enabling, Disabled, * Disabling, Enabled_By_Default). * @public */ RegionOptStatus?: RegionOptStatus | undefined; } /** * @public */ export interface ListRegionsResponse { /** * If there is more data to be returned, this will be populated. It should be passed into * the <code>next-token</code> request parameter of <code>list-regions</code>. * @public */ NextToken?: string | undefined; /** * This is a list of Regions for a given account, or if the filtered parameter was used, * a list of Regions that match the filter criteria set in the <code>filter</code> * parameter. * @public */ Regions?: Region[] | undefined; } /** * @internal */ export declare const AcceptPrimaryEmailUpdateRequestFilterSensitiveLog: (obj: AcceptPrimaryEmailUpdateRequest) => any; /** * @internal */ export declare const ValidationExceptionFieldFilterSensitiveLog: (obj: ValidationExceptionField) => any; /** * @internal */ export declare const AlternateContactFilterSensitiveLog: (obj: AlternateContact) => any; /** * @internal */ export declare const GetAlternateContactResponseFilterSensitiveLog: (obj: GetAlternateContactResponse) => any; /** * @internal */ export declare const PutAlternateContactRequestFilterSensitiveLog: (obj: PutAlternateContactRequest) => any; /** * @internal */ export declare const ContactInformationFilterSensitiveLog: (obj: ContactInformation) => any; /** * @internal */ export declare const GetContactInformationResponseFilterSensitiveLog: (obj: GetContactInformationResponse) => any; /** * @internal */ export declare const PutContactInformationRequestFilterSensitiveLog: (obj: PutContactInformationRequest) => any; /** * @internal */ export declare const GetPrimaryEmailResponseFilterSensitiveLog: (obj: GetPrimaryEmailResponse) => any; /** * @internal */ export declare const StartPrimaryEmailUpdateRequestFilterSensitiveLog: (obj: StartPrimaryEmailUpdateRequest) => any;