Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Organizations.EnableAWSServiceAccess

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

Enables the integration of an Amazon Web Services service (the service that is specified by ServicePrincipal) with 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 Organizations and the specified Amazon Web Services 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 Amazon Web Services service.

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

You can only call this operation 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 Amazon Web Services 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

ToJSON EnableAWSServiceAccess Source #
Instance details Defined in Amazonka.Organizations.EnableAWSServiceAccess Methods toJSON :: EnableAWSServiceAccess -> Value # toEncoding :: EnableAWSServiceAccess -> Encoding # toJSONList :: [EnableAWSServiceAccess] -> Value # toEncodingList :: [EnableAWSServiceAccess] -> Encoding #
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 #
AWSRequest EnableAWSServiceAccess Source #
Instance details Defined in Amazonka.Organizations.EnableAWSServiceAccess Associated Types type AWSResponse EnableAWSServiceAccess # Methods request :: (Service -> Service) -> EnableAWSServiceAccess -> Request EnableAWSServiceAccess # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy EnableAWSServiceAccess -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse EnableAWSServiceAccess))) #
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 #
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 #
NFData EnableAWSServiceAccess Source #
Instance details Defined in Amazonka.Organizations.EnableAWSServiceAccess Methods rnf :: EnableAWSServiceAccess -> () #
Eq EnableAWSServiceAccess Source #
Instance details Defined in Amazonka.Organizations.EnableAWSServiceAccess Methods (==) :: EnableAWSServiceAccess -> EnableAWSServiceAccess -> Bool # (/=) :: EnableAWSServiceAccess -> EnableAWSServiceAccess -> Bool #
Hashable EnableAWSServiceAccess Source #
Instance details Defined in Amazonka.Organizations.EnableAWSServiceAccess Methods hashWithSalt :: Int -> EnableAWSServiceAccess -> Int # hash :: EnableAWSServiceAccess -> Int #
type AWSResponse EnableAWSServiceAccess Source #
Instance details Defined in Amazonka.Organizations.EnableAWSServiceAccess type AWSResponse EnableAWSServiceAccess = EnableAWSServiceAccessResponse
type Rep EnableAWSServiceAccess Source #
Instance details Defined in Amazonka.Organizations.EnableAWSServiceAccess type Rep EnableAWSServiceAccess = D1 ('MetaData "EnableAWSServiceAccess" "Amazonka.Organizations.EnableAWSServiceAccess" "amazonka-organizations-2.0-JONpdX4PtttLcKxQshpOlA" 'False) (C1 ('MetaCons "EnableAWSServiceAccess'" 'PrefixI 'True) (S1 ('MetaSel ('Just "servicePrincipal") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newEnableAWSServiceAccess Source #

Arguments

:: Text	`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:

EnableAWSServiceAccess, enableAWSServiceAccess_servicePrincipal - The service principal name of the Amazon Web Services 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 Amazon Web Services 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

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 #
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 #
NFData EnableAWSServiceAccessResponse Source #
Instance details Defined in Amazonka.Organizations.EnableAWSServiceAccess Methods rnf :: EnableAWSServiceAccessResponse -> () #
Eq EnableAWSServiceAccessResponse Source #
Instance details Defined in Amazonka.Organizations.EnableAWSServiceAccess Methods (==) :: EnableAWSServiceAccessResponse -> EnableAWSServiceAccessResponse -> Bool # (/=) :: EnableAWSServiceAccessResponse -> EnableAWSServiceAccessResponse -> Bool #
type Rep EnableAWSServiceAccessResponse Source #
Instance details Defined in Amazonka.Organizations.EnableAWSServiceAccess type Rep EnableAWSServiceAccessResponse = D1 ('MetaData "EnableAWSServiceAccessResponse" "Amazonka.Organizations.EnableAWSServiceAccess" "amazonka-organizations-2.0-JONpdX4PtttLcKxQshpOlA" '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.