Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.MigrationHub.PutResourceAttributes

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Provides identifying details of the resource being migrated so that it can be associated in the Application Discovery Service repository. This association occurs asynchronously after PutResourceAttributes returns.

Keep in mind that subsequent calls to PutResourceAttributes will override previously stored attributes. For example, if it is first called with a MAC address, but later, it is desired to add an IP address, it will then be required to call it with both the IP and MAC addresses to prevent overriding the MAC address.
Note the instructions regarding the special use case of the ResourceAttributeList parameter when specifying any "VM" related value.

Because this is an asynchronous call, it will always return 200, whether an association occurs or not. To confirm if an association was found based on the provided details, call ListDiscoveredResources.

Synopsis

Creating a Request

data PutResourceAttributes Source #

See: newPutResourceAttributes smart constructor.

Constructors

PutResourceAttributes'

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./
resourceAttributeList :: NonEmpty ResourceAttribute
Information about the resource that is being migrated. This data will be used to map the task to a resource in the Application Discovery Service repository.
Takes the object array of ResourceAttribute where the Type field is reserved for the following values: IPV4_ADDRESS | IPV6_ADDRESS | MAC_ADDRESS | FQDN | VM_MANAGER_ID | VM_MANAGED_OBJECT_REFERENCE | VM_NAME | VM_PATH | BIOS_ID | MOTHERBOARD_SERIAL_NUMBER where the identifying value can be a string up to 256 characters.
- If any "VM" related value is set for a ResourceAttribute object, it is required that VM_MANAGER_ID, as a minimum, is always set. If VM_MANAGER_ID is not set, then all "VM" fields will be discarded and "VM" fields will not be used for matching the migration task to a server in Application Discovery Service repository. See the Example section below for a use case of specifying "VM" related values.
- If a server you are trying to match has multiple IP or MAC addresses, you should provide as many as you know in separate type/value pairs passed to the ResourceAttributeList parameter to maximize the chances of matching.

Instances

Instances details

Eq PutResourceAttributes Source #
Instance details Defined in Amazonka.MigrationHub.PutResourceAttributes Methods (==) :: PutResourceAttributes -> PutResourceAttributes -> Bool # (/=) :: PutResourceAttributes -> PutResourceAttributes -> Bool #
Read PutResourceAttributes Source #
Instance details Defined in Amazonka.MigrationHub.PutResourceAttributes Methods readsPrec :: Int -> ReadS PutResourceAttributes # readList :: ReadS [PutResourceAttributes] # readPrec :: ReadPrec PutResourceAttributes # readListPrec :: ReadPrec [PutResourceAttributes] #
Show PutResourceAttributes Source #
Instance details Defined in Amazonka.MigrationHub.PutResourceAttributes Methods showsPrec :: Int -> PutResourceAttributes -> ShowS # show :: PutResourceAttributes -> String # showList :: [PutResourceAttributes] -> ShowS #
Generic PutResourceAttributes Source #
Instance details Defined in Amazonka.MigrationHub.PutResourceAttributes Associated Types type Rep PutResourceAttributes :: Type -> Type # Methods from :: PutResourceAttributes -> Rep PutResourceAttributes x # to :: Rep PutResourceAttributes x -> PutResourceAttributes #
NFData PutResourceAttributes Source #
Instance details Defined in Amazonka.MigrationHub.PutResourceAttributes Methods rnf :: PutResourceAttributes -> () #
Hashable PutResourceAttributes Source #
Instance details Defined in Amazonka.MigrationHub.PutResourceAttributes Methods hashWithSalt :: Int -> PutResourceAttributes -> Int # hash :: PutResourceAttributes -> Int #
ToJSON PutResourceAttributes Source #
Instance details Defined in Amazonka.MigrationHub.PutResourceAttributes Methods toJSON :: PutResourceAttributes -> Value # toEncoding :: PutResourceAttributes -> Encoding # toJSONList :: [PutResourceAttributes] -> Value # toEncodingList :: [PutResourceAttributes] -> Encoding #
AWSRequest PutResourceAttributes Source #
Instance details Defined in Amazonka.MigrationHub.PutResourceAttributes Associated Types type AWSResponse PutResourceAttributes # Methods request :: PutResourceAttributes -> Request PutResourceAttributes # response :: MonadResource m => Logger -> Service -> Proxy PutResourceAttributes -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse PutResourceAttributes))) #
ToHeaders PutResourceAttributes Source #
Instance details Defined in Amazonka.MigrationHub.PutResourceAttributes Methods toHeaders :: PutResourceAttributes -> [Header] #
ToPath PutResourceAttributes Source #
Instance details Defined in Amazonka.MigrationHub.PutResourceAttributes Methods toPath :: PutResourceAttributes -> ByteString #
ToQuery PutResourceAttributes Source #
Instance details Defined in Amazonka.MigrationHub.PutResourceAttributes Methods toQuery :: PutResourceAttributes -> QueryString #
type Rep PutResourceAttributes Source #
Instance details Defined in Amazonka.MigrationHub.PutResourceAttributes type Rep PutResourceAttributes = D1 ('MetaData "PutResourceAttributes" "Amazonka.MigrationHub.PutResourceAttributes" "libZSservicesZSamazonka-migrationhubZSamazonka-migrationhub" 'False) (C1 ('MetaCons "PutResourceAttributes'" '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 "resourceAttributeList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty ResourceAttribute)))))
type AWSResponse PutResourceAttributes Source #
Instance details Defined in Amazonka.MigrationHub.PutResourceAttributes type AWSResponse PutResourceAttributes = PutResourceAttributesResponse

newPutResourceAttributes Source #

Arguments

:: Text	`$sel:progressUpdateStream:PutResourceAttributes'`
-> Text	`$sel:migrationTaskName:PutResourceAttributes'`
-> NonEmpty ResourceAttribute	`$sel:resourceAttributeList:PutResourceAttributes'`
-> PutResourceAttributes

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

$sel:progressUpdateStream:PutResourceAttributes', putResourceAttributes_progressUpdateStream - The name of the ProgressUpdateStream.

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

$sel:resourceAttributeList:PutResourceAttributes', putResourceAttributes_resourceAttributeList - Information about the resource that is being migrated. This data will be used to map the task to a resource in the Application Discovery Service repository.

If any "VM" related value is set for a ResourceAttribute object, it is required that VM_MANAGER_ID, as a minimum, is always set. If VM_MANAGER_ID is not set, then all "VM" fields will be discarded and "VM" fields will not be used for matching the migration task to a server in Application Discovery Service repository. See the Example section below for a use case of specifying "VM" related values.
If a server you are trying to match has multiple IP or MAC addresses, you should provide as many as you know in separate type/value pairs passed to the ResourceAttributeList parameter to maximize the chances of matching.

Request Lenses

putResourceAttributes_dryRun :: Lens' PutResourceAttributes (Maybe Bool) Source #

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

putResourceAttributes_progressUpdateStream :: Lens' PutResourceAttributes Text Source #

The name of the ProgressUpdateStream.

putResourceAttributes_migrationTaskName :: Lens' PutResourceAttributes Text Source #

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

putResourceAttributes_resourceAttributeList :: Lens' PutResourceAttributes (NonEmpty ResourceAttribute) Source #

Information about the resource that is being migrated. This data will be used to map the task to a resource in the Application Discovery Service repository.

If any "VM" related value is set for a ResourceAttribute object, it is required that VM_MANAGER_ID, as a minimum, is always set. If VM_MANAGER_ID is not set, then all "VM" fields will be discarded and "VM" fields will not be used for matching the migration task to a server in Application Discovery Service repository. See the Example section below for a use case of specifying "VM" related values.
If a server you are trying to match has multiple IP or MAC addresses, you should provide as many as you know in separate type/value pairs passed to the ResourceAttributeList parameter to maximize the chances of matching.

Destructuring the Response

data PutResourceAttributesResponse Source #

See: newPutResourceAttributesResponse smart constructor.

Constructors

PutResourceAttributesResponse'
Fields httpStatus :: Int The response's http status code.

Instances

Instances details

Eq PutResourceAttributesResponse Source #
Instance details Defined in Amazonka.MigrationHub.PutResourceAttributes Methods (==) :: PutResourceAttributesResponse -> PutResourceAttributesResponse -> Bool # (/=) :: PutResourceAttributesResponse -> PutResourceAttributesResponse -> Bool #
Read PutResourceAttributesResponse Source #
Instance details Defined in Amazonka.MigrationHub.PutResourceAttributes Methods readsPrec :: Int -> ReadS PutResourceAttributesResponse # readList :: ReadS [PutResourceAttributesResponse] # readPrec :: ReadPrec PutResourceAttributesResponse # readListPrec :: ReadPrec [PutResourceAttributesResponse] #
Show PutResourceAttributesResponse Source #
Instance details Defined in Amazonka.MigrationHub.PutResourceAttributes Methods showsPrec :: Int -> PutResourceAttributesResponse -> ShowS # show :: PutResourceAttributesResponse -> String # showList :: [PutResourceAttributesResponse] -> ShowS #
Generic PutResourceAttributesResponse Source #
Instance details Defined in Amazonka.MigrationHub.PutResourceAttributes Associated Types type Rep PutResourceAttributesResponse :: Type -> Type # Methods from :: PutResourceAttributesResponse -> Rep PutResourceAttributesResponse x # to :: Rep PutResourceAttributesResponse x -> PutResourceAttributesResponse #
NFData PutResourceAttributesResponse Source #
Instance details Defined in Amazonka.MigrationHub.PutResourceAttributes Methods rnf :: PutResourceAttributesResponse -> () #
type Rep PutResourceAttributesResponse Source #
Instance details Defined in Amazonka.MigrationHub.PutResourceAttributes type Rep PutResourceAttributesResponse = D1 ('MetaData "PutResourceAttributesResponse" "Amazonka.MigrationHub.PutResourceAttributes" "libZSservicesZSamazonka-migrationhubZSamazonka-migrationhub" 'False) (C1 ('MetaCons "PutResourceAttributesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newPutResourceAttributesResponse Source #

Arguments

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

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

Response Lenses

putResourceAttributesResponse_httpStatus :: Lens' PutResourceAttributesResponse Int Source #

The response's http status code.