Class: Aws::DataSync::Types::StartTaskExecutionRequest

Inherits:

Struct

• Object
• Struct
• Aws::DataSync::Types::StartTaskExecutionRequest

Includes:

Structure

Defined in:

lib/aws-sdk-datasync/types.rb

Overview

StartTaskExecutionRequest

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #excludes ⇒ Array<Types::FilterRule>

  Specifies a list of filter rules that determines which files to exclude from a task.

• #includes ⇒ Array<Types::FilterRule>

  Specifies a list of filter rules that determines which files to include when running a task.

• #manifest_config ⇒ Types::ManifestConfig

  Configures a manifest, which is a list of files or objects that you want DataSync to transfer.

• #override_options ⇒ Types::Options

  Indicates how your transfer task is configured.

• #tags ⇒ Array<Types::TagListEntry>

  Specifies the tags that you want to apply to the Amazon Resource Name (ARN) representing the task execution.

• #task_arn ⇒ String

  Specifies the Amazon Resource Name (ARN) of the task that you want to start.

• #task_report_config ⇒ Types::TaskReportConfig

  Specifies how you want to configure a task report, which provides detailed information about your DataSync transfer.

Instance Attribute Details

#excludes ⇒ Array<Types::FilterRule>

Specifies a list of filter rules that determines which files to exclude from a task. The list contains a single filter string that consists of the patterns to exclude. The patterns are delimited by “|” (that is, a pipe), for example, ‘“/folder1|/folder2”`.

Returns:

• (Array<Types::FilterRule>)

# File 'lib/aws-sdk-datasync/types.rb', line 5131

class StartTaskExecutionRequest < Struct.new(
  :task_arn,
  :override_options,
  :includes,
  :excludes,
  :manifest_config,
  :task_report_config,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#includes ⇒ Array<Types::FilterRule>

Specifies a list of filter rules that determines which files to include when running a task. The pattern should contain a single filter string that consists of the patterns to include. The patterns are delimited by “|” (that is, a pipe), for example, ‘“/folder1|/folder2”`.

Returns:

• (Array<Types::FilterRule>)

# File 'lib/aws-sdk-datasync/types.rb', line 5131

class StartTaskExecutionRequest < Struct.new(
  :task_arn,
  :override_options,
  :includes,
  :excludes,
  :manifest_config,
  :task_report_config,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#manifest_config ⇒ Types::ManifestConfig

Configures a manifest, which is a list of files or objects that you want DataSync to transfer. For more information and configuration examples, see [Specifying what DataSync transfers by using a manifest].

When using this parameter, your caller identity (the role that you’re using DataSync with) must have the ‘iam:PassRole` permission. The [AWSDataSyncFullAccess] policy includes this permission.

To remove a manifest configuration, specify this parameter with an empty value.

[1]: docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html [2]: docs.aws.amazon.com/datasync/latest/userguide/security-iam-awsmanpol.html#security-iam-awsmanpol-awsdatasyncfullaccess

Returns:

• (Types::ManifestConfig)

# File 'lib/aws-sdk-datasync/types.rb', line 5131

class StartTaskExecutionRequest < Struct.new(
  :task_arn,
  :override_options,
  :includes,
  :excludes,
  :manifest_config,
  :task_report_config,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#override_options ⇒ Types::Options

Indicates how your transfer task is configured. These options include how DataSync handles files, objects, and their associated metadata during your transfer. You also can specify how to verify data integrity, set bandwidth limits for your task, among other options.

Each option has a default value. Unless you need to, you don’t have to configure any of these options before starting your task.

Returns:

• (Types::Options)

# File 'lib/aws-sdk-datasync/types.rb', line 5131

class StartTaskExecutionRequest < Struct.new(
  :task_arn,
  :override_options,
  :includes,
  :excludes,
  :manifest_config,
  :task_report_config,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::TagListEntry>

Specifies the tags that you want to apply to the Amazon Resource Name (ARN) representing the task execution.

Tags are key-value pairs that help you manage, filter, and search for your DataSync resources.

Returns:

• (Array<Types::TagListEntry>)

# File 'lib/aws-sdk-datasync/types.rb', line 5131

class StartTaskExecutionRequest < Struct.new(
  :task_arn,
  :override_options,
  :includes,
  :excludes,
  :manifest_config,
  :task_report_config,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#task_arn ⇒ String

Specifies the Amazon Resource Name (ARN) of the task that you want to start.

Returns:

• (String)

# File 'lib/aws-sdk-datasync/types.rb', line 5131

class StartTaskExecutionRequest < Struct.new(
  :task_arn,
  :override_options,
  :includes,
  :excludes,
  :manifest_config,
  :task_report_config,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#task_report_config ⇒ Types::TaskReportConfig

Specifies how you want to configure a task report, which provides detailed information about your DataSync transfer. For more information, see [Monitoring your DataSync transfers with task reports].

When using this parameter, your caller identity (the role that you’re using DataSync with) must have the ‘iam:PassRole` permission. The [AWSDataSyncFullAccess] policy includes this permission.

To remove a task report configuration, specify this parameter as empty.

[1]: docs.aws.amazon.com/datasync/latest/userguide/task-reports.html [2]: docs.aws.amazon.com/datasync/latest/userguide/security-iam-awsmanpol.html#security-iam-awsmanpol-awsdatasyncfullaccess

Returns:

• (Types::TaskReportConfig)

# File 'lib/aws-sdk-datasync/types.rb', line 5131

class StartTaskExecutionRequest < Struct.new(
  :task_arn,
  :override_options,
  :includes,
  :excludes,
  :manifest_config,
  :task_report_config,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end