Class: Aws::SMS::Client

Inherits:
Seahorse::Client::Base show all
Includes:
ClientStubs
Defined in:
gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb

Overview

An API client for SMS. To construct a client, you need to configure a :region and :credentials.

client = Aws::SMS::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the developer guide.

See #initialize for a full list of supported configuration options.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :credentials (required, Aws::CredentialProvider)

    Your AWS credentials. This can be an instance of any one of the following classes:

    • Aws::Credentials - Used for configuring static, non-refreshing credentials.

    • Aws::SharedCredentials - Used for loading static credentials from a shared file, such as ~/.aws/config.

    • Aws::AssumeRoleCredentials - Used when you need to assume a role.

    • Aws::AssumeRoleWebIdentityCredentials - Used when you need to assume a role after providing credentials via the web.

    • Aws::SSOCredentials - Used for loading credentials from AWS SSO using an access token generated from aws login.

    • Aws::ProcessCredentials - Used for loading credentials from a process that outputs to stdout.

    • Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • Aws::ECSCredentials - Used for loading credentials from instances running in ECS.

    • Aws::CognitoIdentityCredentials - Used for loading credentials from the Cognito Identity service.

    When :credentials are not configured directly, the following locations will be searched for credentials:

    • Aws.config[:credentials]
    • The :access_key_id, :secret_access_key, and :session_token options.
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • ~/.aws/credentials
    • ~/.aws/config
    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentails or Aws::ECSCredentials to enable retries and extended timeouts.
  • :region (required, String)

    The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is searched for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :active_endpoint_cache (Boolean) — default: false

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true

    Used only in adaptive retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a RetryCapacityNotAvailableError and will not retry instead of sleeping.

  • :client_side_monitoring (Boolean) — default: false

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: ""

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1"

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true

    When true, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :disable_host_prefix_injection (Boolean) — default: false

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :endpoint (String)

    The client endpoint is normally constructed from the :region option. You should only configure an :endpoint when connecting to test or custom endpoints. This should be a valid HTTP(S) URI.

  • :endpoint_cache_max_entries (Integer) — default: 1000

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false

    When set to true, endpoint discovery will be enabled for operations when available.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default

    The log formatter.

  • :log_level (Symbol) — default: :info

    The log level to send messages to the :logger at.

  • :logger (Logger)

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in standard and adaptive retry modes.

  • :profile (String) — default: "default"

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :retry_backoff (Proc)

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

  • :retry_base_delay (Float) — default: 0.3

    The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_jitter (Symbol) — default: :none

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the legacy retry mode.

    @see https://www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.

  • :retry_max_delay (Integer) — default: 0

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_mode (String) — default: "legacy"

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior. This is default value if no retry mode is provided.

    • standard - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • adaptive - An experimental retry mode that includes all the functionality of standard mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :secret_access_key (String)
  • :session_token (String)
  • :simple_json (Boolean) — default: false

    Disables request parameter conversion, validation, and formatting. Also disable response data type conversions. This option is useful when you want to ensure the highest level of performance by avoiding overhead of walking request parameters and response data structures.

    When :simple_json is enabled, the request parameters hash must be formatted exactly as the DynamoDB API expects.

  • :stub_responses (Boolean) — default: false

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :validate_params (Boolean) — default: true

    When true, request parameters are validated before sending the request.

  • :http_proxy (URI::HTTP, String)

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_open_timeout (Float) — default: 15

    The number of seconds to wait when opening a HTTP session before raising a Timeout::Error.

  • :http_read_timeout (Integer) — default: 60

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_idle_timeout (Float) — default: 5

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_continue_timeout (Float) — default: 1

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to nil which disables this behaviour. This value can safely be set per request on the session.

  • :http_wire_trace (Boolean) — default: false

    When true, HTTP debug output will be sent to the :logger.

  • :ssl_verify_peer (Boolean) — default: true

    When true, SSL peer certificates are verified when establishing a connection.

  • :ssl_ca_bundle (String)

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_directory (String)

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.



334
335
336
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 334

def initialize(*args)
  super
end

Instance Method Details

#create_app(params = {}) ⇒ Types::CreateAppResponse

Creates an application. An application consists of one or more server groups. Each server group contain one or more servers.

Examples:

Request syntax with placeholder values


resp = client.create_app({
  name: "AppName",
  description: "AppDescription",
  role_name: "RoleName",
  client_token: "ClientToken",
  server_groups: [
    {
      server_group_id: "ServerGroupId",
      name: "ServerGroupName",
      server_list: [
        {
          server_id: "ServerId",
          server_type: "VIRTUAL_MACHINE", # accepts VIRTUAL_MACHINE
          vm_server: {
            vm_server_address: {
              vm_manager_id: "VmManagerId",
              vm_id: "VmId",
            },
            vm_name: "VmName",
            vm_manager_name: "VmManagerName",
            vm_manager_type: "VSPHERE", # accepts VSPHERE, SCVMM, HYPERV-MANAGER
            vm_path: "VmPath",
          },
          replication_job_id: "ReplicationJobId",
          replication_job_terminated: false,
        },
      ],
    },
  ],
  tags: [
    {
      key: "TagKey",
      value: "TagValue",
    },
  ],
})

Response structure


resp.app_summary.app_id #=> String
resp.app_summary.imported_app_id #=> String
resp.app_summary.name #=> String
resp.app_summary.description #=> String
resp.app_summary.status #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "DELETED", "DELETE_FAILED"
resp.app_summary.status_message #=> String
resp.app_summary.replication_configuration_status #=> String, one of "NOT_CONFIGURED", "CONFIGURED"
resp.app_summary.replication_status #=> String, one of "READY_FOR_CONFIGURATION", "CONFIGURATION_IN_PROGRESS", "CONFIGURATION_INVALID", "READY_FOR_REPLICATION", "VALIDATION_IN_PROGRESS", "REPLICATION_PENDING", "REPLICATION_IN_PROGRESS", "REPLICATED", "PARTIALLY_REPLICATED", "DELTA_REPLICATION_IN_PROGRESS", "DELTA_REPLICATED", "DELTA_REPLICATION_FAILED", "REPLICATION_FAILED", "REPLICATION_STOPPING", "REPLICATION_STOP_FAILED", "REPLICATION_STOPPED"
resp.app_summary.replication_status_message #=> String
resp.app_summary.latest_replication_time #=> Time
resp.app_summary.launch_configuration_status #=> String, one of "NOT_CONFIGURED", "CONFIGURED"
resp.app_summary.launch_status #=> String, one of "READY_FOR_CONFIGURATION", "CONFIGURATION_IN_PROGRESS", "CONFIGURATION_INVALID", "READY_FOR_LAUNCH", "VALIDATION_IN_PROGRESS", "LAUNCH_PENDING", "LAUNCH_IN_PROGRESS", "LAUNCHED", "PARTIALLY_LAUNCHED", "DELTA_LAUNCH_IN_PROGRESS", "DELTA_LAUNCH_FAILED", "LAUNCH_FAILED", "TERMINATE_IN_PROGRESS", "TERMINATE_FAILED", "TERMINATED"
resp.app_summary.launch_status_message #=> String
resp.app_summary.launch_details.latest_launch_time #=> Time
resp.app_summary.launch_details.stack_name #=> String
resp.app_summary.launch_details.stack_id #=> String
resp.app_summary.creation_time #=> Time
resp.app_summary.last_modified #=> Time
resp.app_summary.role_name #=> String
resp.app_summary.total_server_groups #=> Integer
resp.app_summary.total_servers #=> Integer
resp.server_groups #=> Array
resp.server_groups[0].server_group_id #=> String
resp.server_groups[0].name #=> String
resp.server_groups[0].server_list #=> Array
resp.server_groups[0].server_list[0].server_id #=> String
resp.server_groups[0].server_list[0].server_type #=> String, one of "VIRTUAL_MACHINE"
resp.server_groups[0].server_list[0].vm_server.vm_server_address.vm_manager_id #=> String
resp.server_groups[0].server_list[0].vm_server.vm_server_address.vm_id #=> String
resp.server_groups[0].server_list[0].vm_server.vm_name #=> String
resp.server_groups[0].server_list[0].vm_server.vm_manager_name #=> String
resp.server_groups[0].server_list[0].vm_server.vm_manager_type #=> String, one of "VSPHERE", "SCVMM", "HYPERV-MANAGER"
resp.server_groups[0].server_list[0].vm_server.vm_path #=> String
resp.server_groups[0].server_list[0].replication_job_id #=> String
resp.server_groups[0].server_list[0].replication_job_terminated #=> Boolean
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :name (String)

    The name of the new application.

  • :description (String)

    The description of the new application

  • :role_name (String)

    The name of the service role in the customer's account to be used by AWS SMS.

  • :client_token (String)

    A unique, case-sensitive identifier that you provide to ensure the idempotency of application creation.

  • :server_groups (Array<Types::ServerGroup>)

    The server groups to include in the application.

  • :tags (Array<Types::Tag>)

    The tags to be associated with the application.

Returns:

See Also:



453
454
455
456
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 453

def create_app(params = {}, options = {})
  req = build_request(:create_app, params)
  req.send_request(options)
end

#create_replication_job(params = {}) ⇒ Types::CreateReplicationJobResponse

Creates a replication job. The replication job schedules periodic replication runs to replicate your server to AWS. Each replication run creates an Amazon Machine Image (AMI).

Examples:

Request syntax with placeholder values


resp = client.create_replication_job({
  server_id: "ServerId", # required
  seed_replication_time: Time.now, # required
  frequency: 1,
  run_once: false,
  license_type: "AWS", # accepts AWS, BYOL
  role_name: "RoleName",
  description: "Description",
  number_of_recent_amis_to_keep: 1,
  encrypted: false,
  kms_key_id: "KmsKeyId",
})

Response structure


resp.replication_job_id #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :server_id (required, String)

    The ID of the server.

  • :seed_replication_time (required, Time, DateTime, Date, Integer, String)

    The seed replication time.

  • :frequency (Integer)

    The time between consecutive replication runs, in hours.

  • :run_once (Boolean)

    Indicates whether to run the replication job one time.

  • :license_type (String)

    The license type to be used for the AMI created by a successful replication run.

  • :role_name (String)

    The name of the IAM role to be used by the AWS SMS.

  • :description (String)

    The description of the replication job.

  • :number_of_recent_amis_to_keep (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)

    Indicates whether the replication job produces encrypted AMIs.

  • :kms_key_id (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 true but a KMS key ID is not specified, the customer's default KMS key for Amazon EBS is used.

Returns:

See Also:



533
534
535
536
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 533

def create_replication_job(params = {}, options = {})
  req = build_request(:create_replication_job, params)
  req.send_request(options)
end

#delete_app(params = {}) ⇒ Struct

Deletes the specified application. Optionally deletes the launched stack associated with the application and all AWS SMS replication jobs for servers in the application.

Examples:

Request syntax with placeholder values


resp = client.delete_app({
  app_id: "AppId",
  force_stop_app_replication: false,
  force_terminate_app: false,
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :app_id (String)

    The ID of the application.

  • :force_stop_app_replication (Boolean)

    Indicates whether to stop all replication jobs corresponding to the servers in the application while deleting the application.

  • :force_terminate_app (Boolean)

    Indicates whether to terminate the stack corresponding to the application while deleting the application.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



567
568
569
570
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 567

def delete_app(params = {}, options = {})
  req = build_request(:delete_app, params)
  req.send_request(options)
end

#delete_app_launch_configuration(params = {}) ⇒ Struct

Deletes the launch configuration for the specified application.

Examples:

Request syntax with placeholder values


resp = client.delete_app_launch_configuration({
  app_id: "AppId",
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :app_id (String)

    The ID of the application.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



589
590
591
592
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 589

def delete_app_launch_configuration(params = {}, options = {})
  req = build_request(:delete_app_launch_configuration, params)
  req.send_request(options)
end

#delete_app_replication_configuration(params = {}) ⇒ Struct

Deletes the replication configuration for the specified application.

Examples:

Request syntax with placeholder values


resp = client.delete_app_replication_configuration({
  app_id: "AppId",
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :app_id (String)

    The ID of the application.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



611
612
613
614
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 611

def delete_app_replication_configuration(params = {}, options = {})
  req = build_request(:delete_app_replication_configuration, params)
  req.send_request(options)
end

#delete_app_validation_configuration(params = {}) ⇒ Struct

Deletes the validation configuration for the specified application.

Examples:

Request syntax with placeholder values


resp = client.delete_app_validation_configuration({
  app_id: "AppIdWithValidation", # required
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :app_id (required, String)

    The ID of the application.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



633
634
635
636
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 633

def delete_app_validation_configuration(params = {}, options = {})
  req = build_request(:delete_app_validation_configuration, params)
  req.send_request(options)
end

#delete_replication_job(params = {}) ⇒ Struct

Deletes the specified replication job.

After you delete a replication job, there are no further replication runs. AWS deletes the contents of the Amazon S3 bucket used to store AWS SMS artifacts. The AMIs created by the replication runs are not deleted.

Examples:

Request syntax with placeholder values


resp = client.delete_replication_job({
  replication_job_id: "ReplicationJobId", # required
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :replication_job_id (required, String)

    The ID of the replication job.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



660
661
662
663
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 660

def delete_replication_job(params = {}, options = {})
  req = build_request(:delete_replication_job, params)
  req.send_request(options)
end

#delete_server_catalog(params = {}) ⇒ Struct

Deletes all servers from your server catalog.

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Returns:

  • (Struct)

    Returns an empty response.

See Also:



673
674
675
676
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 673

def delete_server_catalog(params = {}, options = {})
  req = build_request(:delete_server_catalog, params)
  req.send_request(options)
end

#disassociate_connector(params = {}) ⇒ Struct

Disassociates the specified connector from AWS SMS.

After you disassociate a connector, it is no longer available to support replication jobs.

Examples:

Request syntax with placeholder values


resp = client.disassociate_connector({
  connector_id: "ConnectorId", # required
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :connector_id (required, String)

    The ID of the connector.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



698
699
700
701
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 698

def disassociate_connector(params = {}, options = {})
  req = build_request(:disassociate_connector, params)
  req.send_request(options)
end

#generate_change_set(params = {}) ⇒ Types::GenerateChangeSetResponse

Generates a target change set for a currently launched stack and writes it to an Amazon S3 object in the customer’s Amazon S3 bucket.

Examples:

Request syntax with placeholder values


resp = client.generate_change_set({
  app_id: "AppId",
  changeset_format: "JSON", # accepts JSON, YAML
})

Response structure


resp.s3_location.bucket #=> String
resp.s3_location.key #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :app_id (String)

    The ID of the application associated with the change set.

  • :changeset_format (String)

    The format for the change set.

Returns:

See Also:



732
733
734
735
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 732

def generate_change_set(params = {}, options = {})
  req = build_request(:generate_change_set, params)
  req.send_request(options)
end

#generate_template(params = {}) ⇒ Types::GenerateTemplateResponse

Generates an AWS CloudFormation template based on the current launch configuration and writes it to an Amazon S3 object in the customer’s Amazon S3 bucket.

Examples:

Request syntax with placeholder values


resp = client.generate_template({
  app_id: "AppId",
  template_format: "JSON", # accepts JSON, YAML
})

Response structure


resp.s3_location.bucket #=> String
resp.s3_location.key #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :app_id (String)

    The ID of the application associated with the AWS CloudFormation template.

  • :template_format (String)

    The format for generating the AWS CloudFormation template.

Returns:

See Also:



768
769
770
771
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 768

def generate_template(params = {}, options = {})
  req = build_request(:generate_template, params)
  req.send_request(options)
end

#get_app(params = {}) ⇒ Types::GetAppResponse

Retrieve information about the specified application.

Examples:

Request syntax with placeholder values


resp = client.get_app({
  app_id: "AppId",
})

Response structure


resp.app_summary.app_id #=> String
resp.app_summary.imported_app_id #=> String
resp.app_summary.name #=> String
resp.app_summary.description #=> String
resp.app_summary.status #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "DELETED", "DELETE_FAILED"
resp.app_summary.status_message #=> String
resp.app_summary.replication_configuration_status #=> String, one of "NOT_CONFIGURED", "CONFIGURED"
resp.app_summary.replication_status #=> String, one of "READY_FOR_CONFIGURATION", "CONFIGURATION_IN_PROGRESS", "CONFIGURATION_INVALID", "READY_FOR_REPLICATION", "VALIDATION_IN_PROGRESS", "REPLICATION_PENDING", "REPLICATION_IN_PROGRESS", "REPLICATED", "PARTIALLY_REPLICATED", "DELTA_REPLICATION_IN_PROGRESS", "DELTA_REPLICATED", "DELTA_REPLICATION_FAILED", "REPLICATION_FAILED", "REPLICATION_STOPPING", "REPLICATION_STOP_FAILED", "REPLICATION_STOPPED"
resp.app_summary.replication_status_message #=> String
resp.app_summary.latest_replication_time #=> Time
resp.app_summary.launch_configuration_status #=> String, one of "NOT_CONFIGURED", "CONFIGURED"
resp.app_summary.launch_status #=> String, one of "READY_FOR_CONFIGURATION", "CONFIGURATION_IN_PROGRESS", "CONFIGURATION_INVALID", "READY_FOR_LAUNCH", "VALIDATION_IN_PROGRESS", "LAUNCH_PENDING", "LAUNCH_IN_PROGRESS", "LAUNCHED", "PARTIALLY_LAUNCHED", "DELTA_LAUNCH_IN_PROGRESS", "DELTA_LAUNCH_FAILED", "LAUNCH_FAILED", "TERMINATE_IN_PROGRESS", "TERMINATE_FAILED", "TERMINATED"
resp.app_summary.launch_status_message #=> String
resp.app_summary.launch_details.latest_launch_time #=> Time
resp.app_summary.launch_details.stack_name #=> String
resp.app_summary.launch_details.stack_id #=> String
resp.app_summary.creation_time #=> Time
resp.app_summary.last_modified #=> Time
resp.app_summary.role_name #=> String
resp.app_summary.total_server_groups #=> Integer
resp.app_summary.total_servers #=> Integer
resp.server_groups #=> Array
resp.server_groups[0].server_group_id #=> String
resp.server_groups[0].name #=> String
resp.server_groups[0].server_list #=> Array
resp.server_groups[0].server_list[0].server_id #=> String
resp.server_groups[0].server_list[0].server_type #=> String, one of "VIRTUAL_MACHINE"
resp.server_groups[0].server_list[0].vm_server.vm_server_address.vm_manager_id #=> String
resp.server_groups[0].server_list[0].vm_server.vm_server_address.vm_id #=> String
resp.server_groups[0].server_list[0].vm_server.vm_name #=> String
resp.server_groups[0].server_list[0].vm_server.vm_manager_name #=> String
resp.server_groups[0].server_list[0].vm_server.vm_manager_type #=> String, one of "VSPHERE", "SCVMM", "HYPERV-MANAGER"
resp.server_groups[0].server_list[0].vm_server.vm_path #=> String
resp.server_groups[0].server_list[0].replication_job_id #=> String
resp.server_groups[0].server_list[0].replication_job_terminated #=> Boolean
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :app_id (String)

    The ID of the application.

Returns:

See Also:



835
836
837
838
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 835

def get_app(params = {}, options = {})
  req = build_request(:get_app, params)
  req.send_request(options)
end

#get_app_launch_configuration(params = {}) ⇒ Types::GetAppLaunchConfigurationResponse

Retrieves the application launch configuration associated with the specified application.

Examples:

Request syntax with placeholder values


resp = client.get_app_launch_configuration({
  app_id: "AppId",
})

Response structure


resp.app_id #=> String
resp.role_name #=> String
resp.auto_launch #=> Boolean
resp.server_group_launch_configurations #=> Array
resp.server_group_launch_configurations[0].server_group_id #=> String
resp.server_group_launch_configurations[0].launch_order #=> Integer
resp.server_group_launch_configurations[0].server_launch_configurations #=> Array
resp.server_group_launch_configurations[0].server_launch_configurations[0].server.server_id #=> String
resp.server_group_launch_configurations[0].server_launch_configurations[0].server.server_type #=> String, one of "VIRTUAL_MACHINE"
resp.server_group_launch_configurations[0].server_launch_configurations[0].server.vm_server.vm_server_address.vm_manager_id #=> String
resp.server_group_launch_configurations[0].server_launch_configurations[0].server.vm_server.vm_server_address.vm_id #=> String
resp.server_group_launch_configurations[0].server_launch_configurations[0].server.vm_server.vm_name #=> String
resp.server_group_launch_configurations[0].server_launch_configurations[0].server.vm_server.vm_manager_name #=> String
resp.server_group_launch_configurations[0].server_launch_configurations[0].server.vm_server.vm_manager_type #=> String, one of "VSPHERE", "SCVMM", "HYPERV-MANAGER"
resp.server_group_launch_configurations[0].server_launch_configurations[0].server.vm_server.vm_path #=> String
resp.server_group_launch_configurations[0].server_launch_configurations[0].server.replication_job_id #=> String
resp.server_group_launch_configurations[0].server_launch_configurations[0].server.replication_job_terminated #=> Boolean
resp.server_group_launch_configurations[0].server_launch_configurations[0].logical_id #=> String
resp.server_group_launch_configurations[0].server_launch_configurations[0].vpc #=> String
resp.server_group_launch_configurations[0].server_launch_configurations[0].subnet #=> String
resp.server_group_launch_configurations[0].server_launch_configurations[0].security_group #=> String
resp.server_group_launch_configurations[0].server_launch_configurations[0].ec2_key_name #=> String
resp.server_group_launch_configurations[0].server_launch_configurations[0].user_data.s3_location.bucket #=> String
resp.server_group_launch_configurations[0].server_launch_configurations[0].user_data.s3_location.key #=> String
resp.server_group_launch_configurations[0].server_launch_configurations[0].instance_type #=> String
resp.server_group_launch_configurations[0].server_launch_configurations[0].associate_public_ip_address #=> Boolean
resp.server_group_launch_configurations[0].server_launch_configurations[0].iam_instance_profile_name #=> String
resp.server_group_launch_configurations[0].server_launch_configurations[0].configure_script.bucket #=> String
resp.server_group_launch_configurations[0].server_launch_configurations[0].configure_script.key #=> String
resp.server_group_launch_configurations[0].server_launch_configurations[0].configure_script_type #=> String, one of "SHELL_SCRIPT", "POWERSHELL_SCRIPT"

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :app_id (String)

    The ID of the application.

Returns:

See Also:



896
897
898
899
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 896

def get_app_launch_configuration(params = {}, options = {})
  req = build_request(:get_app_launch_configuration, params)
  req.send_request(options)
end

#get_app_replication_configuration(params = {}) ⇒ Types::GetAppReplicationConfigurationResponse

Retrieves the application replication configuration associated with the specified application.

Examples:

Request syntax with placeholder values


resp = client.get_app_replication_configuration({
  app_id: "AppId",
})

Response structure


resp.server_group_replication_configurations #=> Array
resp.server_group_replication_configurations[0].server_group_id #=> String
resp.server_group_replication_configurations[0].server_replication_configurations #=> Array
resp.server_group_replication_configurations[0].server_replication_configurations[0].server.server_id #=> String
resp.server_group_replication_configurations[0].server_replication_configurations[0].server.server_type #=> String, one of "VIRTUAL_MACHINE"
resp.server_group_replication_configurations[0].server_replication_configurations[0].server.vm_server.vm_server_address.vm_manager_id #=> String
resp.server_group_replication_configurations[0].server_replication_configurations[0].server.vm_server.vm_server_address.vm_id #=> String
resp.server_group_replication_configurations[0].server_replication_configurations[0].server.vm_server.vm_name #=> String
resp.server_group_replication_configurations[0].server_replication_configurations[0].server.vm_server.vm_manager_name #=> String
resp.server_group_replication_configurations[0].server_replication_configurations[0].server.vm_server.vm_manager_type #=> String, one of "VSPHERE", "SCVMM", "HYPERV-MANAGER"
resp.server_group_replication_configurations[0].server_replication_configurations[0].server.vm_server.vm_path #=> String
resp.server_group_replication_configurations[0].server_replication_configurations[0].server.replication_job_id #=> String
resp.server_group_replication_configurations[0].server_replication_configurations[0].server.replication_job_terminated #=> Boolean
resp.server_group_replication_configurations[0].server_replication_configurations[0].server_replication_parameters.seed_time #=> Time
resp.server_group_replication_configurations[0].server_replication_configurations[0].server_replication_parameters.frequency #=> Integer
resp.server_group_replication_configurations[0].server_replication_configurations[0].server_replication_parameters.run_once #=> Boolean
resp.server_group_replication_configurations[0].server_replication_configurations[0].server_replication_parameters.license_type #=> String, one of "AWS", "BYOL"
resp.server_group_replication_configurations[0].server_replication_configurations[0].server_replication_parameters.number_of_recent_amis_to_keep #=> Integer
resp.server_group_replication_configurations[0].server_replication_configurations[0].server_replication_parameters.encrypted #=> Boolean
resp.server_group_replication_configurations[0].server_replication_configurations[0].server_replication_parameters.kms_key_id #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :app_id (String)

    The ID of the application.

Returns:

See Also:



944
945
946
947
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 944

def get_app_replication_configuration(params = {}, options = {})
  req = build_request(:get_app_replication_configuration, params)
  req.send_request(options)
end

#get_app_validation_configuration(params = {}) ⇒ Types::GetAppValidationConfigurationResponse

Retrieves information about a configuration for validating an application.

Examples:

Request syntax with placeholder values


resp = client.get_app_validation_configuration({
  app_id: "AppIdWithValidation", # required
})

Response structure


resp.app_validation_configurations #=> Array
resp.app_validation_configurations[0].validation_id #=> String
resp.app_validation_configurations[0].name #=> String
resp.app_validation_configurations[0].app_validation_strategy #=> String, one of "SSM"
resp.app_validation_configurations[0].ssm_validation_parameters.source.s3_location.bucket #=> String
resp.app_validation_configurations[0].ssm_validation_parameters.source.s3_location.key #=> String
resp.app_validation_configurations[0].ssm_validation_parameters.instance_id #=> String
resp.app_validation_configurations[0].ssm_validation_parameters.script_type #=> String, one of "SHELL_SCRIPT", "POWERSHELL_SCRIPT"
resp.app_validation_configurations[0].ssm_validation_parameters.command #=> String
resp.app_validation_configurations[0].ssm_validation_parameters.execution_timeout_seconds #=> Integer
resp.app_validation_configurations[0].ssm_validation_parameters.output_s3_bucket_name #=> String
resp.server_group_validation_configurations #=> Array
resp.server_group_validation_configurations[0].server_group_id #=> String
resp.server_group_validation_configurations[0].server_validation_configurations #=> Array
resp.server_group_validation_configurations[0].server_validation_configurations[0].server.server_id #=> String
resp.server_group_validation_configurations[0].server_validation_configurations[0].server.server_type #=> String, one of "VIRTUAL_MACHINE"
resp.server_group_validation_configurations[0].server_validation_configurations[0].server.vm_server.vm_server_address.vm_manager_id #=> String
resp.server_group_validation_configurations[0].server_validation_configurations[0].server.vm_server.vm_server_address.vm_id #=> String
resp.server_group_validation_configurations[0].server_validation_configurations[0].server.vm_server.vm_name #=> String
resp.server_group_validation_configurations[0].server_validation_configurations[0].server.vm_server.vm_manager_name #=> String
resp.server_group_validation_configurations[0].server_validation_configurations[0].server.vm_server.vm_manager_type #=> String, one of "VSPHERE", "SCVMM", "HYPERV-MANAGER"
resp.server_group_validation_configurations[0].server_validation_configurations[0].server.vm_server.vm_path #=> String
resp.server_group_validation_configurations[0].server_validation_configurations[0].server.replication_job_id #=> String
resp.server_group_validation_configurations[0].server_validation_configurations[0].server.replication_job_terminated #=> Boolean
resp.server_group_validation_configurations[0].server_validation_configurations[0].validation_id #=> String
resp.server_group_validation_configurations[0].server_validation_configurations[0].name #=> String
resp.server_group_validation_configurations[0].server_validation_configurations[0].server_validation_strategy #=> String, one of "USERDATA"
resp.server_group_validation_configurations[0].server_validation_configurations[0].user_data_validation_parameters.source.s3_location.bucket #=> String
resp.server_group_validation_configurations[0].server_validation_configurations[0].user_data_validation_parameters.source.s3_location.key #=> String
resp.server_group_validation_configurations[0].server_validation_configurations[0].user_data_validation_parameters.script_type #=> String, one of "SHELL_SCRIPT", "POWERSHELL_SCRIPT"

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :app_id (required, String)

    The ID of the application.

Returns:

See Also:



1003
1004
1005
1006
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 1003

def get_app_validation_configuration(params = {}, options = {})
  req = build_request(:get_app_validation_configuration, params)
  req.send_request(options)
end

#get_app_validation_output(params = {}) ⇒ Types::GetAppValidationOutputResponse

Retrieves output from validating an application.

Examples:

Request syntax with placeholder values


resp = client.get_app_validation_output({
  app_id: "AppIdWithValidation", # required
})

Response structure


resp.validation_output_list #=> Array
resp.validation_output_list[0].validation_id #=> String
resp.validation_output_list[0].name #=> String
resp.validation_output_list[0].status #=> String, one of "READY_FOR_VALIDATION", "PENDING", "IN_PROGRESS", "SUCCEEDED", "FAILED"
resp.validation_output_list[0].status_message #=> String
resp.validation_output_list[0].latest_validation_time #=> Time
resp.validation_output_list[0].app_validation_output.ssm_output.s3_location.bucket #=> String
resp.validation_output_list[0].app_validation_output.ssm_output.s3_location.key #=> String
resp.validation_output_list[0].server_validation_output.server.server_id #=> String
resp.validation_output_list[0].server_validation_output.server.server_type #=> String, one of "VIRTUAL_MACHINE"
resp.validation_output_list[0].server_validation_output.server.vm_server.vm_server_address.vm_manager_id #=> String
resp.validation_output_list[0].server_validation_output.server.vm_server.vm_server_address.vm_id #=> String
resp.validation_output_list[0].server_validation_output.server.vm_server.vm_name #=> String
resp.validation_output_list[0].server_validation_output.server.vm_server.vm_manager_name #=> String
resp.validation_output_list[0].server_validation_output.server.vm_server.vm_manager_type #=> String, one of "VSPHERE", "SCVMM", "HYPERV-MANAGER"
resp.validation_output_list[0].server_validation_output.server.vm_server.vm_path #=> String
resp.validation_output_list[0].server_validation_output.server.replication_job_id #=> String
resp.validation_output_list[0].server_validation_output.server.replication_job_terminated #=> Boolean

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :app_id (required, String)

    The ID of the application.

Returns:

See Also:



1048
1049
1050
1051
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 1048

def get_app_validation_output(params = {}, options = {})
  req = build_request(:get_app_validation_output, params)
  req.send_request(options)
end

#get_connectors(params = {}) ⇒ Types::GetConnectorsResponse

Describes the connectors registered with the AWS SMS.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.get_connectors({
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.connector_list #=> Array
resp.connector_list[0].connector_id #=> String
resp.connector_list[0].version #=> String
resp.connector_list[0].status #=> String, one of "HEALTHY", "UNHEALTHY"
resp.connector_list[0].capability_list #=> Array
resp.connector_list[0].capability_list[0] #=> String, one of "VSPHERE", "SCVMM", "HYPERV-MANAGER", "SNAPSHOT_BATCHING", "SMS_OPTIMIZED"
resp.connector_list[0].vm_manager_name #=> String
resp.connector_list[0].vm_manager_type #=> String, one of "VSPHERE", "SCVMM", "HYPERV-MANAGER"
resp.connector_list[0].vm_manager_id #=> String
resp.connector_list[0].ip_address #=> String
resp.connector_list[0].mac_address #=> String
resp.connector_list[0].associated_on #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :next_token (String)

    The token for the next set of results.

  • :max_results (Integer)

    The maximum number of results to return in a single call. The default value is 50. To retrieve the remaining results, make another call with the returned NextToken value.

Returns:

See Also:



1097
1098
1099
1100
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 1097

def get_connectors(params = {}, options = {})
  req = build_request(:get_connectors, params)
  req.send_request(options)
end

#get_replication_jobs(params = {}) ⇒ Types::GetReplicationJobsResponse

Describes the specified replication job or all of your replication jobs.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.get_replication_jobs({
  replication_job_id: "ReplicationJobId",
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.replication_job_list #=> Array
resp.replication_job_list[0].replication_job_id #=> String
resp.replication_job_list[0].server_id #=> String
resp.replication_job_list[0].server_type #=> String, one of "VIRTUAL_MACHINE"
resp.replication_job_list[0].vm_server.vm_server_address.vm_manager_id #=> String
resp.replication_job_list[0].vm_server.vm_server_address.vm_id #=> String
resp.replication_job_list[0].vm_server.vm_name #=> String
resp.replication_job_list[0].vm_server.vm_manager_name #=> String
resp.replication_job_list[0].vm_server.vm_manager_type #=> String, one of "VSPHERE", "SCVMM", "HYPERV-MANAGER"
resp.replication_job_list[0].vm_server.vm_path #=> String
resp.replication_job_list[0].seed_replication_time #=> Time
resp.replication_job_list[0].frequency #=> Integer
resp.replication_job_list[0].run_once #=> Boolean
resp.replication_job_list[0].next_replication_run_start_time #=> Time
resp.replication_job_list[0].license_type #=> String, one of "AWS", "BYOL"
resp.replication_job_list[0].role_name #=> String
resp.replication_job_list[0].latest_ami_id #=> String
resp.replication_job_list[0].state #=> String, one of "PENDING", "ACTIVE", "FAILED", "DELETING", "DELETED", "COMPLETED", "PAUSED_ON_FAILURE", "FAILING"
resp.replication_job_list[0].status_message #=> String
resp.replication_job_list[0].description #=> String
resp.replication_job_list[0].number_of_recent_amis_to_keep #=> Integer
resp.replication_job_list[0].encrypted #=> Boolean
resp.replication_job_list[0].kms_key_id #=> String
resp.replication_job_list[0].replication_run_list #=> Array
resp.replication_job_list[0].replication_run_list[0].replication_run_id #=> String
resp.replication_job_list[0].replication_run_list[0].state #=> String, one of "PENDING", "MISSED", "ACTIVE", "FAILED", "COMPLETED", "DELETING", "DELETED"
resp.replication_job_list[0].replication_run_list[0].type #=> String, one of "ON_DEMAND", "AUTOMATIC"
resp.replication_job_list[0].replication_run_list[0].stage_details.stage #=> String
resp.replication_job_list[0].replication_run_list[0].stage_details.stage_progress #=> String
resp.replication_job_list[0].replication_run_list[0].status_message #=> String
resp.replication_job_list[0].replication_run_list[0].ami_id #=> String
resp.replication_job_list[0].replication_run_list[0].scheduled_start_time #=> Time
resp.replication_job_list[0].replication_run_list[0].completed_time #=> Time
resp.replication_job_list[0].replication_run_list[0].description #=> String
resp.replication_job_list[0].replication_run_list[0].encrypted #=> Boolean
resp.replication_job_list[0].replication_run_list[0].kms_key_id #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :replication_job_id (String)

    The ID of the replication job.

  • :next_token (String)

    The token for the next set of results.

  • :max_results (Integer)

    The maximum number of results to return in a single call. The default value is 50. To retrieve the remaining results, make another call with the returned NextToken value.

Returns:

See Also:



1175
1176
1177
1178
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 1175

def get_replication_jobs(params = {}, options = {})
  req = build_request(:get_replication_jobs, params)
  req.send_request(options)
end

#get_replication_runs(params = {}) ⇒ Types::GetReplicationRunsResponse

Describes the replication runs for the specified replication job.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.get_replication_runs({
  replication_job_id: "ReplicationJobId", # required
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.replication_job.replication_job_id #=> String
resp.replication_job.server_id #=> String
resp.replication_job.server_type #=> String, one of "VIRTUAL_MACHINE"
resp.replication_job.vm_server.vm_server_address.vm_manager_id #=> String
resp.replication_job.vm_server.vm_server_address.vm_id #=> String
resp.replication_job.vm_server.vm_name #=> String
resp.replication_job.vm_server.vm_manager_name #=> String
resp.replication_job.vm_server.vm_manager_type #=> String, one of "VSPHERE", "SCVMM", "HYPERV-MANAGER"
resp.replication_job.vm_server.vm_path #=> String
resp.replication_job.seed_replication_time #=> Time
resp.replication_job.frequency #=> Integer
resp.replication_job.run_once #=> Boolean
resp.replication_job.next_replication_run_start_time #=> Time
resp.replication_job.license_type #=> String, one of "AWS", "BYOL"
resp.replication_job.role_name #=> String
resp.replication_job.latest_ami_id #=> String
resp.replication_job.state #=> String, one of "PENDING", "ACTIVE", "FAILED", "DELETING", "DELETED", "COMPLETED", "PAUSED_ON_FAILURE", "FAILING"
resp.replication_job.status_message #=> String
resp.replication_job.description #=> String
resp.replication_job.number_of_recent_amis_to_keep #=> Integer
resp.replication_job.encrypted #=> Boolean
resp.replication_job.kms_key_id #=> String
resp.replication_job.replication_run_list #=> Array
resp.replication_job.replication_run_list[0].replication_run_id #=> String
resp.replication_job.replication_run_list[0].state #=> String, one of "PENDING", "MISSED", "ACTIVE", "FAILED", "COMPLETED", "DELETING", "DELETED"
resp.replication_job.replication_run_list[0].type #=> String, one of "ON_DEMAND", "AUTOMATIC"
resp.replication_job.replication_run_list[0].stage_details.stage #=> String
resp.replication_job.replication_run_list[0].stage_details.stage_progress #=> String
resp.replication_job.replication_run_list[0].status_message #=> String
resp.replication_job.replication_run_list[0].ami_id #=> String
resp.replication_job.replication_run_list[0].scheduled_start_time #=> Time
resp.replication_job.replication_run_list[0].completed_time #=> Time
resp.replication_job.replication_run_list[0].description #=> String
resp.replication_job.replication_run_list[0].encrypted #=> Boolean
resp.replication_job.replication_run_list[0].kms_key_id #=> String
resp.replication_run_list #=> Array
resp.replication_run_list[0].replication_run_id #=> String
resp.replication_run_list[0].state #=> String, one of "PENDING", "MISSED", "ACTIVE", "FAILED", "COMPLETED", "DELETING", "DELETED"
resp.replication_run_list[0].type #=> String, one of "ON_DEMAND", "AUTOMATIC"
resp.replication_run_list[0].stage_details.stage #=> String
resp.replication_run_list[0].stage_details.stage_progress #=> String
resp.replication_run_list[0].status_message #=> String
resp.replication_run_list[0].ami_id #=> String
resp.replication_run_list[0].scheduled_start_time #=> Time
resp.replication_run_list[0].completed_time #=> Time
resp.replication_run_list[0].description #=> String
resp.replication_run_list[0].encrypted #=> Boolean
resp.replication_run_list[0].kms_key_id #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :replication_job_id (required, String)

    The ID of the replication job.

  • :next_token (String)

    The token for the next set of results.

  • :max_results (Integer)

    The maximum number of results to return in a single call. The default value is 50. To retrieve the remaining results, make another call with the returned NextToken value.

Returns:

See Also:



1265
1266
1267
1268
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 1265

def get_replication_runs(params = {}, options = {})
  req = build_request(:get_replication_runs, params)
  req.send_request(options)
end

#get_servers(params = {}) ⇒ Types::GetServersResponse

Describes the servers in your server catalog.

Before you can describe your servers, you must import them using ImportServerCatalog.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.get_servers({
  next_token: "NextToken",
  max_results: 1,
  vm_server_address_list: [
    {
      vm_manager_id: "VmManagerId",
      vm_id: "VmId",
    },
  ],
})

Response structure


resp.last_modified_on #=> Time
resp.server_catalog_status #=> String, one of "NOT_IMPORTED", "IMPORTING", "AVAILABLE", "DELETED", "EXPIRED"
resp.server_list #=> Array
resp.server_list[0].server_id #=> String
resp.server_list[0].server_type #=> String, one of "VIRTUAL_MACHINE"
resp.server_list[0].vm_server.vm_server_address.vm_manager_id #=> String
resp.server_list[0].vm_server.vm_server_address.vm_id #=> String
resp.server_list[0].vm_server.vm_name #=> String
resp.server_list[0].vm_server.vm_manager_name #=> String
resp.server_list[0].vm_server.vm_manager_type #=> String, one of "VSPHERE", "SCVMM", "HYPERV-MANAGER"
resp.server_list[0].vm_server.vm_path #=> String
resp.server_list[0].replication_job_id #=> String
resp.server_list[0].replication_job_terminated #=> Boolean
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :next_token (String)

    The token for the next set of results.

  • :max_results (Integer)

    The maximum number of results to return in a single call. The default value is 50. To retrieve the remaining results, make another call with the returned NextToken value.

  • :vm_server_address_list (Array<Types::VmServerAddress>)

    The server addresses.

Returns:

See Also:



1329
1330
1331
1332
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 1329

def get_servers(params = {}, options = {})
  req = build_request(:get_servers, params)
  req.send_request(options)
end

#import_app_catalog(params = {}) ⇒ Struct

Allows application import from AWS Migration Hub.

Examples:

Request syntax with placeholder values


resp = client.import_app_catalog({
  role_name: "RoleName",
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :role_name (String)

    The name of the service role. If you omit this parameter, we create a service-linked role for AWS Migration Hub in your account. Otherwise, the role that you provide must have the policy and trust policy described in the AWS Migration Hub User Guide.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1358
1359
1360
1361
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 1358

def import_app_catalog(params = {}, options = {})
  req = build_request(:import_app_catalog, params)
  req.send_request(options)
end

#import_server_catalog(params = {}) ⇒ Struct

Gathers a complete list of on-premises servers. Connectors must be installed and monitoring all servers to import.

This call returns immediately, but might take additional time to retrieve all the servers.

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1375
1376
1377
1378
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 1375

def import_server_catalog(params = {}, options = {})
  req = build_request(:import_server_catalog, params)
  req.send_request(options)
end

#launch_app(params = {}) ⇒ Struct

Launches the specified application as a stack in AWS CloudFormation.

Examples:

Request syntax with placeholder values


resp = client.launch_app({
  app_id: "AppId",
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :app_id (String)

    The ID of the application.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1397
1398
1399
1400
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 1397

def launch_app(params = {}, options = {})
  req = build_request(:launch_app, params)
  req.send_request(options)
end

#list_apps(params = {}) ⇒ Types::ListAppsResponse

Retrieves summaries for all applications.

Examples:

Request syntax with placeholder values


resp = client.list_apps({
  app_ids: ["AppId"],
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.apps #=> Array
resp.apps[0].app_id #=> String
resp.apps[0].imported_app_id #=> String
resp.apps[0].name #=> String
resp.apps[0].description #=> String
resp.apps[0].status #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "DELETED", "DELETE_FAILED"
resp.apps[0].status_message #=> String
resp.apps[0].replication_configuration_status #=> String, one of "NOT_CONFIGURED", "CONFIGURED"
resp.apps[0].replication_status #=> String, one of "READY_FOR_CONFIGURATION", "CONFIGURATION_IN_PROGRESS", "CONFIGURATION_INVALID", "READY_FOR_REPLICATION", "VALIDATION_IN_PROGRESS", "REPLICATION_PENDING", "REPLICATION_IN_PROGRESS", "REPLICATED", "PARTIALLY_REPLICATED", "DELTA_REPLICATION_IN_PROGRESS", "DELTA_REPLICATED", "DELTA_REPLICATION_FAILED", "REPLICATION_FAILED", "REPLICATION_STOPPING", "REPLICATION_STOP_FAILED", "REPLICATION_STOPPED"
resp.apps[0].replication_status_message #=> String
resp.apps[0].latest_replication_time #=> Time
resp.apps[0].launch_configuration_status #=> String, one of "NOT_CONFIGURED", "CONFIGURED"
resp.apps[0].launch_status #=> String, one of "READY_FOR_CONFIGURATION", "CONFIGURATION_IN_PROGRESS", "CONFIGURATION_INVALID", "READY_FOR_LAUNCH", "VALIDATION_IN_PROGRESS", "LAUNCH_PENDING", "LAUNCH_IN_PROGRESS", "LAUNCHED", "PARTIALLY_LAUNCHED", "DELTA_LAUNCH_IN_PROGRESS", "DELTA_LAUNCH_FAILED", "LAUNCH_FAILED", "TERMINATE_IN_PROGRESS", "TERMINATE_FAILED", "TERMINATED"
resp.apps[0].launch_status_message #=> String
resp.apps[0].launch_details.latest_launch_time #=> Time
resp.apps[0].launch_details.stack_name #=> String
resp.apps[0].launch_details.stack_id #=> String
resp.apps[0].creation_time #=> Time
resp.apps[0].last_modified #=> Time
resp.apps[0].role_name #=> String
resp.apps[0].total_server_groups #=> Integer
resp.apps[0].total_servers #=> Integer
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :app_ids (Array<String>)

    The unique application IDs.

  • :next_token (String)

    The token for the next set of results.

  • :max_results (Integer)

    The maximum number of results to return in a single call. The default value is 100. To retrieve the remaining results, make another call with the returned NextToken value.

Returns:

See Also:



1458
1459
1460
1461
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 1458

def list_apps(params = {}, options = {})
  req = build_request(:list_apps, params)
  req.send_request(options)
end

#notify_app_validation_output(params = {}) ⇒ Struct

Provides information to AWS SMS about whether application validation is successful.

Examples:

Request syntax with placeholder values


resp = client.notify_app_validation_output({
  app_id: "AppIdWithValidation", # required
  notification_context: {
    validation_id: "ValidationId",
    status: "READY_FOR_VALIDATION", # accepts READY_FOR_VALIDATION, PENDING, IN_PROGRESS, SUCCEEDED, FAILED
    status_message: "ValidationStatusMessage",
  },
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :app_id (required, String)

    The ID of the application.

  • :notification_context (Types::NotificationContext)

    The notification information.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1489
1490
1491
1492
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 1489

def notify_app_validation_output(params = {}, options = {})
  req = build_request(:notify_app_validation_output, params)
  req.send_request(options)
end

#put_app_launch_configuration(params = {}) ⇒ Struct

Creates or updates the launch configuration for the specified application.

Examples:

Request syntax with placeholder values


resp = client.put_app_launch_configuration({
  app_id: "AppId",
  role_name: "RoleName",
  auto_launch: false,
  server_group_launch_configurations: [
    {
      server_group_id: "ServerGroupId",
      launch_order: 1,
      server_launch_configurations: [
        {
          server: {
            server_id: "ServerId",
            server_type: "VIRTUAL_MACHINE", # accepts VIRTUAL_MACHINE
            vm_server: {
              vm_server_address: {
                vm_manager_id: "VmManagerId",
                vm_id: "VmId",
              },
              vm_name: "VmName",
              vm_manager_name: "VmManagerName",
              vm_manager_type: "VSPHERE", # accepts VSPHERE, SCVMM, HYPERV-MANAGER
              vm_path: "VmPath",
            },
            replication_job_id: "ReplicationJobId",
            replication_job_terminated: false,
          },
          logical_id: "LogicalId",
          vpc: "VPC",
          subnet: "Subnet",
          security_group: "SecurityGroup",
          ec2_key_name: "EC2KeyName",
          user_data: {
            s3_location: {
              bucket: "S3BucketName",
              key: "S3KeyName",
            },
          },
          instance_type: "InstanceType",
          associate_public_ip_address: false,
          iam_instance_profile_name: "RoleName",
          configure_script: {
            bucket: "S3BucketName",
            key: "S3KeyName",
          },
          configure_script_type: "SHELL_SCRIPT", # accepts SHELL_SCRIPT, POWERSHELL_SCRIPT
        },
      ],
    },
  ],
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :app_id (String)

    The ID of the application.

  • :role_name (String)

    The name of service role in the customer's account that AWS CloudFormation uses to launch the application.

  • :auto_launch (Boolean)

    Indicates whether the application is configured to launch automatically after replication is complete.

  • :server_group_launch_configurations (Array<Types::ServerGroupLaunchConfiguration>)

    Information about the launch configurations for server groups in the application.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1571
1572
1573
1574
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 1571

def put_app_launch_configuration(params = {}, options = {})
  req = build_request(:put_app_launch_configuration, params)
  req.send_request(options)
end

#put_app_replication_configuration(params = {}) ⇒ Struct

Creates or updates the replication configuration for the specified application.

Examples:

Request syntax with placeholder values


resp = client.put_app_replication_configuration({
  app_id: "AppId",
  server_group_replication_configurations: [
    {
      server_group_id: "ServerGroupId",
      server_replication_configurations: [
        {
          server: {
            server_id: "ServerId",
            server_type: "VIRTUAL_MACHINE", # accepts VIRTUAL_MACHINE
            vm_server: {
              vm_server_address: {
                vm_manager_id: "VmManagerId",
                vm_id: "VmId",
              },
              vm_name: "VmName",
              vm_manager_name: "VmManagerName",
              vm_manager_type: "VSPHERE", # accepts VSPHERE, SCVMM, HYPERV-MANAGER
              vm_path: "VmPath",
            },
            replication_job_id: "ReplicationJobId",
            replication_job_terminated: false,
          },
          server_replication_parameters: {
            seed_time: Time.now,
            frequency: 1,
            run_once: false,
            license_type: "AWS", # accepts AWS, BYOL
            number_of_recent_amis_to_keep: 1,
            encrypted: false,
            kms_key_id: "KmsKeyId",
          },
        },
      ],
    },
  ],
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :app_id (String)

    The ID of the application.

  • :server_group_replication_configurations (Array<Types::ServerGroupReplicationConfiguration>)

    Information about the replication configurations for server groups in the application.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1632
1633
1634
1635
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 1632

def put_app_replication_configuration(params = {}, options = {})
  req = build_request(:put_app_replication_configuration, params)
  req.send_request(options)
end

#put_app_validation_configuration(params = {}) ⇒ Struct

Creates or updates a validation configuration for the specified application.

Examples:

Request syntax with placeholder values


resp = client.put_app_validation_configuration({
  app_id: "AppIdWithValidation", # required
  app_validation_configurations: [
    {
      validation_id: "ValidationId",
      name: "NonEmptyStringWithMaxLen255",
      app_validation_strategy: "SSM", # accepts SSM
      ssm_validation_parameters: {
        source: {
          s3_location: {
            bucket: "S3BucketName",
            key: "S3KeyName",
          },
        },
        instance_id: "InstanceId",
        script_type: "SHELL_SCRIPT", # accepts SHELL_SCRIPT, POWERSHELL_SCRIPT
        command: "Command",
        execution_timeout_seconds: 1,
        output_s3_bucket_name: "BucketName",
      },
    },
  ],
  server_group_validation_configurations: [
    {
      server_group_id: "ServerGroupId",
      server_validation_configurations: [
        {
          server: {
            server_id: "ServerId",
            server_type: "VIRTUAL_MACHINE", # accepts VIRTUAL_MACHINE
            vm_server: {
              vm_server_address: {
                vm_manager_id: "VmManagerId",
                vm_id: "VmId",
              },
              vm_name: "VmName",
              vm_manager_name: "VmManagerName",
              vm_manager_type: "VSPHERE", # accepts VSPHERE, SCVMM, HYPERV-MANAGER
              vm_path: "VmPath",
            },
            replication_job_id: "ReplicationJobId",
            replication_job_terminated: false,
          },
          validation_id: "ValidationId",
          name: "NonEmptyStringWithMaxLen255",
          server_validation_strategy: "USERDATA", # accepts USERDATA
          user_data_validation_parameters: {
            source: {
              s3_location: {
                bucket: "S3BucketName",
                key: "S3KeyName",
              },
            },
            script_type: "SHELL_SCRIPT", # accepts SHELL_SCRIPT, POWERSHELL_SCRIPT
          },
        },
      ],
    },
  ],
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1718
1719
1720
1721
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 1718

def put_app_validation_configuration(params = {}, options = {})
  req = build_request(:put_app_validation_configuration, params)
  req.send_request(options)
end

#start_app_replication(params = {}) ⇒ Struct

Starts replicating the specified application by creating replication jobs for each server in the application.

Examples:

Request syntax with placeholder values


resp = client.start_app_replication({
  app_id: "AppId",
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :app_id (String)

    The ID of the application.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1741
1742
1743
1744
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 1741

def start_app_replication(params = {}, options = {})
  req = build_request(:start_app_replication, params)
  req.send_request(options)
end

#start_on_demand_app_replication(params = {}) ⇒ Struct

Starts an on-demand replication run for the specified application.

Examples:

Request syntax with placeholder values


resp = client.start_on_demand_app_replication({
  app_id: "AppId", # required
  description: "Description",
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :app_id (required, String)

    The ID of the application.

  • :description (String)

    The description of the replication run.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1767
1768
1769
1770
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 1767

def start_on_demand_app_replication(params = {}, options = {})
  req = build_request(:start_on_demand_app_replication, params)
  req.send_request(options)
end

#start_on_demand_replication_run(params = {}) ⇒ Types::StartOnDemandReplicationRunResponse

Starts an on-demand replication run for the specified replication job. This replication run starts immediately. This replication run is in addition to the ones already scheduled.

There is a limit on the number of on-demand replications runs that you can request in a 24-hour period.

Examples:

Request syntax with placeholder values


resp = client.start_on_demand_replication_run({
  replication_job_id: "ReplicationJobId", # required
  description: "Description",
})

Response structure


resp.replication_run_id #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :replication_job_id (required, String)

    The ID of the replication job.

  • :description (String)

    The description of the replication run.

Returns:

See Also:



1804
1805
1806
1807
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 1804

def start_on_demand_replication_run(params = {}, options = {})
  req = build_request(:start_on_demand_replication_run, params)
  req.send_request(options)
end

#stop_app_replication(params = {}) ⇒ Struct

Stops replicating the specified application by deleting the replication job for each server in the application.

Examples:

Request syntax with placeholder values


resp = client.stop_app_replication({
  app_id: "AppId",
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :app_id (String)

    The ID of the application.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1827
1828
1829
1830
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 1827

def stop_app_replication(params = {}, options = {})
  req = build_request(:stop_app_replication, params)
  req.send_request(options)
end

#terminate_app(params = {}) ⇒ Struct

Terminates the stack for the specified application.

Examples:

Request syntax with placeholder values


resp = client.terminate_app({
  app_id: "AppId",
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :app_id (String)

    The ID of the application.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1849
1850
1851
1852
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 1849

def terminate_app(params = {}, options = {})
  req = build_request(:terminate_app, params)
  req.send_request(options)
end

#update_app(params = {}) ⇒ Types::UpdateAppResponse

Updates the specified application.

Examples:

Request syntax with placeholder values


resp = client.update_app({
  app_id: "AppId",
  name: "AppName",
  description: "AppDescription",
  role_name: "RoleName",
  server_groups: [
    {
      server_group_id: "ServerGroupId",
      name: "ServerGroupName",
      server_list: [
        {
          server_id: "ServerId",
          server_type: "VIRTUAL_MACHINE", # accepts VIRTUAL_MACHINE
          vm_server: {
            vm_server_address: {
              vm_manager_id: "VmManagerId",
              vm_id: "VmId",
            },
            vm_name: "VmName",
            vm_manager_name: "VmManagerName",
            vm_manager_type: "VSPHERE", # accepts VSPHERE, SCVMM, HYPERV-MANAGER
            vm_path: "VmPath",
          },
          replication_job_id: "ReplicationJobId",
          replication_job_terminated: false,
        },
      ],
    },
  ],
  tags: [
    {
      key: "TagKey",
      value: "TagValue",
    },
  ],
})

Response structure


resp.app_summary.app_id #=> String
resp.app_summary.imported_app_id #=> String
resp.app_summary.name #=> String
resp.app_summary.description #=> String
resp.app_summary.status #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "DELETED", "DELETE_FAILED"
resp.app_summary.status_message #=> String
resp.app_summary.replication_configuration_status #=> String, one of "NOT_CONFIGURED", "CONFIGURED"
resp.app_summary.replication_status #=> String, one of "READY_FOR_CONFIGURATION", "CONFIGURATION_IN_PROGRESS", "CONFIGURATION_INVALID", "READY_FOR_REPLICATION", "VALIDATION_IN_PROGRESS", "REPLICATION_PENDING", "REPLICATION_IN_PROGRESS", "REPLICATED", "PARTIALLY_REPLICATED", "DELTA_REPLICATION_IN_PROGRESS", "DELTA_REPLICATED", "DELTA_REPLICATION_FAILED", "REPLICATION_FAILED", "REPLICATION_STOPPING", "REPLICATION_STOP_FAILED", "REPLICATION_STOPPED"
resp.app_summary.replication_status_message #=> String
resp.app_summary.latest_replication_time #=> Time
resp.app_summary.launch_configuration_status #=> String, one of "NOT_CONFIGURED", "CONFIGURED"
resp.app_summary.launch_status #=> String, one of "READY_FOR_CONFIGURATION", "CONFIGURATION_IN_PROGRESS", "CONFIGURATION_INVALID", "READY_FOR_LAUNCH", "VALIDATION_IN_PROGRESS", "LAUNCH_PENDING", "LAUNCH_IN_PROGRESS", "LAUNCHED", "PARTIALLY_LAUNCHED", "DELTA_LAUNCH_IN_PROGRESS", "DELTA_LAUNCH_FAILED", "LAUNCH_FAILED", "TERMINATE_IN_PROGRESS", "TERMINATE_FAILED", "TERMINATED"
resp.app_summary.launch_status_message #=> String
resp.app_summary.launch_details.latest_launch_time #=> Time
resp.app_summary.launch_details.stack_name #=> String
resp.app_summary.launch_details.stack_id #=> String
resp.app_summary.creation_time #=> Time
resp.app_summary.last_modified #=> Time
resp.app_summary.role_name #=> String
resp.app_summary.total_server_groups #=> Integer
resp.app_summary.total_servers #=> Integer
resp.server_groups #=> Array
resp.server_groups[0].server_group_id #=> String
resp.server_groups[0].name #=> String
resp.server_groups[0].server_list #=> Array
resp.server_groups[0].server_list[0].server_id #=> String
resp.server_groups[0].server_list[0].server_type #=> String, one of "VIRTUAL_MACHINE"
resp.server_groups[0].server_list[0].vm_server.vm_server_address.vm_manager_id #=> String
resp.server_groups[0].server_list[0].vm_server.vm_server_address.vm_id #=> String
resp.server_groups[0].server_list[0].vm_server.vm_name #=> String
resp.server_groups[0].server_list[0].vm_server.vm_manager_name #=> String
resp.server_groups[0].server_list[0].vm_server.vm_manager_type #=> String, one of "VSPHERE", "SCVMM", "HYPERV-MANAGER"
resp.server_groups[0].server_list[0].vm_server.vm_path #=> String
resp.server_groups[0].server_list[0].replication_job_id #=> String
resp.server_groups[0].server_list[0].replication_job_terminated #=> Boolean
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :app_id (String)

    The ID of the application.

  • :name (String)

    The new name of the application.

  • :description (String)

    The new description of the application.

  • :role_name (String)

    The name of the service role in the customer's account used by AWS SMS.

  • :server_groups (Array<Types::ServerGroup>)

    The server groups in the application to update.

  • :tags (Array<Types::Tag>)

    The tags to associate with the application.

Returns:

See Also:



1965
1966
1967
1968
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 1965

def update_app(params = {}, options = {})
  req = build_request(:update_app, params)
  req.send_request(options)
end

#update_replication_job(params = {}) ⇒ Struct

Updates the specified settings for the specified replication job.

Examples:

Request syntax with placeholder values


resp = client.update_replication_job({
  replication_job_id: "ReplicationJobId", # required
  frequency: 1,
  next_replication_run_start_time: Time.now,
  license_type: "AWS", # accepts AWS, BYOL
  role_name: "RoleName",
  description: "Description",
  number_of_recent_amis_to_keep: 1,
  encrypted: false,
  kms_key_id: "KmsKeyId",
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :replication_job_id (required, String)

    The ID of the replication job.

  • :frequency (Integer)

    The time between consecutive replication runs, in hours.

  • :next_replication_run_start_time (Time, DateTime, Date, Integer, String)

    The start time of the next replication run.

  • :license_type (String)

    The license type to be used for the AMI created by a successful replication run.

  • :role_name (String)

    The name of the IAM role to be used by AWS SMS.

  • :description (String)

    The description of the replication job.

  • :number_of_recent_amis_to_keep (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.

  • :kms_key_id (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.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



2034
2035
2036
2037
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 2034

def update_replication_job(params = {}, options = {})
  req = build_request(:update_replication_job, params)
  req.send_request(options)
end