amazonka-lookoutvision-2.0: Amazon Lookout for Vision 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.LookoutVision.ListProjects

Description

Lists the Amazon Lookout for Vision projects in your AWS account that are in the AWS Region in which you call ListProjects.

The ListProjects operation is eventually consistent. Recent calls to CreateProject and DeleteProject might take a while to appear in the response from ListProjects.

This operation requires permissions to perform the lookoutvision:ListProjects operation.

This operation returns paginated results.

Synopsis

Creating a Request

data ListProjects Source #

See: newListProjects smart constructor.

Constructors

ListProjects' 

Fields

  • maxResults :: Maybe Natural

    The maximum number of results to return per paginated call. The largest value you can specify is 100. If you specify a value greater than 100, a ValidationException error occurs. The default value is 100.

  • nextToken :: Maybe Text

    If the previous response was incomplete (because there is more data to retrieve), Amazon Lookout for Vision returns a pagination token in the response. You can use this pagination token to retrieve the next set of projects.

Instances

Instances details
ToHeaders ListProjects Source # 
Instance details

Defined in Amazonka.LookoutVision.ListProjects

ToPath ListProjects Source # 
Instance details

Defined in Amazonka.LookoutVision.ListProjects

ToQuery ListProjects Source # 
Instance details

Defined in Amazonka.LookoutVision.ListProjects

AWSPager ListProjects Source # 
Instance details

Defined in Amazonka.LookoutVision.ListProjects

AWSRequest ListProjects Source # 
Instance details

Defined in Amazonka.LookoutVision.ListProjects

Associated Types

type AWSResponse ListProjects #

Generic ListProjects Source # 
Instance details

Defined in Amazonka.LookoutVision.ListProjects

Associated Types

type Rep ListProjects :: Type -> Type #

Read ListProjects Source # 
Instance details

Defined in Amazonka.LookoutVision.ListProjects

Show ListProjects Source # 
Instance details

Defined in Amazonka.LookoutVision.ListProjects

NFData ListProjects Source # 
Instance details

Defined in Amazonka.LookoutVision.ListProjects

Methods

rnf :: ListProjects -> () #

Eq ListProjects Source # 
Instance details

Defined in Amazonka.LookoutVision.ListProjects

Hashable ListProjects Source # 
Instance details

Defined in Amazonka.LookoutVision.ListProjects

type AWSResponse ListProjects Source # 
Instance details

Defined in Amazonka.LookoutVision.ListProjects

type Rep ListProjects Source # 
Instance details

Defined in Amazonka.LookoutVision.ListProjects

type Rep ListProjects = D1 ('MetaData "ListProjects" "Amazonka.LookoutVision.ListProjects" "amazonka-lookoutvision-2.0-3cIJAF9xWxx8xGDY24BOkS" 'False) (C1 ('MetaCons "ListProjects'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newListProjects :: ListProjects Source #

Create a value of ListProjects 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:ListProjects', listProjects_maxResults - The maximum number of results to return per paginated call. The largest value you can specify is 100. If you specify a value greater than 100, a ValidationException error occurs. The default value is 100.

ListProjects, listProjects_nextToken - If the previous response was incomplete (because there is more data to retrieve), Amazon Lookout for Vision returns a pagination token in the response. You can use this pagination token to retrieve the next set of projects.

Request Lenses

listProjects_maxResults :: Lens' ListProjects (Maybe Natural) Source #

The maximum number of results to return per paginated call. The largest value you can specify is 100. If you specify a value greater than 100, a ValidationException error occurs. The default value is 100.

listProjects_nextToken :: Lens' ListProjects (Maybe Text) Source #

If the previous response was incomplete (because there is more data to retrieve), Amazon Lookout for Vision returns a pagination token in the response. You can use this pagination token to retrieve the next set of projects.

Destructuring the Response

data ListProjectsResponse Source #

See: newListProjectsResponse smart constructor.

Constructors

ListProjectsResponse' 

Fields

  • nextToken :: Maybe Text

    If the response is truncated, Amazon Lookout for Vision returns this token that you can use in the subsequent request to retrieve the next set of projects.

  • projects :: Maybe [ProjectMetadata]

    A list of projects in your AWS account.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic ListProjectsResponse Source # 
Instance details

Defined in Amazonka.LookoutVision.ListProjects

Associated Types

type Rep ListProjectsResponse :: Type -> Type #

Read ListProjectsResponse Source # 
Instance details

Defined in Amazonka.LookoutVision.ListProjects

Show ListProjectsResponse Source # 
Instance details

Defined in Amazonka.LookoutVision.ListProjects

NFData ListProjectsResponse Source # 
Instance details

Defined in Amazonka.LookoutVision.ListProjects

Methods

rnf :: ListProjectsResponse -> () #

Eq ListProjectsResponse Source # 
Instance details

Defined in Amazonka.LookoutVision.ListProjects

type Rep ListProjectsResponse Source # 
Instance details

Defined in Amazonka.LookoutVision.ListProjects

type Rep ListProjectsResponse = D1 ('MetaData "ListProjectsResponse" "Amazonka.LookoutVision.ListProjects" "amazonka-lookoutvision-2.0-3cIJAF9xWxx8xGDY24BOkS" 'False) (C1 ('MetaCons "ListProjectsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "projects") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ProjectMetadata])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListProjectsResponse Source #

Create a value of ListProjectsResponse 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:

ListProjects, listProjectsResponse_nextToken - If the response is truncated, Amazon Lookout for Vision returns this token that you can use in the subsequent request to retrieve the next set of projects.

$sel:projects:ListProjectsResponse', listProjectsResponse_projects - A list of projects in your AWS account.

$sel:httpStatus:ListProjectsResponse', listProjectsResponse_httpStatus - The response's http status code.

Response Lenses

listProjectsResponse_nextToken :: Lens' ListProjectsResponse (Maybe Text) Source #

If the response is truncated, Amazon Lookout for Vision returns this token that you can use in the subsequent request to retrieve the next set of projects.