amazonka-codeartifact-2.0: Amazon CodeArtifact 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.CodeArtifact.ListDomains

Description

Returns a list of DomainSummary objects for all domains owned by the Amazon Web Services account that makes this call. Each returned DomainSummary object contains information about a domain.

This operation returns paginated results.

Synopsis

Creating a Request

data ListDomains Source #

See: newListDomains smart constructor.

Constructors

ListDomains' 

Fields

  • maxResults :: Maybe Natural

    The maximum number of results to return per page.

  • nextToken :: Maybe Text

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Instances

Instances details
ToJSON ListDomains Source # 
Instance details

Defined in Amazonka.CodeArtifact.ListDomains

ToHeaders ListDomains Source # 
Instance details

Defined in Amazonka.CodeArtifact.ListDomains

Methods

toHeaders :: ListDomains -> [Header] #

ToPath ListDomains Source # 
Instance details

Defined in Amazonka.CodeArtifact.ListDomains

ToQuery ListDomains Source # 
Instance details

Defined in Amazonka.CodeArtifact.ListDomains

AWSPager ListDomains Source # 
Instance details

Defined in Amazonka.CodeArtifact.ListDomains

AWSRequest ListDomains Source # 
Instance details

Defined in Amazonka.CodeArtifact.ListDomains

Associated Types

type AWSResponse ListDomains #

Generic ListDomains Source # 
Instance details

Defined in Amazonka.CodeArtifact.ListDomains

Associated Types

type Rep ListDomains :: Type -> Type #

Read ListDomains Source # 
Instance details

Defined in Amazonka.CodeArtifact.ListDomains

Show ListDomains Source # 
Instance details

Defined in Amazonka.CodeArtifact.ListDomains

NFData ListDomains Source # 
Instance details

Defined in Amazonka.CodeArtifact.ListDomains

Methods

rnf :: ListDomains -> () #

Eq ListDomains Source # 
Instance details

Defined in Amazonka.CodeArtifact.ListDomains

Hashable ListDomains Source # 
Instance details

Defined in Amazonka.CodeArtifact.ListDomains

type AWSResponse ListDomains Source # 
Instance details

Defined in Amazonka.CodeArtifact.ListDomains

type Rep ListDomains Source # 
Instance details

Defined in Amazonka.CodeArtifact.ListDomains

type Rep ListDomains = D1 ('MetaData "ListDomains" "Amazonka.CodeArtifact.ListDomains" "amazonka-codeartifact-2.0-CskMABZQLQJDgej73fXQxp" 'False) (C1 ('MetaCons "ListDomains'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newListDomains :: ListDomains Source #

Create a value of ListDomains 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:ListDomains', listDomains_maxResults - The maximum number of results to return per page.

ListDomains, listDomains_nextToken - The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Request Lenses

listDomains_maxResults :: Lens' ListDomains (Maybe Natural) Source #

The maximum number of results to return per page.

listDomains_nextToken :: Lens' ListDomains (Maybe Text) Source #

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Destructuring the Response

data ListDomainsResponse Source #

See: newListDomainsResponse smart constructor.

Constructors

ListDomainsResponse' 

Fields

Instances

Instances details
Generic ListDomainsResponse Source # 
Instance details

Defined in Amazonka.CodeArtifact.ListDomains

Associated Types

type Rep ListDomainsResponse :: Type -> Type #

Read ListDomainsResponse Source # 
Instance details

Defined in Amazonka.CodeArtifact.ListDomains

Show ListDomainsResponse Source # 
Instance details

Defined in Amazonka.CodeArtifact.ListDomains

NFData ListDomainsResponse Source # 
Instance details

Defined in Amazonka.CodeArtifact.ListDomains

Methods

rnf :: ListDomainsResponse -> () #

Eq ListDomainsResponse Source # 
Instance details

Defined in Amazonka.CodeArtifact.ListDomains

type Rep ListDomainsResponse Source # 
Instance details

Defined in Amazonka.CodeArtifact.ListDomains

type Rep ListDomainsResponse = D1 ('MetaData "ListDomainsResponse" "Amazonka.CodeArtifact.ListDomains" "amazonka-codeartifact-2.0-CskMABZQLQJDgej73fXQxp" 'False) (C1 ('MetaCons "ListDomainsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "domains") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DomainSummary])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListDomainsResponse Source #

Create a value of ListDomainsResponse 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:domains:ListDomainsResponse', listDomainsResponse_domains - The returned list of DomainSummary objects.

ListDomains, listDomainsResponse_nextToken - The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

$sel:httpStatus:ListDomainsResponse', listDomainsResponse_httpStatus - The response's http status code.

Response Lenses

listDomainsResponse_nextToken :: Lens' ListDomainsResponse (Maybe Text) Source #

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.