libZSservicesZSamazonka-organizationsZSamazonka-organizations
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.Organizations.DisableAWSServiceAccess

Description

Disables the integration of an AWS service (the service that is specified by ServicePrincipal) with AWS Organizations. When you disable integration, the specified service no longer can create a service-linked role in new accounts in your organization. This means the service can't perform operations on your behalf on any new accounts in your organization. The service can still perform operations in older accounts until the service completes its clean-up from AWS Organizations.

We strongly recommend that you don't use this command to disable integration between AWS Organizations and the specified AWS service. Instead, use the console or commands that are provided by the specified service. This lets the trusted service perform any required initialization when enabling trusted access, such as creating any required resources and any required clean up of resources when disabling trusted access.

For information about how to disable trusted service access to your organization using the trusted service, see the Learn more link under the Supports Trusted Access column at AWS services that you can use with AWS Organizations. on this page.

If you disable access by using this command, it causes the following actions to occur:

  • The service can no longer create a service-linked role in the accounts in your organization. This means that the service can't perform operations on your behalf on any new accounts in your organization. The service can still perform operations in older accounts until the service completes its clean-up from AWS Organizations.
  • The service can no longer perform tasks in the member accounts in the organization, unless those operations are explicitly permitted by the IAM policies that are attached to your roles. This includes any data aggregation from the member accounts to the management account, or to a delegated administrator account, where relevant.
  • Some services detect this and clean up any remaining data or resources related to the integration, while other services stop accessing the organization but leave any historical data and configuration in place to support a possible re-enabling of the integration.

Using the other service's console or commands to disable the integration ensures that the other service is aware that it can clean up any resources that are required only for the integration. How the service cleans up its resources in the organization's accounts depends on that service. For more information, see the documentation for the other AWS service.

After you perform the DisableAWSServiceAccess operation, the specified service can no longer perform operations in your organization's accounts

For more information about integrating other services with AWS Organizations, including the list of services that work with 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.

Synopsis

Creating a Request

data DisableAWSServiceAccess Source #

See: newDisableAWSServiceAccess smart constructor.

Constructors

DisableAWSServiceAccess' 

Fields

  • servicePrincipal :: Text

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

Instances

Instances details
Eq DisableAWSServiceAccess Source # 
Instance details

Defined in Amazonka.Organizations.DisableAWSServiceAccess

Read DisableAWSServiceAccess Source # 
Instance details

Defined in Amazonka.Organizations.DisableAWSServiceAccess

Show DisableAWSServiceAccess Source # 
Instance details

Defined in Amazonka.Organizations.DisableAWSServiceAccess

Generic DisableAWSServiceAccess Source # 
Instance details

Defined in Amazonka.Organizations.DisableAWSServiceAccess

Associated Types

type Rep DisableAWSServiceAccess :: Type -> Type #

NFData DisableAWSServiceAccess Source # 
Instance details

Defined in Amazonka.Organizations.DisableAWSServiceAccess

Methods

rnf :: DisableAWSServiceAccess -> () #

Hashable DisableAWSServiceAccess Source # 
Instance details

Defined in Amazonka.Organizations.DisableAWSServiceAccess

ToJSON DisableAWSServiceAccess Source # 
Instance details

Defined in Amazonka.Organizations.DisableAWSServiceAccess

AWSRequest DisableAWSServiceAccess Source # 
Instance details

Defined in Amazonka.Organizations.DisableAWSServiceAccess

ToHeaders DisableAWSServiceAccess Source # 
Instance details

Defined in Amazonka.Organizations.DisableAWSServiceAccess

ToPath DisableAWSServiceAccess Source # 
Instance details

Defined in Amazonka.Organizations.DisableAWSServiceAccess

ToQuery DisableAWSServiceAccess Source # 
Instance details

Defined in Amazonka.Organizations.DisableAWSServiceAccess

type Rep DisableAWSServiceAccess Source # 
Instance details

Defined in Amazonka.Organizations.DisableAWSServiceAccess

type Rep DisableAWSServiceAccess = D1 ('MetaData "DisableAWSServiceAccess" "Amazonka.Organizations.DisableAWSServiceAccess" "libZSservicesZSamazonka-organizationsZSamazonka-organizations" 'False) (C1 ('MetaCons "DisableAWSServiceAccess'" 'PrefixI 'True) (S1 ('MetaSel ('Just "servicePrincipal") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DisableAWSServiceAccess Source # 
Instance details

Defined in Amazonka.Organizations.DisableAWSServiceAccess

newDisableAWSServiceAccess Source #

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

Request Lenses

disableAWSServiceAccess_servicePrincipal :: Lens' DisableAWSServiceAccess Text Source #

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

Destructuring the Response

data DisableAWSServiceAccessResponse Source #

See: newDisableAWSServiceAccessResponse smart constructor.

Instances

Instances details
Eq DisableAWSServiceAccessResponse Source # 
Instance details

Defined in Amazonka.Organizations.DisableAWSServiceAccess

Read DisableAWSServiceAccessResponse Source # 
Instance details

Defined in Amazonka.Organizations.DisableAWSServiceAccess

Show DisableAWSServiceAccessResponse Source # 
Instance details

Defined in Amazonka.Organizations.DisableAWSServiceAccess

Generic DisableAWSServiceAccessResponse Source # 
Instance details

Defined in Amazonka.Organizations.DisableAWSServiceAccess

Associated Types

type Rep DisableAWSServiceAccessResponse :: Type -> Type #

NFData DisableAWSServiceAccessResponse Source # 
Instance details

Defined in Amazonka.Organizations.DisableAWSServiceAccess

type Rep DisableAWSServiceAccessResponse Source # 
Instance details

Defined in Amazonka.Organizations.DisableAWSServiceAccess

type Rep DisableAWSServiceAccessResponse = D1 ('MetaData "DisableAWSServiceAccessResponse" "Amazonka.Organizations.DisableAWSServiceAccess" "libZSservicesZSamazonka-organizationsZSamazonka-organizations" 'False) (C1 ('MetaCons "DisableAWSServiceAccessResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newDisableAWSServiceAccessResponse :: DisableAWSServiceAccessResponse Source #

Create a value of DisableAWSServiceAccessResponse with all optional fields omitted.

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