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.ListDelegatedAdministrators

Description

Lists the AWS accounts that are designated as delegated administrators in this organization.

This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an AWS service.

This operation returns paginated results.

Synopsis

Creating a Request

data ListDelegatedAdministrators Source #

See: newListDelegatedAdministrators smart constructor.

Constructors

ListDelegatedAdministrators' 

Fields

  • servicePrincipal :: Maybe Text

    Specifies a service principal name. If specified, then the operation lists the delegated administrators only for the specified service.

    If you don't specify a service principal, the operation lists all delegated administrators for all services in your organization.

  • nextToken :: Maybe Text

    The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call's NextToken response to indicate where the output should continue from.

  • maxResults :: Maybe Natural

    The total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

Instances

Instances details
Eq ListDelegatedAdministrators Source # 
Instance details

Defined in Amazonka.Organizations.ListDelegatedAdministrators

Read ListDelegatedAdministrators Source # 
Instance details

Defined in Amazonka.Organizations.ListDelegatedAdministrators

Show ListDelegatedAdministrators Source # 
Instance details

Defined in Amazonka.Organizations.ListDelegatedAdministrators

Generic ListDelegatedAdministrators Source # 
Instance details

Defined in Amazonka.Organizations.ListDelegatedAdministrators

Associated Types

type Rep ListDelegatedAdministrators :: Type -> Type #

NFData ListDelegatedAdministrators Source # 
Instance details

Defined in Amazonka.Organizations.ListDelegatedAdministrators

Hashable ListDelegatedAdministrators Source # 
Instance details

Defined in Amazonka.Organizations.ListDelegatedAdministrators

ToJSON ListDelegatedAdministrators Source # 
Instance details

Defined in Amazonka.Organizations.ListDelegatedAdministrators

AWSPager ListDelegatedAdministrators Source # 
Instance details

Defined in Amazonka.Organizations.ListDelegatedAdministrators

AWSRequest ListDelegatedAdministrators Source # 
Instance details

Defined in Amazonka.Organizations.ListDelegatedAdministrators

ToHeaders ListDelegatedAdministrators Source # 
Instance details

Defined in Amazonka.Organizations.ListDelegatedAdministrators

ToPath ListDelegatedAdministrators Source # 
Instance details

Defined in Amazonka.Organizations.ListDelegatedAdministrators

ToQuery ListDelegatedAdministrators Source # 
Instance details

Defined in Amazonka.Organizations.ListDelegatedAdministrators

type Rep ListDelegatedAdministrators Source # 
Instance details

Defined in Amazonka.Organizations.ListDelegatedAdministrators

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

Defined in Amazonka.Organizations.ListDelegatedAdministrators

newListDelegatedAdministrators :: ListDelegatedAdministrators Source #

Create a value of ListDelegatedAdministrators 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:ListDelegatedAdministrators', listDelegatedAdministrators_servicePrincipal - Specifies a service principal name. If specified, then the operation lists the delegated administrators only for the specified service.

If you don't specify a service principal, the operation lists all delegated administrators for all services in your organization.

$sel:nextToken:ListDelegatedAdministrators', listDelegatedAdministrators_nextToken - The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call's NextToken response to indicate where the output should continue from.

$sel:maxResults:ListDelegatedAdministrators', listDelegatedAdministrators_maxResults - The total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

Request Lenses

listDelegatedAdministrators_servicePrincipal :: Lens' ListDelegatedAdministrators (Maybe Text) Source #

Specifies a service principal name. If specified, then the operation lists the delegated administrators only for the specified service.

If you don't specify a service principal, the operation lists all delegated administrators for all services in your organization.

listDelegatedAdministrators_nextToken :: Lens' ListDelegatedAdministrators (Maybe Text) Source #

The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call's NextToken response to indicate where the output should continue from.

listDelegatedAdministrators_maxResults :: Lens' ListDelegatedAdministrators (Maybe Natural) Source #

The total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

Destructuring the Response

data ListDelegatedAdministratorsResponse Source #

Constructors

ListDelegatedAdministratorsResponse' 

Fields

  • delegatedAdministrators :: Maybe [DelegatedAdministrator]

    The list of delegated administrators in your organization.

  • nextToken :: Maybe Text

    If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq ListDelegatedAdministratorsResponse Source # 
Instance details

Defined in Amazonka.Organizations.ListDelegatedAdministrators

Show ListDelegatedAdministratorsResponse Source # 
Instance details

Defined in Amazonka.Organizations.ListDelegatedAdministrators

Generic ListDelegatedAdministratorsResponse Source # 
Instance details

Defined in Amazonka.Organizations.ListDelegatedAdministrators

NFData ListDelegatedAdministratorsResponse Source # 
Instance details

Defined in Amazonka.Organizations.ListDelegatedAdministrators

type Rep ListDelegatedAdministratorsResponse Source # 
Instance details

Defined in Amazonka.Organizations.ListDelegatedAdministrators

type Rep ListDelegatedAdministratorsResponse = D1 ('MetaData "ListDelegatedAdministratorsResponse" "Amazonka.Organizations.ListDelegatedAdministrators" "libZSservicesZSamazonka-organizationsZSamazonka-organizations" 'False) (C1 ('MetaCons "ListDelegatedAdministratorsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "delegatedAdministrators") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DelegatedAdministrator])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListDelegatedAdministratorsResponse Source #

Create a value of ListDelegatedAdministratorsResponse 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:delegatedAdministrators:ListDelegatedAdministratorsResponse', listDelegatedAdministratorsResponse_delegatedAdministrators - The list of delegated administrators in your organization.

$sel:nextToken:ListDelegatedAdministrators', listDelegatedAdministratorsResponse_nextToken - If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.

$sel:httpStatus:ListDelegatedAdministratorsResponse', listDelegatedAdministratorsResponse_httpStatus - The response's http status code.

Response Lenses

listDelegatedAdministratorsResponse_nextToken :: Lens' ListDelegatedAdministratorsResponse (Maybe Text) Source #

If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.