libZSservicesZSamazonka-migrationhubZSamazonka-migrationhub
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.MigrationHub.ListCreatedArtifacts

Description

Lists the created artifacts attached to a given migration task in an update stream. This API has the following traits:

  • Gets the list of the created artifacts while migration is taking place.
  • Shows the artifacts created by the migration tool that was associated by the AssociateCreatedArtifact API.
  • Lists created artifacts in a paginated interface.

This operation returns paginated results.

Synopsis

Creating a Request

data ListCreatedArtifacts Source #

See: newListCreatedArtifacts smart constructor.

Constructors

ListCreatedArtifacts' 

Fields

  • nextToken :: Maybe Text

    If a NextToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in NextToken.

  • maxResults :: Maybe Natural

    Maximum number of results to be returned per page.

  • progressUpdateStream :: Text

    The name of the ProgressUpdateStream.

  • migrationTaskName :: Text

    Unique identifier that references the migration task. /Do not store personal data in this field./

Instances

Instances details
Eq ListCreatedArtifacts Source # 
Instance details

Defined in Amazonka.MigrationHub.ListCreatedArtifacts

Read ListCreatedArtifacts Source # 
Instance details

Defined in Amazonka.MigrationHub.ListCreatedArtifacts

Show ListCreatedArtifacts Source # 
Instance details

Defined in Amazonka.MigrationHub.ListCreatedArtifacts

Generic ListCreatedArtifacts Source # 
Instance details

Defined in Amazonka.MigrationHub.ListCreatedArtifacts

Associated Types

type Rep ListCreatedArtifacts :: Type -> Type #

NFData ListCreatedArtifacts Source # 
Instance details

Defined in Amazonka.MigrationHub.ListCreatedArtifacts

Methods

rnf :: ListCreatedArtifacts -> () #

Hashable ListCreatedArtifacts Source # 
Instance details

Defined in Amazonka.MigrationHub.ListCreatedArtifacts

ToJSON ListCreatedArtifacts Source # 
Instance details

Defined in Amazonka.MigrationHub.ListCreatedArtifacts

AWSPager ListCreatedArtifacts Source # 
Instance details

Defined in Amazonka.MigrationHub.ListCreatedArtifacts

AWSRequest ListCreatedArtifacts Source # 
Instance details

Defined in Amazonka.MigrationHub.ListCreatedArtifacts

Associated Types

type AWSResponse ListCreatedArtifacts #

ToHeaders ListCreatedArtifacts Source # 
Instance details

Defined in Amazonka.MigrationHub.ListCreatedArtifacts

ToPath ListCreatedArtifacts Source # 
Instance details

Defined in Amazonka.MigrationHub.ListCreatedArtifacts

ToQuery ListCreatedArtifacts Source # 
Instance details

Defined in Amazonka.MigrationHub.ListCreatedArtifacts

type Rep ListCreatedArtifacts Source # 
Instance details

Defined in Amazonka.MigrationHub.ListCreatedArtifacts

type Rep ListCreatedArtifacts = D1 ('MetaData "ListCreatedArtifacts" "Amazonka.MigrationHub.ListCreatedArtifacts" "libZSservicesZSamazonka-migrationhubZSamazonka-migrationhub" 'False) (C1 ('MetaCons "ListCreatedArtifacts'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :*: (S1 ('MetaSel ('Just "progressUpdateStream") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "migrationTaskName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse ListCreatedArtifacts Source # 
Instance details

Defined in Amazonka.MigrationHub.ListCreatedArtifacts

newListCreatedArtifacts Source #

Create a value of ListCreatedArtifacts 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:nextToken:ListCreatedArtifacts', listCreatedArtifacts_nextToken - If a NextToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in NextToken.

$sel:maxResults:ListCreatedArtifacts', listCreatedArtifacts_maxResults - Maximum number of results to be returned per page.

$sel:progressUpdateStream:ListCreatedArtifacts', listCreatedArtifacts_progressUpdateStream - The name of the ProgressUpdateStream.

$sel:migrationTaskName:ListCreatedArtifacts', listCreatedArtifacts_migrationTaskName - Unique identifier that references the migration task. /Do not store personal data in this field./

Request Lenses

listCreatedArtifacts_nextToken :: Lens' ListCreatedArtifacts (Maybe Text) Source #

If a NextToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in NextToken.

listCreatedArtifacts_maxResults :: Lens' ListCreatedArtifacts (Maybe Natural) Source #

Maximum number of results to be returned per page.

listCreatedArtifacts_migrationTaskName :: Lens' ListCreatedArtifacts Text Source #

Unique identifier that references the migration task. /Do not store personal data in this field./

Destructuring the Response

data ListCreatedArtifactsResponse Source #

See: newListCreatedArtifactsResponse smart constructor.

Constructors

ListCreatedArtifactsResponse' 

Fields

  • nextToken :: Maybe Text

    If there are more created artifacts than the max result, return the next token to be passed to the next call as a bookmark of where to start from.

  • createdArtifactList :: Maybe [CreatedArtifact]

    List of created artifacts up to the maximum number of results specified in the request.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq ListCreatedArtifactsResponse Source # 
Instance details

Defined in Amazonka.MigrationHub.ListCreatedArtifacts

Read ListCreatedArtifactsResponse Source # 
Instance details

Defined in Amazonka.MigrationHub.ListCreatedArtifacts

Show ListCreatedArtifactsResponse Source # 
Instance details

Defined in Amazonka.MigrationHub.ListCreatedArtifacts

Generic ListCreatedArtifactsResponse Source # 
Instance details

Defined in Amazonka.MigrationHub.ListCreatedArtifacts

Associated Types

type Rep ListCreatedArtifactsResponse :: Type -> Type #

NFData ListCreatedArtifactsResponse Source # 
Instance details

Defined in Amazonka.MigrationHub.ListCreatedArtifacts

type Rep ListCreatedArtifactsResponse Source # 
Instance details

Defined in Amazonka.MigrationHub.ListCreatedArtifacts

type Rep ListCreatedArtifactsResponse = D1 ('MetaData "ListCreatedArtifactsResponse" "Amazonka.MigrationHub.ListCreatedArtifacts" "libZSservicesZSamazonka-migrationhubZSamazonka-migrationhub" 'False) (C1 ('MetaCons "ListCreatedArtifactsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "createdArtifactList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [CreatedArtifact])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListCreatedArtifactsResponse Source #

Create a value of ListCreatedArtifactsResponse 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:nextToken:ListCreatedArtifacts', listCreatedArtifactsResponse_nextToken - If there are more created artifacts than the max result, return the next token to be passed to the next call as a bookmark of where to start from.

$sel:createdArtifactList:ListCreatedArtifactsResponse', listCreatedArtifactsResponse_createdArtifactList - List of created artifacts up to the maximum number of results specified in the request.

$sel:httpStatus:ListCreatedArtifactsResponse', listCreatedArtifactsResponse_httpStatus - The response's http status code.

Response Lenses

listCreatedArtifactsResponse_nextToken :: Lens' ListCreatedArtifactsResponse (Maybe Text) Source #

If there are more created artifacts than the max result, return the next token to be passed to the next call as a bookmark of where to start from.

listCreatedArtifactsResponse_createdArtifactList :: Lens' ListCreatedArtifactsResponse (Maybe [CreatedArtifact]) Source #

List of created artifacts up to the maximum number of results specified in the request.