Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Amplify.ListArtifacts

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns a list of artifacts for a specified app, branch, and job.

Synopsis

data ListArtifacts = ListArtifacts' {
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- appId :: Text
- branchName :: Text
- jobId :: Text
}
newListArtifacts :: Text -> Text -> Text -> ListArtifacts
listArtifacts_maxResults :: Lens' ListArtifacts (Maybe Natural)
listArtifacts_nextToken :: Lens' ListArtifacts (Maybe Text)
listArtifacts_appId :: Lens' ListArtifacts Text
listArtifacts_branchName :: Lens' ListArtifacts Text
listArtifacts_jobId :: Lens' ListArtifacts Text
data ListArtifactsResponse = ListArtifactsResponse' {
- nextToken :: Maybe Text
- httpStatus :: Int
- artifacts :: [Artifact]
}
newListArtifactsResponse :: Int -> ListArtifactsResponse
listArtifactsResponse_nextToken :: Lens' ListArtifactsResponse (Maybe Text)
listArtifactsResponse_httpStatus :: Lens' ListArtifactsResponse Int
listArtifactsResponse_artifacts :: Lens' ListArtifactsResponse [Artifact]

Creating a Request

data ListArtifacts Source #

Describes the request structure for the list artifacts request.

See: newListArtifacts smart constructor.

Constructors

ListArtifacts'

Fields

maxResults :: Maybe Natural
The maximum number of records to list in a single response.
nextToken :: Maybe Text
A pagination token. Set to null to start listing artifacts from start. If a non-null pagination token is returned in a result, pass its value in here to list more artifacts.
appId :: Text
The unique ID for an Amplify app.
branchName :: Text
The name of a branch that is part of an Amplify app.
jobId :: Text
The unique ID for a job.

Instances

Instances details

ToHeaders ListArtifacts Source #
Instance details Defined in Amazonka.Amplify.ListArtifacts Methods toHeaders :: ListArtifacts -> [Header] #
ToPath ListArtifacts Source #
Instance details Defined in Amazonka.Amplify.ListArtifacts Methods toPath :: ListArtifacts -> ByteString #
ToQuery ListArtifacts Source #
Instance details Defined in Amazonka.Amplify.ListArtifacts Methods toQuery :: ListArtifacts -> QueryString #
AWSRequest ListArtifacts Source #
Instance details Defined in Amazonka.Amplify.ListArtifacts Associated Types type AWSResponse ListArtifacts # Methods request :: (Service -> Service) -> ListArtifacts -> Request ListArtifacts # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListArtifacts -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListArtifacts))) #
Generic ListArtifacts Source #
Instance details Defined in Amazonka.Amplify.ListArtifacts Associated Types type Rep ListArtifacts :: Type -> Type # Methods from :: ListArtifacts -> Rep ListArtifacts x # to :: Rep ListArtifacts x -> ListArtifacts #
Read ListArtifacts Source #
Instance details Defined in Amazonka.Amplify.ListArtifacts Methods readsPrec :: Int -> ReadS ListArtifacts # readList :: ReadS [ListArtifacts] # readPrec :: ReadPrec ListArtifacts # readListPrec :: ReadPrec [ListArtifacts] #
Show ListArtifacts Source #
Instance details Defined in Amazonka.Amplify.ListArtifacts Methods showsPrec :: Int -> ListArtifacts -> ShowS # show :: ListArtifacts -> String # showList :: [ListArtifacts] -> ShowS #
NFData ListArtifacts Source #
Instance details Defined in Amazonka.Amplify.ListArtifacts Methods rnf :: ListArtifacts -> () #
Eq ListArtifacts Source #
Instance details Defined in Amazonka.Amplify.ListArtifacts Methods (==) :: ListArtifacts -> ListArtifacts -> Bool # (/=) :: ListArtifacts -> ListArtifacts -> Bool #
Hashable ListArtifacts Source #
Instance details Defined in Amazonka.Amplify.ListArtifacts Methods hashWithSalt :: Int -> ListArtifacts -> Int # hash :: ListArtifacts -> Int #
type AWSResponse ListArtifacts Source #
Instance details Defined in Amazonka.Amplify.ListArtifacts type AWSResponse ListArtifacts = ListArtifactsResponse
type Rep ListArtifacts Source #
Instance details Defined in Amazonka.Amplify.ListArtifacts type Rep ListArtifacts = D1 ('MetaData "ListArtifacts" "Amazonka.Amplify.ListArtifacts" "amazonka-amplify-2.0-FzmP32buJCeA4C8B1HzWt" 'False) (C1 ('MetaCons "ListArtifacts'" '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 "appId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "branchName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newListArtifacts Source #

Arguments

:: Text	`ListArtifacts`
-> Text	`ListArtifacts`
-> Text	`ListArtifacts`
-> ListArtifacts

Create a value of ListArtifacts 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:ListArtifacts', listArtifacts_maxResults - The maximum number of records to list in a single response.

ListArtifacts, listArtifacts_nextToken - A pagination token. Set to null to start listing artifacts from start. If a non-null pagination token is returned in a result, pass its value in here to list more artifacts.

ListArtifacts, listArtifacts_appId - The unique ID for an Amplify app.

ListArtifacts, listArtifacts_branchName - The name of a branch that is part of an Amplify app.

ListArtifacts, listArtifacts_jobId - The unique ID for a job.

Request Lenses

listArtifacts_maxResults :: Lens' ListArtifacts (Maybe Natural) Source #

The maximum number of records to list in a single response.

listArtifacts_nextToken :: Lens' ListArtifacts (Maybe Text) Source #

A pagination token. Set to null to start listing artifacts from start. If a non-null pagination token is returned in a result, pass its value in here to list more artifacts.

listArtifacts_appId :: Lens' ListArtifacts Text Source #

The unique ID for an Amplify app.

listArtifacts_branchName :: Lens' ListArtifacts Text Source #

The name of a branch that is part of an Amplify app.

listArtifacts_jobId :: Lens' ListArtifacts Text Source #

The unique ID for a job.

Destructuring the Response

data ListArtifactsResponse Source #

The result structure for the list artifacts request.

See: newListArtifactsResponse smart constructor.

Constructors

ListArtifactsResponse'
Fields nextToken :: Maybe Text A pagination token. If a non-null pagination token is returned in a result, pass its value in another request to retrieve more entries. httpStatus :: Int The response's http status code. artifacts :: [Artifact] A list of artifacts.

Instances

Instances details

Generic ListArtifactsResponse Source #
Instance details Defined in Amazonka.Amplify.ListArtifacts Associated Types type Rep ListArtifactsResponse :: Type -> Type # Methods from :: ListArtifactsResponse -> Rep ListArtifactsResponse x # to :: Rep ListArtifactsResponse x -> ListArtifactsResponse #
Read ListArtifactsResponse Source #
Instance details Defined in Amazonka.Amplify.ListArtifacts Methods readsPrec :: Int -> ReadS ListArtifactsResponse # readList :: ReadS [ListArtifactsResponse] # readPrec :: ReadPrec ListArtifactsResponse # readListPrec :: ReadPrec [ListArtifactsResponse] #
Show ListArtifactsResponse Source #
Instance details Defined in Amazonka.Amplify.ListArtifacts Methods showsPrec :: Int -> ListArtifactsResponse -> ShowS # show :: ListArtifactsResponse -> String # showList :: [ListArtifactsResponse] -> ShowS #
NFData ListArtifactsResponse Source #
Instance details Defined in Amazonka.Amplify.ListArtifacts Methods rnf :: ListArtifactsResponse -> () #
Eq ListArtifactsResponse Source #
Instance details Defined in Amazonka.Amplify.ListArtifacts Methods (==) :: ListArtifactsResponse -> ListArtifactsResponse -> Bool # (/=) :: ListArtifactsResponse -> ListArtifactsResponse -> Bool #
type Rep ListArtifactsResponse Source #
Instance details Defined in Amazonka.Amplify.ListArtifacts type Rep ListArtifactsResponse = D1 ('MetaData "ListArtifactsResponse" "Amazonka.Amplify.ListArtifacts" "amazonka-amplify-2.0-FzmP32buJCeA4C8B1HzWt" 'False) (C1 ('MetaCons "ListArtifactsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: S1 ('MetaSel ('Just "artifacts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Artifact]))))

newListArtifactsResponse Source #

Arguments

:: Int	`$sel:httpStatus:ListArtifactsResponse'`
-> ListArtifactsResponse

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

ListArtifacts, listArtifactsResponse_nextToken - A pagination token. If a non-null pagination token is returned in a result, pass its value in another request to retrieve more entries.

$sel:httpStatus:ListArtifactsResponse', listArtifactsResponse_httpStatus - The response's http status code.

$sel:artifacts:ListArtifactsResponse', listArtifactsResponse_artifacts - A list of artifacts.

Response Lenses

listArtifactsResponse_nextToken :: Lens' ListArtifactsResponse (Maybe Text) Source #

A pagination token. If a non-null pagination token is returned in a result, pass its value in another request to retrieve more entries.

listArtifactsResponse_httpStatus :: Lens' ListArtifactsResponse Int Source #

The response's http status code.

listArtifactsResponse_artifacts :: Lens' ListArtifactsResponse [Artifact] Source #

A list of artifacts.