You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::ApplicationDiscoveryService::Types::StartImportTaskRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-applicationdiscoveryservice/lib/aws-sdk-applicationdiscoveryservice/types.rb

Overview

Note:

When making an API call, you may pass StartImportTaskRequest data as a hash:

{
  client_request_token: "ClientRequestToken",
  name: "ImportTaskName", # required
  import_url: "ImportURL", # required
}

Instance Attribute Summary collapse

Instance Attribute Details

#client_request_tokenString

Optional. A unique token that you can provide to prevent the same import request from occurring more than once. If you don't provide a token, a token is automatically generated.

Sending more than one StartImportTask request with the same client request token will return information about the original import task with that client request token.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

  • (String)


1730
1731
1732
1733
1734
1735
# File 'gems/aws-sdk-applicationdiscoveryservice/lib/aws-sdk-applicationdiscoveryservice/types.rb', line 1730

class StartImportTaskRequest < Struct.new(
  :client_request_token,
  :name,
  :import_url)
  include Aws::Structure
end

#import_urlString

The URL for your import file that you've uploaded to Amazon S3.

If you're using the AWS CLI, this URL is structured as follows: s3://BucketName/ImportFileName.CSV

Returns:

  • (String)


1730
1731
1732
1733
1734
1735
# File 'gems/aws-sdk-applicationdiscoveryservice/lib/aws-sdk-applicationdiscoveryservice/types.rb', line 1730

class StartImportTaskRequest < Struct.new(
  :client_request_token,
  :name,
  :import_url)
  include Aws::Structure
end

#nameString

A descriptive name for this request. You can use this name to filter future requests related to this import task, such as identifying applications and servers that were included in this import task. We recommend that you use a meaningful name for each import task.

Returns:

  • (String)


1730
1731
1732
1733
1734
1735
# File 'gems/aws-sdk-applicationdiscoveryservice/lib/aws-sdk-applicationdiscoveryservice/types.rb', line 1730

class StartImportTaskRequest < Struct.new(
  :client_request_token,
  :name,
  :import_url)
  include Aws::Structure
end