update_replication_job

SMS.Client.update_replication_job(**kwargs)

Updates the specified settings for the specified replication job.

See also: AWS API Documentation

Request Syntax

response = client.update_replication_job(
    replicationJobId='string',
    frequency=123,
    nextReplicationRunStartTime=datetime(2015, 1, 1),
    licenseType='AWS'|'BYOL',
    roleName='string',
    description='string',
    numberOfRecentAmisToKeep=123,
    encrypted=True|False,
    kmsKeyId='string'
)

Parameters

• replicationJobId (string) --

  [REQUIRED]

  The ID of the replication job.

• frequency (integer) -- The time between consecutive replication runs, in hours.
• nextReplicationRunStartTime (datetime) -- The start time of the next replication run.
• licenseType (string) -- The license type to be used for the AMI created by a successful replication run.
• roleName (string) -- The name of the IAM role to be used by Server Migration Service.
• description (string) -- The description of the replication job.
• numberOfRecentAmisToKeep (integer) -- The maximum number of SMS-created AMIs to retain. The oldest is deleted after the maximum number is reached and a new AMI is created.
• encrypted (boolean) -- When true, the replication job produces encrypted AMIs. For more information, KmsKeyId .
• kmsKeyId (string) --

  The ID of the KMS key for replication jobs that produce encrypted AMIs. This value can be any of the following:

  • KMS key ID
  • KMS key alias
  • ARN referring to the KMS key ID
  • ARN referring to the KMS key alias

  If encrypted is enabled but a KMS key ID is not specified, the customer's default KMS key for Amazon EBS is used.

Return type

dict

Returns

Response Syntax

{}

Response Structure

• (dict) --

Exceptions

• SMS.Client.exceptions.InvalidParameterException
• SMS.Client.exceptions.MissingRequiredParameterException
• SMS.Client.exceptions.OperationNotPermittedException
• SMS.Client.exceptions.UnauthorizedOperationException
• SMS.Client.exceptions.ServerCannotBeReplicatedException
• SMS.Client.exceptions.ReplicationJobNotFoundException
• SMS.Client.exceptions.InternalError
• SMS.Client.exceptions.TemporarilyUnavailableException