amazonka-organizations-2.0: Amazon Organizations SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Organizations.ListCreateAccountStatus

Description

Lists the account creation requests that match the specified status that is currently being tracked for the organization.

Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display.

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

This operation returns paginated results.

Synopsis

Creating a Request

data ListCreateAccountStatus Source #

See: newListCreateAccountStatus smart constructor.

Constructors

ListCreateAccountStatus' 

Fields

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

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

  • states :: Maybe [CreateAccountState]

    A list of one or more states that you want included in the response. If this parameter isn't present, all requests are included in the response.

Instances

Instances details
ToJSON ListCreateAccountStatus Source # 
Instance details

Defined in Amazonka.Organizations.ListCreateAccountStatus

ToHeaders ListCreateAccountStatus Source # 
Instance details

Defined in Amazonka.Organizations.ListCreateAccountStatus

ToPath ListCreateAccountStatus Source # 
Instance details

Defined in Amazonka.Organizations.ListCreateAccountStatus

ToQuery ListCreateAccountStatus Source # 
Instance details

Defined in Amazonka.Organizations.ListCreateAccountStatus

AWSPager ListCreateAccountStatus Source # 
Instance details

Defined in Amazonka.Organizations.ListCreateAccountStatus

AWSRequest ListCreateAccountStatus Source # 
Instance details

Defined in Amazonka.Organizations.ListCreateAccountStatus

Generic ListCreateAccountStatus Source # 
Instance details

Defined in Amazonka.Organizations.ListCreateAccountStatus

Associated Types

type Rep ListCreateAccountStatus :: Type -> Type #

Read ListCreateAccountStatus Source # 
Instance details

Defined in Amazonka.Organizations.ListCreateAccountStatus

Show ListCreateAccountStatus Source # 
Instance details

Defined in Amazonka.Organizations.ListCreateAccountStatus

NFData ListCreateAccountStatus Source # 
Instance details

Defined in Amazonka.Organizations.ListCreateAccountStatus

Methods

rnf :: ListCreateAccountStatus -> () #

Eq ListCreateAccountStatus Source # 
Instance details

Defined in Amazonka.Organizations.ListCreateAccountStatus

Hashable ListCreateAccountStatus Source # 
Instance details

Defined in Amazonka.Organizations.ListCreateAccountStatus

type AWSResponse ListCreateAccountStatus Source # 
Instance details

Defined in Amazonka.Organizations.ListCreateAccountStatus

type Rep ListCreateAccountStatus Source # 
Instance details

Defined in Amazonka.Organizations.ListCreateAccountStatus

type Rep ListCreateAccountStatus = D1 ('MetaData "ListCreateAccountStatus" "Amazonka.Organizations.ListCreateAccountStatus" "amazonka-organizations-2.0-JONpdX4PtttLcKxQshpOlA" 'False) (C1 ('MetaCons "ListCreateAccountStatus'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "states") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [CreateAccountState])))))

newListCreateAccountStatus :: ListCreateAccountStatus Source #

Create a value of ListCreateAccountStatus 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:maxResults:ListCreateAccountStatus', listCreateAccountStatus_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.

ListCreateAccountStatus, listCreateAccountStatus_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:states:ListCreateAccountStatus', listCreateAccountStatus_states - A list of one or more states that you want included in the response. If this parameter isn't present, all requests are included in the response.

Request Lenses

listCreateAccountStatus_maxResults :: Lens' ListCreateAccountStatus (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.

listCreateAccountStatus_nextToken :: Lens' ListCreateAccountStatus (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.

listCreateAccountStatus_states :: Lens' ListCreateAccountStatus (Maybe [CreateAccountState]) Source #

A list of one or more states that you want included in the response. If this parameter isn't present, all requests are included in the response.

Destructuring the Response

data ListCreateAccountStatusResponse Source #

See: newListCreateAccountStatusResponse smart constructor.

Constructors

ListCreateAccountStatusResponse' 

Fields

  • createAccountStatuses :: Maybe [CreateAccountStatus]

    A list of objects with details about the requests. Certain elements, such as the accountId number, are present in the output only after the account has been successfully created.

  • 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
Generic ListCreateAccountStatusResponse Source # 
Instance details

Defined in Amazonka.Organizations.ListCreateAccountStatus

Associated Types

type Rep ListCreateAccountStatusResponse :: Type -> Type #

Show ListCreateAccountStatusResponse Source # 
Instance details

Defined in Amazonka.Organizations.ListCreateAccountStatus

NFData ListCreateAccountStatusResponse Source # 
Instance details

Defined in Amazonka.Organizations.ListCreateAccountStatus

Eq ListCreateAccountStatusResponse Source # 
Instance details

Defined in Amazonka.Organizations.ListCreateAccountStatus

type Rep ListCreateAccountStatusResponse Source # 
Instance details

Defined in Amazonka.Organizations.ListCreateAccountStatus

type Rep ListCreateAccountStatusResponse = D1 ('MetaData "ListCreateAccountStatusResponse" "Amazonka.Organizations.ListCreateAccountStatus" "amazonka-organizations-2.0-JONpdX4PtttLcKxQshpOlA" 'False) (C1 ('MetaCons "ListCreateAccountStatusResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "createAccountStatuses") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [CreateAccountStatus])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListCreateAccountStatusResponse Source #

Create a value of ListCreateAccountStatusResponse 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:createAccountStatuses:ListCreateAccountStatusResponse', listCreateAccountStatusResponse_createAccountStatuses - A list of objects with details about the requests. Certain elements, such as the accountId number, are present in the output only after the account has been successfully created.

ListCreateAccountStatus, listCreateAccountStatusResponse_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:ListCreateAccountStatusResponse', listCreateAccountStatusResponse_httpStatus - The response's http status code.

Response Lenses

listCreateAccountStatusResponse_createAccountStatuses :: Lens' ListCreateAccountStatusResponse (Maybe [CreateAccountStatus]) Source #

A list of objects with details about the requests. Certain elements, such as the accountId number, are present in the output only after the account has been successfully created.

listCreateAccountStatusResponse_nextToken :: Lens' ListCreateAccountStatusResponse (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.