Amazonka.MigrationHub.AssociateCreatedArtifact

Associates a created artifact of an AWS cloud resource, the target receiving the migration, with the migration task performed by a migration tool. This API has the following traits:

• Migration tools can call the AssociateCreatedArtifact operation to indicate which AWS artifact is associated with a migration task.
• The created artifact name must be provided in ARN (Amazon Resource Name) format which will contain information about type and region; for example: arn:aws:ec2:us-east-1:488216288981:image/ami-6d0ba87b.
• Examples of the AWS resource behind the created artifact are, AMI's, EC2 instance, or DMS endpoint, etc.

Creating a Request

data AssociateCreatedArtifact

See: newAssociateCreatedArtifact smart constructor.

Constructors

AssociateCreatedArtifact'

Fields

• dryRun :: Maybe Bool

  Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call.

• progressUpdateStream :: Text

  The name of the ProgressUpdateStream.

• migrationTaskName :: Text

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

• createdArtifact :: CreatedArtifact

  An ARN of the AWS resource related to the migration (e.g., AMI, EC2 instance, RDS instance, etc.)

Instances

ToJSON AssociateCreatedArtifact

Defined in Amazonka.MigrationHub.AssociateCreatedArtifact

Methods

toJSON :: AssociateCreatedArtifact -> Value

toEncoding :: AssociateCreatedArtifact -> Encoding

toJSONList :: [AssociateCreatedArtifact] -> Value

toEncodingList :: [AssociateCreatedArtifact] -> Encoding

ToHeaders AssociateCreatedArtifact

Defined in Amazonka.MigrationHub.AssociateCreatedArtifact

Methods

toHeaders :: AssociateCreatedArtifact -> [Header]

ToPath AssociateCreatedArtifact

Defined in Amazonka.MigrationHub.AssociateCreatedArtifact

Methods

toPath :: AssociateCreatedArtifact -> ByteString

ToQuery AssociateCreatedArtifact

Defined in Amazonka.MigrationHub.AssociateCreatedArtifact

Methods

toQuery :: AssociateCreatedArtifact -> QueryString

AWSRequest AssociateCreatedArtifact

Defined in Amazonka.MigrationHub.AssociateCreatedArtifact

Associated Types

type AWSResponse AssociateCreatedArtifact

Methods

request :: (Service -> Service) -> AssociateCreatedArtifact -> Request AssociateCreatedArtifact

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy AssociateCreatedArtifact -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse AssociateCreatedArtifact)))

Generic AssociateCreatedArtifact

Defined in Amazonka.MigrationHub.AssociateCreatedArtifact

Associated Types

type Rep AssociateCreatedArtifact :: Type -> Type

Methods

from :: AssociateCreatedArtifact -> Rep AssociateCreatedArtifact x

to :: Rep AssociateCreatedArtifact x -> AssociateCreatedArtifact

Read AssociateCreatedArtifact

Defined in Amazonka.MigrationHub.AssociateCreatedArtifact

Methods

readsPrec :: Int -> ReadS AssociateCreatedArtifact

readList :: ReadS [AssociateCreatedArtifact]

readPrec :: ReadPrec AssociateCreatedArtifact

readListPrec :: ReadPrec [AssociateCreatedArtifact]

Show AssociateCreatedArtifact

Defined in Amazonka.MigrationHub.AssociateCreatedArtifact

Methods

showsPrec :: Int -> AssociateCreatedArtifact -> ShowS

show :: AssociateCreatedArtifact -> String

showList :: [AssociateCreatedArtifact] -> ShowS

NFData AssociateCreatedArtifact

Defined in Amazonka.MigrationHub.AssociateCreatedArtifact

Methods

rnf :: AssociateCreatedArtifact -> ()

Eq AssociateCreatedArtifact

Defined in Amazonka.MigrationHub.AssociateCreatedArtifact

Methods

(==) :: AssociateCreatedArtifact -> AssociateCreatedArtifact -> Bool

(/=) :: AssociateCreatedArtifact -> AssociateCreatedArtifact -> Bool

Hashable AssociateCreatedArtifact

Defined in Amazonka.MigrationHub.AssociateCreatedArtifact

Methods

hashWithSalt :: Int -> AssociateCreatedArtifact -> Int

hash :: AssociateCreatedArtifact -> Int

type AWSResponse AssociateCreatedArtifact

Defined in Amazonka.MigrationHub.AssociateCreatedArtifact

type AWSResponse AssociateCreatedArtifact = AssociateCreatedArtifactResponse

type Rep AssociateCreatedArtifact

Defined in Amazonka.MigrationHub.AssociateCreatedArtifact

type Rep AssociateCreatedArtifact = D1 ('MetaData "AssociateCreatedArtifact" "Amazonka.MigrationHub.AssociateCreatedArtifact" "amazonka-migrationhub-2.0-HPFHfkzHnlJDPxcpvPbrRQ" 'False) (C1 ('MetaCons "AssociateCreatedArtifact'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dryRun") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "progressUpdateStream") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "migrationTaskName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "createdArtifact") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 CreatedArtifact))))

newAssociateCreatedArtifact

Arguments

:: Text

AssociateCreatedArtifact

-> Text

AssociateCreatedArtifact

-> CreatedArtifact

$sel:createdArtifact:AssociateCreatedArtifact'

-> AssociateCreatedArtifact

Create a value of AssociateCreatedArtifact 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:dryRun:AssociateCreatedArtifact', associateCreatedArtifact_dryRun - Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call.

AssociateCreatedArtifact, associateCreatedArtifact_progressUpdateStream - The name of the ProgressUpdateStream.

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

$sel:createdArtifact:AssociateCreatedArtifact', associateCreatedArtifact_createdArtifact - An ARN of the AWS resource related to the migration (e.g., AMI, EC2 instance, RDS instance, etc.)

Request Lenses

associateCreatedArtifact_dryRun :: Lens' AssociateCreatedArtifact (Maybe Bool)

Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call.

associateCreatedArtifact_progressUpdateStream :: Lens' AssociateCreatedArtifact Text

The name of the ProgressUpdateStream.

associateCreatedArtifact_migrationTaskName :: Lens' AssociateCreatedArtifact Text

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

associateCreatedArtifact_createdArtifact :: Lens' AssociateCreatedArtifact CreatedArtifact

An ARN of the AWS resource related to the migration (e.g., AMI, EC2 instance, RDS instance, etc.)

Destructuring the Response

data AssociateCreatedArtifactResponse

See: newAssociateCreatedArtifactResponse smart constructor.

Constructors

AssociateCreatedArtifactResponse'

Fields

• httpStatus :: Int

  The response's http status code.

Instances

Generic AssociateCreatedArtifactResponse

Defined in Amazonka.MigrationHub.AssociateCreatedArtifact

Associated Types

type Rep AssociateCreatedArtifactResponse :: Type -> Type

Methods

from :: AssociateCreatedArtifactResponse -> Rep AssociateCreatedArtifactResponse x

to :: Rep AssociateCreatedArtifactResponse x -> AssociateCreatedArtifactResponse

Read AssociateCreatedArtifactResponse

Defined in Amazonka.MigrationHub.AssociateCreatedArtifact

Methods

readsPrec :: Int -> ReadS AssociateCreatedArtifactResponse

readList :: ReadS [AssociateCreatedArtifactResponse]

readPrec :: ReadPrec AssociateCreatedArtifactResponse

readListPrec :: ReadPrec [AssociateCreatedArtifactResponse]

Show AssociateCreatedArtifactResponse

Defined in Amazonka.MigrationHub.AssociateCreatedArtifact

Methods

showsPrec :: Int -> AssociateCreatedArtifactResponse -> ShowS

show :: AssociateCreatedArtifactResponse -> String

showList :: [AssociateCreatedArtifactResponse] -> ShowS

NFData AssociateCreatedArtifactResponse

Defined in Amazonka.MigrationHub.AssociateCreatedArtifact

Methods

rnf :: AssociateCreatedArtifactResponse -> ()

Eq AssociateCreatedArtifactResponse

Defined in Amazonka.MigrationHub.AssociateCreatedArtifact

Methods

(==) :: AssociateCreatedArtifactResponse -> AssociateCreatedArtifactResponse -> Bool

(/=) :: AssociateCreatedArtifactResponse -> AssociateCreatedArtifactResponse -> Bool

type Rep AssociateCreatedArtifactResponse

Defined in Amazonka.MigrationHub.AssociateCreatedArtifact

type Rep AssociateCreatedArtifactResponse = D1 ('MetaData "AssociateCreatedArtifactResponse" "Amazonka.MigrationHub.AssociateCreatedArtifact" "amazonka-migrationhub-2.0-HPFHfkzHnlJDPxcpvPbrRQ" 'False) (C1 ('MetaCons "AssociateCreatedArtifactResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newAssociateCreatedArtifactResponse

Arguments

:: Int

$sel:httpStatus:AssociateCreatedArtifactResponse'

-> AssociateCreatedArtifactResponse

Create a value of AssociateCreatedArtifactResponse 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:httpStatus:AssociateCreatedArtifactResponse', associateCreatedArtifactResponse_httpStatus - The response's http status code.

Response Lenses

associateCreatedArtifactResponse_httpStatus :: Lens' AssociateCreatedArtifactResponse Int

The response's http status code.