libZSservicesZSamazonka-accountZSamazonka-account
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Account

Description

Derived from API version 2021-02-01 of the AWS service descriptions, licensed under Apache 2.0.

Operations for Amazon Web Services Account Management

Synopsis

Service Configuration

defaultService :: Service Source #

API version 2021-02-01 of the Amazon Account SDK configuration.

Errors

Error matchers are designed for use with the functions provided by Control.Exception.Lens. This allows catching (and rethrowing) service specific errors returned by Account.

ValidationException

_ValidationException :: AsError a => Getting (First ServiceError) a ServiceError Source #

The operation failed because one of the input parameters was invalid.

AccessDeniedException

_AccessDeniedException :: AsError a => Getting (First ServiceError) a ServiceError Source #

The operation failed because the calling identity doesn't have the minimum required permissions.

TooManyRequestsException

_TooManyRequestsException :: AsError a => Getting (First ServiceError) a ServiceError Source #

The operation failed because it was called too frequently and exceeded a throttle limit.

InternalServerException

_InternalServerException :: AsError a => Getting (First ServiceError) a ServiceError Source #

The operation failed because of an error internal to Amazon Web Services. Try your operation again later.

ResourceNotFoundException

_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #

The operation failed because it specified a resource that can't be found.

Waiters

Waiters poll by repeatedly sending a request until some remote success condition configured by the Wait specification is fulfilled. The Wait specification determines how many attempts should be made, in addition to delay and retry strategies.

Operations

Some AWS operations return results that are incomplete and require subsequent requests in order to obtain the entire result set. The process of sending subsequent requests to continue where a previous request left off is called pagination. For example, the ListObjects operation of Amazon S3 returns up to 1000 objects at a time, and you must send subsequent requests with the appropriate Marker in order to retrieve the next page of results.

Operations that have an AWSPager instance can transparently perform subsequent requests, correctly setting Markers and other request facets to iterate through the entire result set of a truncated API operation. Operations which support this have an additional note in the documentation.

Many operations have the ability to filter results on the server side. See the individual operation parameters for details.

DeleteAlternateContact

data DeleteAlternateContact Source #

See: newDeleteAlternateContact smart constructor.

Instances

Instances details
Eq DeleteAlternateContact Source # 
Instance details

Defined in Amazonka.Account.DeleteAlternateContact

Read DeleteAlternateContact Source # 
Instance details

Defined in Amazonka.Account.DeleteAlternateContact

Show DeleteAlternateContact Source # 
Instance details

Defined in Amazonka.Account.DeleteAlternateContact

Generic DeleteAlternateContact Source # 
Instance details

Defined in Amazonka.Account.DeleteAlternateContact

Associated Types

type Rep DeleteAlternateContact :: Type -> Type #

NFData DeleteAlternateContact Source # 
Instance details

Defined in Amazonka.Account.DeleteAlternateContact

Methods

rnf :: DeleteAlternateContact -> () #

Hashable DeleteAlternateContact Source # 
Instance details

Defined in Amazonka.Account.DeleteAlternateContact

ToJSON DeleteAlternateContact Source # 
Instance details

Defined in Amazonka.Account.DeleteAlternateContact

AWSRequest DeleteAlternateContact Source # 
Instance details

Defined in Amazonka.Account.DeleteAlternateContact

Associated Types

type AWSResponse DeleteAlternateContact #

ToHeaders DeleteAlternateContact Source # 
Instance details

Defined in Amazonka.Account.DeleteAlternateContact

ToPath DeleteAlternateContact Source # 
Instance details

Defined in Amazonka.Account.DeleteAlternateContact

ToQuery DeleteAlternateContact Source # 
Instance details

Defined in Amazonka.Account.DeleteAlternateContact

type Rep DeleteAlternateContact Source # 
Instance details

Defined in Amazonka.Account.DeleteAlternateContact

type Rep DeleteAlternateContact = D1 ('MetaData "DeleteAlternateContact" "Amazonka.Account.DeleteAlternateContact" "libZSservicesZSamazonka-accountZSamazonka-account" 'False) (C1 ('MetaCons "DeleteAlternateContact'" 'PrefixI 'True) (S1 ('MetaSel ('Just "accountId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "alternateContactType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 AlternateContactType)))
type AWSResponse DeleteAlternateContact Source # 
Instance details

Defined in Amazonka.Account.DeleteAlternateContact

newDeleteAlternateContact Source #

Create a value of DeleteAlternateContact with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:accountId:DeleteAlternateContact', deleteAlternateContact_accountId - 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 organization's management account or a delegated administrator account, and 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 account assigned.

The management account can't specify its own AccountId; it must call the operation in standalone context by not including the AccountId parameter.

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.

$sel:alternateContactType:DeleteAlternateContact', deleteAlternateContact_alternateContactType - Specifies which of the alternate contacts to delete.

data DeleteAlternateContactResponse Source #

See: newDeleteAlternateContactResponse smart constructor.

Instances

Instances details
Eq DeleteAlternateContactResponse Source # 
Instance details

Defined in Amazonka.Account.DeleteAlternateContact

Read DeleteAlternateContactResponse Source # 
Instance details

Defined in Amazonka.Account.DeleteAlternateContact

Show DeleteAlternateContactResponse Source # 
Instance details

Defined in Amazonka.Account.DeleteAlternateContact

Generic DeleteAlternateContactResponse Source # 
Instance details

Defined in Amazonka.Account.DeleteAlternateContact

Associated Types

type Rep DeleteAlternateContactResponse :: Type -> Type #

NFData DeleteAlternateContactResponse Source # 
Instance details

Defined in Amazonka.Account.DeleteAlternateContact

type Rep DeleteAlternateContactResponse Source # 
Instance details

Defined in Amazonka.Account.DeleteAlternateContact

type Rep DeleteAlternateContactResponse = D1 ('MetaData "DeleteAlternateContactResponse" "Amazonka.Account.DeleteAlternateContact" "libZSservicesZSamazonka-accountZSamazonka-account" 'False) (C1 ('MetaCons "DeleteAlternateContactResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newDeleteAlternateContactResponse :: DeleteAlternateContactResponse Source #

Create a value of DeleteAlternateContactResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

PutAlternateContact

data PutAlternateContact Source #

See: newPutAlternateContact smart constructor.

Instances

Instances details
Eq PutAlternateContact Source # 
Instance details

Defined in Amazonka.Account.PutAlternateContact

Show PutAlternateContact Source # 
Instance details

Defined in Amazonka.Account.PutAlternateContact

Generic PutAlternateContact Source # 
Instance details

Defined in Amazonka.Account.PutAlternateContact

Associated Types

type Rep PutAlternateContact :: Type -> Type #

NFData PutAlternateContact Source # 
Instance details

Defined in Amazonka.Account.PutAlternateContact

Methods

rnf :: PutAlternateContact -> () #

Hashable PutAlternateContact Source # 
Instance details

Defined in Amazonka.Account.PutAlternateContact

ToJSON PutAlternateContact Source # 
Instance details

Defined in Amazonka.Account.PutAlternateContact

AWSRequest PutAlternateContact Source # 
Instance details

Defined in Amazonka.Account.PutAlternateContact

Associated Types

type AWSResponse PutAlternateContact #

ToHeaders PutAlternateContact Source # 
Instance details

Defined in Amazonka.Account.PutAlternateContact

ToPath PutAlternateContact Source # 
Instance details

Defined in Amazonka.Account.PutAlternateContact

ToQuery PutAlternateContact Source # 
Instance details

Defined in Amazonka.Account.PutAlternateContact

type Rep PutAlternateContact Source # 
Instance details

Defined in Amazonka.Account.PutAlternateContact

type Rep PutAlternateContact = D1 ('MetaData "PutAlternateContact" "Amazonka.Account.PutAlternateContact" "libZSservicesZSamazonka-accountZSamazonka-account" 'False) (C1 ('MetaCons "PutAlternateContact'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "accountId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "alternateContactType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 AlternateContactType) :*: S1 ('MetaSel ('Just "emailAddress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text)))) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text)) :*: (S1 ('MetaSel ('Just "phoneNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text)) :*: S1 ('MetaSel ('Just "title") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text))))))
type AWSResponse PutAlternateContact Source # 
Instance details

Defined in Amazonka.Account.PutAlternateContact

newPutAlternateContact Source #

Create a value of PutAlternateContact with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:accountId:PutAlternateContact', putAlternateContact_accountId - 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 organization's management account or a delegated administrator account, and 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 account assigned.

The management account can't specify its own AccountId; it must call the operation in standalone context by not including the AccountId parameter.

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.

$sel:alternateContactType:PutAlternateContact', putAlternateContact_alternateContactType - Specifies which alternate contact you want to create or update.

$sel:emailAddress:PutAlternateContact', putAlternateContact_emailAddress - Specifies an email address for the alternate contact.

$sel:name:PutAlternateContact', putAlternateContact_name - Specifies a name for the alternate contact.

$sel:phoneNumber:PutAlternateContact', putAlternateContact_phoneNumber - Specifies a phone number for the alternate contact.

$sel:title:PutAlternateContact', putAlternateContact_title - Specifies a title for the alternate contact.

data PutAlternateContactResponse Source #

See: newPutAlternateContactResponse smart constructor.

Instances

Instances details
Eq PutAlternateContactResponse Source # 
Instance details

Defined in Amazonka.Account.PutAlternateContact

Read PutAlternateContactResponse Source # 
Instance details

Defined in Amazonka.Account.PutAlternateContact

Show PutAlternateContactResponse Source # 
Instance details

Defined in Amazonka.Account.PutAlternateContact

Generic PutAlternateContactResponse Source # 
Instance details

Defined in Amazonka.Account.PutAlternateContact

Associated Types

type Rep PutAlternateContactResponse :: Type -> Type #

NFData PutAlternateContactResponse Source # 
Instance details

Defined in Amazonka.Account.PutAlternateContact

type Rep PutAlternateContactResponse Source # 
Instance details

Defined in Amazonka.Account.PutAlternateContact

type Rep PutAlternateContactResponse = D1 ('MetaData "PutAlternateContactResponse" "Amazonka.Account.PutAlternateContact" "libZSservicesZSamazonka-accountZSamazonka-account" 'False) (C1 ('MetaCons "PutAlternateContactResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newPutAlternateContactResponse :: PutAlternateContactResponse Source #

Create a value of PutAlternateContactResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

GetAlternateContact

data GetAlternateContact Source #

See: newGetAlternateContact smart constructor.

Instances

Instances details
Eq GetAlternateContact Source # 
Instance details

Defined in Amazonka.Account.GetAlternateContact

Read GetAlternateContact Source # 
Instance details

Defined in Amazonka.Account.GetAlternateContact

Show GetAlternateContact Source # 
Instance details

Defined in Amazonka.Account.GetAlternateContact

Generic GetAlternateContact Source # 
Instance details

Defined in Amazonka.Account.GetAlternateContact

Associated Types

type Rep GetAlternateContact :: Type -> Type #

NFData GetAlternateContact Source # 
Instance details

Defined in Amazonka.Account.GetAlternateContact

Methods

rnf :: GetAlternateContact -> () #

Hashable GetAlternateContact Source # 
Instance details

Defined in Amazonka.Account.GetAlternateContact

ToJSON GetAlternateContact Source # 
Instance details

Defined in Amazonka.Account.GetAlternateContact

AWSRequest GetAlternateContact Source # 
Instance details

Defined in Amazonka.Account.GetAlternateContact

Associated Types

type AWSResponse GetAlternateContact #

ToHeaders GetAlternateContact Source # 
Instance details

Defined in Amazonka.Account.GetAlternateContact

ToPath GetAlternateContact Source # 
Instance details

Defined in Amazonka.Account.GetAlternateContact

ToQuery GetAlternateContact Source # 
Instance details

Defined in Amazonka.Account.GetAlternateContact

type Rep GetAlternateContact Source # 
Instance details

Defined in Amazonka.Account.GetAlternateContact

type Rep GetAlternateContact = D1 ('MetaData "GetAlternateContact" "Amazonka.Account.GetAlternateContact" "libZSservicesZSamazonka-accountZSamazonka-account" 'False) (C1 ('MetaCons "GetAlternateContact'" 'PrefixI 'True) (S1 ('MetaSel ('Just "accountId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "alternateContactType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 AlternateContactType)))
type AWSResponse GetAlternateContact Source # 
Instance details

Defined in Amazonka.Account.GetAlternateContact

newGetAlternateContact Source #

Create a value of GetAlternateContact with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:accountId:GetAlternateContact', getAlternateContact_accountId - 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 organization's management account or a delegated administrator account, and 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 account assigned.

The management account can't specify its own AccountId; it must call the operation in standalone context by not including the AccountId parameter.

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.

$sel:alternateContactType:GetAlternateContact', getAlternateContact_alternateContactType - Specifies which alternate contact you want to retrieve.

data GetAlternateContactResponse Source #

See: newGetAlternateContactResponse smart constructor.

Instances

Instances details
Eq GetAlternateContactResponse Source # 
Instance details

Defined in Amazonka.Account.GetAlternateContact

Show GetAlternateContactResponse Source # 
Instance details

Defined in Amazonka.Account.GetAlternateContact

Generic GetAlternateContactResponse Source # 
Instance details

Defined in Amazonka.Account.GetAlternateContact

Associated Types

type Rep GetAlternateContactResponse :: Type -> Type #

NFData GetAlternateContactResponse Source # 
Instance details

Defined in Amazonka.Account.GetAlternateContact

type Rep GetAlternateContactResponse Source # 
Instance details

Defined in Amazonka.Account.GetAlternateContact

type Rep GetAlternateContactResponse = D1 ('MetaData "GetAlternateContactResponse" "Amazonka.Account.GetAlternateContact" "libZSservicesZSamazonka-accountZSamazonka-account" 'False) (C1 ('MetaCons "GetAlternateContactResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "alternateContact") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AlternateContact)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newGetAlternateContactResponse Source #

Create a value of GetAlternateContactResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:alternateContact:GetAlternateContactResponse', getAlternateContactResponse_alternateContact - A structure that contains the details for the specified alternate contact.

$sel:httpStatus:GetAlternateContactResponse', getAlternateContactResponse_httpStatus - The response's http status code.

Types

AlternateContactType

newtype AlternateContactType Source #

Instances

Instances details
Eq AlternateContactType Source # 
Instance details

Defined in Amazonka.Account.Types.AlternateContactType

Ord AlternateContactType Source # 
Instance details

Defined in Amazonka.Account.Types.AlternateContactType

Read AlternateContactType Source # 
Instance details

Defined in Amazonka.Account.Types.AlternateContactType

Show AlternateContactType Source # 
Instance details

Defined in Amazonka.Account.Types.AlternateContactType

Generic AlternateContactType Source # 
Instance details

Defined in Amazonka.Account.Types.AlternateContactType

Associated Types

type Rep AlternateContactType :: Type -> Type #

NFData AlternateContactType Source # 
Instance details

Defined in Amazonka.Account.Types.AlternateContactType

Methods

rnf :: AlternateContactType -> () #

Hashable AlternateContactType Source # 
Instance details

Defined in Amazonka.Account.Types.AlternateContactType

ToJSON AlternateContactType Source # 
Instance details

Defined in Amazonka.Account.Types.AlternateContactType

ToJSONKey AlternateContactType Source # 
Instance details

Defined in Amazonka.Account.Types.AlternateContactType

FromJSON AlternateContactType Source # 
Instance details

Defined in Amazonka.Account.Types.AlternateContactType

FromJSONKey AlternateContactType Source # 
Instance details

Defined in Amazonka.Account.Types.AlternateContactType

ToLog AlternateContactType Source # 
Instance details

Defined in Amazonka.Account.Types.AlternateContactType

ToHeader AlternateContactType Source # 
Instance details

Defined in Amazonka.Account.Types.AlternateContactType

ToQuery AlternateContactType Source # 
Instance details

Defined in Amazonka.Account.Types.AlternateContactType

FromXML AlternateContactType Source # 
Instance details

Defined in Amazonka.Account.Types.AlternateContactType

ToXML AlternateContactType Source # 
Instance details

Defined in Amazonka.Account.Types.AlternateContactType

ToByteString AlternateContactType Source # 
Instance details

Defined in Amazonka.Account.Types.AlternateContactType

FromText AlternateContactType Source # 
Instance details

Defined in Amazonka.Account.Types.AlternateContactType

ToText AlternateContactType Source # 
Instance details

Defined in Amazonka.Account.Types.AlternateContactType

type Rep AlternateContactType Source # 
Instance details

Defined in Amazonka.Account.Types.AlternateContactType

type Rep AlternateContactType = D1 ('MetaData "AlternateContactType" "Amazonka.Account.Types.AlternateContactType" "libZSservicesZSamazonka-accountZSamazonka-account" 'True) (C1 ('MetaCons "AlternateContactType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromAlternateContactType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

AlternateContact

data AlternateContact Source #

A structure that contains the details of an alternate contact associated with an Amazon Web Services account

See: newAlternateContact smart constructor.

Instances

Instances details
Eq AlternateContact Source # 
Instance details

Defined in Amazonka.Account.Types.AlternateContact

Show AlternateContact Source # 
Instance details

Defined in Amazonka.Account.Types.AlternateContact

Generic AlternateContact Source # 
Instance details

Defined in Amazonka.Account.Types.AlternateContact

Associated Types

type Rep AlternateContact :: Type -> Type #

NFData AlternateContact Source # 
Instance details

Defined in Amazonka.Account.Types.AlternateContact

Methods

rnf :: AlternateContact -> () #

Hashable AlternateContact Source # 
Instance details

Defined in Amazonka.Account.Types.AlternateContact

FromJSON AlternateContact Source # 
Instance details

Defined in Amazonka.Account.Types.AlternateContact

type Rep AlternateContact Source # 
Instance details

Defined in Amazonka.Account.Types.AlternateContact

type Rep AlternateContact = D1 ('MetaData "AlternateContact" "Amazonka.Account.Types.AlternateContact" "libZSservicesZSamazonka-accountZSamazonka-account" 'False) (C1 ('MetaCons "AlternateContact'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "alternateContactType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AlternateContactType)) :*: S1 ('MetaSel ('Just "phoneNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text)))) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :*: (S1 ('MetaSel ('Just "emailAddress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :*: S1 ('MetaSel ('Just "title") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text)))))))

newAlternateContact :: AlternateContact Source #

Create a value of AlternateContact with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:alternateContactType:AlternateContact', alternateContact_alternateContactType - The type of alternate contact.

$sel:phoneNumber:AlternateContact', alternateContact_phoneNumber - The phone number associated with this alternate contact.

$sel:name:AlternateContact', alternateContact_name - The name associated with this alternate contact.

$sel:emailAddress:AlternateContact', alternateContact_emailAddress - The email address associated with this alternate contact.

$sel:title:AlternateContact', alternateContact_title - The title associated with this alternate contact.