Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Organizations.EnableAWSServiceAccess

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

Enables the integration of an AWS service (the service that is specified by ServicePrincipal) with AWS Organizations. When you enable integration, you allow the specified service to create a service-linked role in all the accounts in your organization. This allows the service to perform operations on your behalf in your organization and its accounts.

We recommend that you enable integration between AWS Organizations and the specified AWS service by using the console or commands that are provided by the specified service. Doing so ensures that the service is aware that it can create the resources that are required for the integration. How the service creates those resources in the organization's accounts depends on that service. For more information, see the documentation for the other AWS service.

For more information about enabling services to integrate with AWS Organizations, see Integrating AWS Organizations with Other AWS Services in the AWS Organizations User Guide.

This operation can be called only from the organization's management account and only if the organization has enabled all features.

Synopsis

data EnableAWSServiceAccess = EnableAWSServiceAccess' {
- servicePrincipal :: Text
}
newEnableAWSServiceAccess :: Text -> EnableAWSServiceAccess
enableAWSServiceAccess_servicePrincipal :: Lens' EnableAWSServiceAccess Text
data EnableAWSServiceAccessResponse = EnableAWSServiceAccessResponse' {
}
newEnableAWSServiceAccessResponse :: EnableAWSServiceAccessResponse

Creating a Request

data EnableAWSServiceAccess Source #

See: newEnableAWSServiceAccess smart constructor.

Constructors

EnableAWSServiceAccess'
Fields servicePrincipal :: Text The service principal name of the AWS service for which you want to enable integration with your organization. This is typically in the form of a URL, such as `service-abbreviation.amazonaws.com`.

Instances

Instances details

Eq EnableAWSServiceAccess Source #
Instance details Defined in Amazonka.Organizations.EnableAWSServiceAccess Methods (==) :: EnableAWSServiceAccess -> EnableAWSServiceAccess -> Bool # (/=) :: EnableAWSServiceAccess -> EnableAWSServiceAccess -> Bool #
Read EnableAWSServiceAccess Source #
Instance details Defined in Amazonka.Organizations.EnableAWSServiceAccess Methods readsPrec :: Int -> ReadS EnableAWSServiceAccess # readList :: ReadS [EnableAWSServiceAccess] # readPrec :: ReadPrec EnableAWSServiceAccess # readListPrec :: ReadPrec [EnableAWSServiceAccess] #
Show EnableAWSServiceAccess Source #
Instance details Defined in Amazonka.Organizations.EnableAWSServiceAccess Methods showsPrec :: Int -> EnableAWSServiceAccess -> ShowS # show :: EnableAWSServiceAccess -> String # showList :: [EnableAWSServiceAccess] -> ShowS #
Generic EnableAWSServiceAccess Source #
Instance details Defined in Amazonka.Organizations.EnableAWSServiceAccess Associated Types type Rep EnableAWSServiceAccess :: Type -> Type # Methods from :: EnableAWSServiceAccess -> Rep EnableAWSServiceAccess x # to :: Rep EnableAWSServiceAccess x -> EnableAWSServiceAccess #
NFData EnableAWSServiceAccess Source #
Instance details Defined in Amazonka.Organizations.EnableAWSServiceAccess Methods rnf :: EnableAWSServiceAccess -> () #
Hashable EnableAWSServiceAccess Source #
Instance details Defined in Amazonka.Organizations.EnableAWSServiceAccess Methods hashWithSalt :: Int -> EnableAWSServiceAccess -> Int # hash :: EnableAWSServiceAccess -> Int #
ToJSON EnableAWSServiceAccess Source #
Instance details Defined in Amazonka.Organizations.EnableAWSServiceAccess Methods toJSON :: EnableAWSServiceAccess -> Value # toEncoding :: EnableAWSServiceAccess -> Encoding # toJSONList :: [EnableAWSServiceAccess] -> Value # toEncodingList :: [EnableAWSServiceAccess] -> Encoding #
AWSRequest EnableAWSServiceAccess Source #
Instance details Defined in Amazonka.Organizations.EnableAWSServiceAccess Associated Types type AWSResponse EnableAWSServiceAccess # Methods request :: EnableAWSServiceAccess -> Request EnableAWSServiceAccess # response :: MonadResource m => Logger -> Service -> Proxy EnableAWSServiceAccess -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse EnableAWSServiceAccess))) #
ToHeaders EnableAWSServiceAccess Source #
Instance details Defined in Amazonka.Organizations.EnableAWSServiceAccess Methods toHeaders :: EnableAWSServiceAccess -> [Header] #
ToPath EnableAWSServiceAccess Source #
Instance details Defined in Amazonka.Organizations.EnableAWSServiceAccess Methods toPath :: EnableAWSServiceAccess -> ByteString #
ToQuery EnableAWSServiceAccess Source #
Instance details Defined in Amazonka.Organizations.EnableAWSServiceAccess Methods toQuery :: EnableAWSServiceAccess -> QueryString #
type Rep EnableAWSServiceAccess Source #
Instance details Defined in Amazonka.Organizations.EnableAWSServiceAccess type Rep EnableAWSServiceAccess = D1 ('MetaData "EnableAWSServiceAccess" "Amazonka.Organizations.EnableAWSServiceAccess" "libZSservicesZSamazonka-organizationsZSamazonka-organizations" 'False) (C1 ('MetaCons "EnableAWSServiceAccess'" 'PrefixI 'True) (S1 ('MetaSel ('Just "servicePrincipal") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse EnableAWSServiceAccess Source #
Instance details Defined in Amazonka.Organizations.EnableAWSServiceAccess type AWSResponse EnableAWSServiceAccess = EnableAWSServiceAccessResponse

newEnableAWSServiceAccess Source #

Arguments

:: Text	`$sel:servicePrincipal:EnableAWSServiceAccess'`
-> EnableAWSServiceAccess

Create a value of EnableAWSServiceAccess 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:servicePrincipal:EnableAWSServiceAccess', enableAWSServiceAccess_servicePrincipal - The service principal name of the AWS service for which you want to enable integration with your organization. This is typically in the form of a URL, such as service-abbreviation.amazonaws.com.

Request Lenses

enableAWSServiceAccess_servicePrincipal :: Lens' EnableAWSServiceAccess Text Source #

The service principal name of the AWS service for which you want to enable integration with your organization. This is typically in the form of a URL, such as service-abbreviation.amazonaws.com.

Destructuring the Response

data EnableAWSServiceAccessResponse Source #

See: newEnableAWSServiceAccessResponse smart constructor.

Constructors

EnableAWSServiceAccessResponse'

Instances

Instances details

Eq EnableAWSServiceAccessResponse Source #
Instance details Defined in Amazonka.Organizations.EnableAWSServiceAccess Methods (==) :: EnableAWSServiceAccessResponse -> EnableAWSServiceAccessResponse -> Bool # (/=) :: EnableAWSServiceAccessResponse -> EnableAWSServiceAccessResponse -> Bool #
Read EnableAWSServiceAccessResponse Source #
Instance details Defined in Amazonka.Organizations.EnableAWSServiceAccess Methods readsPrec :: Int -> ReadS EnableAWSServiceAccessResponse # readList :: ReadS [EnableAWSServiceAccessResponse] # readPrec :: ReadPrec EnableAWSServiceAccessResponse # readListPrec :: ReadPrec [EnableAWSServiceAccessResponse] #
Show EnableAWSServiceAccessResponse Source #
Instance details Defined in Amazonka.Organizations.EnableAWSServiceAccess Methods showsPrec :: Int -> EnableAWSServiceAccessResponse -> ShowS # show :: EnableAWSServiceAccessResponse -> String # showList :: [EnableAWSServiceAccessResponse] -> ShowS #
Generic EnableAWSServiceAccessResponse Source #
Instance details Defined in Amazonka.Organizations.EnableAWSServiceAccess Associated Types type Rep EnableAWSServiceAccessResponse :: Type -> Type # Methods from :: EnableAWSServiceAccessResponse -> Rep EnableAWSServiceAccessResponse x # to :: Rep EnableAWSServiceAccessResponse x -> EnableAWSServiceAccessResponse #
NFData EnableAWSServiceAccessResponse Source #
Instance details Defined in Amazonka.Organizations.EnableAWSServiceAccess Methods rnf :: EnableAWSServiceAccessResponse -> () #
type Rep EnableAWSServiceAccessResponse Source #
Instance details Defined in Amazonka.Organizations.EnableAWSServiceAccess type Rep EnableAWSServiceAccessResponse = D1 ('MetaData "EnableAWSServiceAccessResponse" "Amazonka.Organizations.EnableAWSServiceAccess" "libZSservicesZSamazonka-organizationsZSamazonka-organizations" 'False) (C1 ('MetaCons "EnableAWSServiceAccessResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newEnableAWSServiceAccessResponse :: EnableAWSServiceAccessResponse Source #

Create a value of EnableAWSServiceAccessResponse with all optional fields omitted.

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