{
  "version":"2.0",
  "metadata":{
    "apiVersion":"2018-11-09",
    "endpointPrefix":"datasync",
    "jsonVersion":"1.1",
    "protocol":"json",
    "serviceAbbreviation":"DataSync",
    "serviceFullName":"AWS DataSync",
    "serviceId":"DataSync",
    "signatureVersion":"v4",
    "signingName":"datasync",
    "targetPrefix":"FmrsService",
    "uid":"datasync-2018-11-09"
  },
  "operations":{
    "CancelTaskExecution":{
      "name":"CancelTaskExecution",
      "http":{
        "method":"POST",
        "requestUri":"/"
      },
      "input":{"shape":"CancelTaskExecutionRequest"},
      "output":{"shape":"CancelTaskExecutionResponse"},
      "errors":[
        {"shape":"InvalidRequestException"}
      ],
      "documentation":"<p>Cancels execution of a task. </p> <p>When you cancel a task execution, the transfer of some files are abruptly interrupted. The contents of files that are transferred to the destination might be incomplete or inconsistent with the source files. However, if you start a new task execution on the same task and you allow the task execution to complete, file content on the destination is complete and consistent. This applies to other unexpected failures that interrupt a task execution. In all of these cases, AWS DataSync successfully complete the transfer when you start the next task execution. </p>"
    },
    "CreateAgent":{
      "name":"CreateAgent",
      "http":{
        "method":"POST",
        "requestUri":"/"
      },
      "input":{"shape":"CreateAgentRequest"},
      "output":{"shape":"CreateAgentResponse"},
      "errors":[
        {"shape":"InvalidRequestException"}
      ],
      "documentation":"<p>Activates an AWS DataSync agent that you have deployed on your host. The activation process associates your agent with your account. In the activation process, you specify information such as the AWS Region that you want to activate the agent in. You activate the agent in the AWS Region where your target locations (in Amazon S3 or Amazon EFS) reside. Your tasks are created in this AWS Region. </p> <p>You can use an agent for more than one location. If a task uses multiple agents, all of them need to have status AVAILABLE for the task to run. If you use multiple agents for a source location, the status of all the agents must be AVAILABLE for the task to run. For more information, see <a href=\"https://docs.aws.amazon.com/sync-service/latest/userguide/working-with-sync-agents.html#activating-sync-agent\">Activating a Sync Agent</a> in the <i>AWS DataSync User Guide.</i> </p> <p>Agents are automatically updated by AWS on a regular basis, using a mechanism that ensures minimal interruption to your tasks.</p> <p/>"
    },
    "CreateLocationEfs":{
      "name":"CreateLocationEfs",
      "http":{
        "method":"POST",
        "requestUri":"/"
      },
      "input":{"shape":"CreateLocationEfsRequest"},
      "output":{"shape":"CreateLocationEfsResponse"},
      "errors":[
        {"shape":"InvalidRequestException"}
      ],
      "documentation":"<p>Creates an endpoint for an Amazon EFS file system.</p>"
    },
    "CreateLocationNfs":{
      "name":"CreateLocationNfs",
      "http":{
        "method":"POST",
        "requestUri":"/"
      },
      "input":{"shape":"CreateLocationNfsRequest"},
      "output":{"shape":"CreateLocationNfsResponse"},
      "errors":[
        {"shape":"InvalidRequestException"}
      ],
      "documentation":"<p>Creates an endpoint for a Network File System (NFS) file system.</p>"
    },
    "CreateLocationS3":{
      "name":"CreateLocationS3",
      "http":{
        "method":"POST",
        "requestUri":"/"
      },
      "input":{"shape":"CreateLocationS3Request"},
      "output":{"shape":"CreateLocationS3Response"},
      "errors":[
        {"shape":"InvalidRequestException"}
      ],
      "documentation":"<p>Creates an endpoint for an Amazon S3 bucket.</p> <p>For AWS DataSync to access a destination S3 bucket, it needs an AWS Identity and Access Management (IAM) role that has the required permissions. You can set up the required permissions by creating an IAM policy that grants the required permissions and attaching the policy to the role. An example of such a policy is shown in the examples section. For more information, see <a href=\"https://docs.aws.amazon.com/sync-service/latest/userguide/configuring-s3-locations.html\">Configuring Amazon S3 Location Settings</a> in the <i>AWS DataSync User Guide</i>.</p>"
    },
    "CreateTask":{
      "name":"CreateTask",
      "http":{
        "method":"POST",
        "requestUri":"/"
      },
      "input":{"shape":"CreateTaskRequest"},
      "output":{"shape":"CreateTaskResponse"},
      "errors":[
        {"shape":"InvalidRequestException"}
      ],
      "documentation":"<p>Creates a task. A task is a set of two locations (source and destination) and a set of default <code>OverrideOptions</code> that you use to control the behavior of a task. If you don't specify default values for <code>Options</code> when you create a task, AWS DataSync populates them with safe service defaults.</p> <p>When you initially create a task, it enters the INITIALIZING status and then the CREATING status. In CREATING status, AWS DataSync attempts to mount the source Network File System (NFS) location. The task transitions to the AVAILABLE status without waiting for the destination location to mount. Instead, AWS DataSync mounts a destination before every task execution and then unmounts it after every task execution. </p> <p>If an agent that is associated with a source (NFS) location goes offline, the task transitions to the UNAVAILABLE status. If the status of the task remains in the CREATING status for more than a few minutes, it means that your agent might be having trouble mounting the source NFS file system. Check the task's <code>ErrorCode</code> and <code>ErrorDetail</code>. Mount issues are often caused by either a misconfigured firewall or a mistyped NFS server host name.</p>"
    },
    "DeleteAgent":{
      "name":"DeleteAgent",
      "http":{
        "method":"POST",
        "requestUri":"/"
      },
      "input":{"shape":"DeleteAgentRequest"},
      "output":{"shape":"DeleteAgentResponse"},
      "errors":[
        {"shape":"InvalidRequestException"}
      ],
      "documentation":"<p>Deletes an agent. To specify which agent to delete, use the Amazon Resource Name (ARN) of the agent in your request. The operation disassociates the agent from your AWS account. However, it doesn't delete the agent virtual machine (VM) from your on-premises environment.</p> <note> <p>After you delete an agent, you can't reactivate it and you longer pay software charges for it.</p> </note>"
    },
    "DeleteLocation":{
      "name":"DeleteLocation",
      "http":{
        "method":"POST",
        "requestUri":"/"
      },
      "input":{"shape":"DeleteLocationRequest"},
      "output":{"shape":"DeleteLocationResponse"},
      "errors":[
        {"shape":"InvalidRequestException"}
      ],
      "documentation":"<p>Deletes the configuration of a location used by AWS DataSync. </p>"
    },
    "DeleteTask":{
      "name":"DeleteTask",
      "http":{
        "method":"POST",
        "requestUri":"/"
      },
      "input":{"shape":"DeleteTaskRequest"},
      "output":{"shape":"DeleteTaskResponse"},
      "errors":[
        {"shape":"InvalidRequestException"}
      ],
      "documentation":"<p>Deletes a task.</p>"
    },
    "DescribeAgent":{
      "name":"DescribeAgent",
      "http":{
        "method":"POST",
        "requestUri":"/"
      },
      "input":{"shape":"DescribeAgentRequest"},
      "output":{"shape":"DescribeAgentResponse"},
      "errors":[
        {"shape":"InvalidRequestException"}
      ],
      "documentation":"<p>Returns metadata such as the name, the network interfaces, and the status (that is, whether the agent is running or not) for an agent. To specify which agent to describe, use the Amazon Resource Name (ARN) of the agent in your request. </p>"
    },
    "DescribeLocationEfs":{
      "name":"DescribeLocationEfs",
      "http":{
        "method":"POST",
        "requestUri":"/"
      },
      "input":{"shape":"DescribeLocationEfsRequest"},
      "output":{"shape":"DescribeLocationEfsResponse"},
      "errors":[
        {"shape":"InvalidRequestException"}
      ],
      "documentation":"<p>Returns metadata, such as the path information about an Amazon EFS location.</p>"
    },
    "DescribeLocationNfs":{
      "name":"DescribeLocationNfs",
      "http":{
        "method":"POST",
        "requestUri":"/"
      },
      "input":{"shape":"DescribeLocationNfsRequest"},
      "output":{"shape":"DescribeLocationNfsResponse"},
      "errors":[
        {"shape":"InvalidRequestException"}
      ],
      "documentation":"<p>Returns metadata, such as the path information, about a NFS location.</p>"
    },
    "DescribeLocationS3":{
      "name":"DescribeLocationS3",
      "http":{
        "method":"POST",
        "requestUri":"/"
      },
      "input":{"shape":"DescribeLocationS3Request"},
      "output":{"shape":"DescribeLocationS3Response"},
      "errors":[
        {"shape":"InvalidRequestException"}
      ],
      "documentation":"<p>Returns metadata, such as bucket name, about an Amazon S3 bucket location.</p>"
    },
    "DescribeTask":{
      "name":"DescribeTask",
      "http":{
        "method":"POST",
        "requestUri":"/"
      },
      "input":{"shape":"DescribeTaskRequest"},
      "output":{"shape":"DescribeTaskResponse"},
      "errors":[
        {"shape":"InvalidRequestException"}
      ],
      "documentation":"<p>Returns metadata about a task.</p>"
    },
    "DescribeTaskExecution":{
      "name":"DescribeTaskExecution",
      "http":{
        "method":"POST",
        "requestUri":"/"
      },
      "input":{"shape":"DescribeTaskExecutionRequest"},
      "output":{"shape":"DescribeTaskExecutionResponse"},
      "errors":[
        {"shape":"InvalidRequestException"}
      ],
      "documentation":"<p>Returns detailed metadata about a task that is being executed.</p>"
    },
    "ListAgents":{
      "name":"ListAgents",
      "http":{
        "method":"POST",
        "requestUri":"/"
      },
      "input":{"shape":"ListAgentsRequest"},
      "output":{"shape":"ListAgentsResponse"},
      "errors":[
        {"shape":"InvalidRequestException"}
      ],
      "documentation":"<p>Returns a list of agents owned by an AWS account in the AWS Region specified in the request. The returned list is ordered by agent Amazon Resource Name (ARN).</p> <p>By default, this operation returns a maximum of 100 agents. This operation supports pagination that enables you to optionally reduce the number of agents returned in a response.</p> <p>If you have more agents than are returned in a response (that is, the response returns only a truncated list of your agents), the response contains a marker that you can specify in your next request to fetch the next page of agents.</p>"
    },
    "ListLocations":{
      "name":"ListLocations",
      "http":{
        "method":"POST",
        "requestUri":"/"
      },
      "input":{"shape":"ListLocationsRequest"},
      "output":{"shape":"ListLocationsResponse"},
      "errors":[
        {"shape":"InvalidRequestException"}
      ],
      "documentation":"<p>Returns a lists of source and destination locations.</p> <p>If you have more locations than are returned in a response (that is, the response returns only a truncated list of your agents), the response contains a token that you can specify in your next request to fetch the next page of locations.</p>"
    },
    "ListTagsForResource":{
      "name":"ListTagsForResource",
      "http":{
        "method":"POST",
        "requestUri":"/"
      },
      "input":{"shape":"ListTagsForResourceRequest"},
      "output":{"shape":"ListTagsForResourceResponse"},
      "errors":[
        {"shape":"InvalidRequestException"}
      ],
      "documentation":"<p>Returns all the tags associated with a specified resources. </p>"
    },
    "ListTaskExecutions":{
      "name":"ListTaskExecutions",
      "http":{
        "method":"POST",
        "requestUri":"/"
      },
      "input":{"shape":"ListTaskExecutionsRequest"},
      "output":{"shape":"ListTaskExecutionsResponse"},
      "errors":[
        {"shape":"InvalidRequestException"}
      ],
      "documentation":"<p>Returns a list of executed tasks.</p>"
    },
    "ListTasks":{
      "name":"ListTasks",
      "http":{
        "method":"POST",
        "requestUri":"/"
      },
      "input":{"shape":"ListTasksRequest"},
      "output":{"shape":"ListTasksResponse"},
      "errors":[
        {"shape":"InvalidRequestException"}
      ],
      "documentation":"<p>Returns a list of all the tasks.</p>"
    },
    "StartTaskExecution":{
      "name":"StartTaskExecution",
      "http":{
        "method":"POST",
        "requestUri":"/"
      },
      "input":{"shape":"StartTaskExecutionRequest"},
      "output":{"shape":"StartTaskExecutionResponse"},
      "errors":[
        {"shape":"InvalidRequestException"}
      ],
      "documentation":"<p>Starts a specific invocation of a task. A <code>TaskExecution</code> value represents an individual run of a task. Each task can have at most one <code>TaskExecution</code> at a time.</p> <p> <code>TaskExecution</code> has the following transition phases: INITIALIZING | PREPARING | TRANSFERRING | VERIFYING | SUCCESS/FAILURE. </p> <p>For detailed information, see <i>Task Execution</i> in <a href=\"https://docs.aws.amazon.com/sync-service/latest/userguide/how-awssync-works.html#terminology\">Components and Terminology</a> in the <i>AWS DataSync User Guide</i>.</p>"
    },
    "TagResource":{
      "name":"TagResource",
      "http":{
        "method":"POST",
        "requestUri":"/"
      },
      "input":{"shape":"TagResourceRequest"},
      "output":{"shape":"TagResourceResponse"},
      "errors":[
        {"shape":"InvalidRequestException"}
      ],
      "documentation":"<p>Applies a key-value pair to an AWS resource.</p>"
    },
    "UntagResource":{
      "name":"UntagResource",
      "http":{
        "method":"POST",
        "requestUri":"/"
      },
      "input":{"shape":"UntagResourceRequest"},
      "output":{"shape":"UntagResourceResponse"},
      "errors":[
        {"shape":"InvalidRequestException"}
      ],
      "documentation":"<p>Removes a tag from an AWS resource.</p>"
    },
    "UpdateAgent":{
      "name":"UpdateAgent",
      "http":{
        "method":"POST",
        "requestUri":"/"
      },
      "input":{"shape":"UpdateAgentRequest"},
      "output":{"shape":"UpdateAgentResponse"},
      "errors":[
        {"shape":"InvalidRequestException"}
      ],
      "documentation":"<p>Updates the name of an agent.</p>"
    },
    "UpdateTask":{
      "name":"UpdateTask",
      "http":{
        "method":"POST",
        "requestUri":"/"
      },
      "input":{"shape":"UpdateTaskRequest"},
      "output":{"shape":"UpdateTaskResponse"},
      "errors":[
        {"shape":"InvalidRequestException"}
      ],
      "documentation":"<p>Updates the metadata associated with a task.</p>"
    }
  },
  "shapes":{
    "ActivationKey":{
      "type":"string",
      "max":29,
      "pattern":"[A-Z0-9]{5}(-[A-Z0-9]{5}){4}"
    },
    "AgentArn":{
      "type":"string",
      "max":128,
      "pattern":"^arn:(aws|aws-cn):datasync:[a-z\\-0-9]+:[0-9]{12}:agent/agent-[0-9a-z]{17}$"
    },
    "AgentArnList":{
      "type":"list",
      "member":{"shape":"AgentArn"},
      "max":64,
      "min":1
    },
    "AgentList":{
      "type":"list",
      "member":{"shape":"AgentListEntry"}
    },
    "AgentListEntry":{
      "type":"structure",
      "members":{
        "AgentArn":{
          "shape":"AgentArn",
          "documentation":"<p>The Amazon Resource Name (ARN) of the agent.</p>"
        },
        "Name":{
          "shape":"TagValue",
          "documentation":"<p>The name of the agent.</p>"
        },
        "Status":{
          "shape":"AgentStatus",
          "documentation":"<p>The status of the agent.</p>"
        }
      },
      "documentation":"<p>Represents a single entry in a list of agents. <code>AgentListEntry</code> returns an array that contains a list of agents when the <a>ListAgents</a> operation is called.</p>"
    },
    "AgentStatus":{
      "type":"string",
      "enum":[
        "ONLINE",
        "OFFLINE"
      ]
    },
    "Atime":{
      "type":"string",
      "enum":[
        "NONE",
        "BEST_EFFORT"
      ]
    },
    "BytesPerSecond":{
      "type":"long",
      "min":-1
    },
    "CancelTaskExecutionRequest":{
      "type":"structure",
      "required":["TaskExecutionArn"],
      "members":{
        "TaskExecutionArn":{
          "shape":"TaskExecutionArn",
          "documentation":"<p>The Amazon Resource Name (ARN) of the task execution to cancel.</p>"
        }
      },
      "documentation":"<p>CancelTaskExecutionRequest</p>"
    },
    "CancelTaskExecutionResponse":{
      "type":"structure",
      "members":{
      }
    },
    "CreateAgentRequest":{
      "type":"structure",
      "required":["ActivationKey"],
      "members":{
        "ActivationKey":{
          "shape":"ActivationKey",
          "documentation":"<p>Your agent activation key. You can get the activation key either by sending an HTTP GET request with redirects that enable you to get the agent IP address (port 80). Alternatively, you can get it from the AWS DataSync console. </p> <p>The redirect URL returned in the response provides you the activation key for your agent in the query string parameter <code>activationKey</code>. It might also include other activation-related parameters; however, these are merely defaults. The arguments you pass to this API call determine the actual configuration of your agent. For more information, see <a href=\"https://docs.aws.amazon.com/sync-service/latest/userguide/working-with-sync-agents.html#activating-sync-agent\">Activating a Sync Agent</a> in the <i>AWS DataSync User Guide.</i> </p>"
        },
        "AgentName":{
          "shape":"TagValue",
          "documentation":"<p>The name you configured for your agent. This value is a text reference that is used to identify the agent in the console.</p>"
        },
        "Tags":{
          "shape":"TagList",
          "documentation":"<p>The key-value pair that represents the tag you want to associate with the agent. The value can be an empty string. This value helps you manage, filter, and search for your agents.</p> <note> <p>Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. </p> </note>"
        }
      },
      "documentation":"<p>CreateAgentRequest</p>"
    },
    "CreateAgentResponse":{
      "type":"structure",
      "members":{
        "AgentArn":{
          "shape":"AgentArn",
          "documentation":"<p>The Amazon Resource Name (ARN) of the agent. Use the <code>ListAgents</code> operation to return a list of agents for your account and AWS Region.</p>"
        }
      },
      "documentation":"<p>CreateAgentResponse</p>"
    },
    "CreateLocationEfsRequest":{
      "type":"structure",
      "required":[
        "Subdirectory",
        "EfsFilesystemArn",
        "Ec2Config"
      ],
      "members":{
        "Subdirectory":{
          "shape":"Subdirectory",
          "documentation":"<p>A subdirectory in the location’s path. This subdirectory in the EFS file system is used to read data from the EFS source location or write data to the EFS destination. By default, AWS DataSync uses the root directory.</p>"
        },
        "EfsFilesystemArn":{
          "shape":"EfsFilesystemArn",
          "documentation":"<p>The Amazon Resource Name (ARN) for the Amazon EFS file system.</p>"
        },
        "Ec2Config":{
          "shape":"Ec2Config",
          "documentation":"<p>The subnet and security group that the Amazon EFS file system uses.</p>"
        },
        "Tags":{
          "shape":"TagList",
          "documentation":"<p>The key-value pair that represents a tag that you want to add to the resource. The value can be an empty string. This value helps you manage, filter, and search for your resources. We recommend that you create a name tag for your location.</p>"
        }
      },
      "documentation":"<p>CreateLocationEfsRequest</p>"
    },
    "CreateLocationEfsResponse":{
      "type":"structure",
      "members":{
        "LocationArn":{
          "shape":"LocationArn",
          "documentation":"<p>The Amazon Resource Name (ARN) of the Amazon EFS file system location that is created.</p>"
        }
      },
      "documentation":"<p>CreateLocationEfs</p>"
    },
    "CreateLocationNfsRequest":{
      "type":"structure",
      "required":[
        "Subdirectory",
        "ServerHostname",
        "OnPremConfig"
      ],
      "members":{
        "Subdirectory":{
          "shape":"Subdirectory",
          "documentation":"<p>The subdirectory in the NFS file system that is used to read data from the NFS source location or write data to the NFS destination. The NFS path should be a path that's exported by the NFS server, or a subdirectory of that path. The path should be such that it can be mounted by other NFS clients in your network. </p> <p>To see all the paths exported by your NFS server. run \"<code>showmount -e nfs-server-name</code>\" from an NFS client that has access to your server. You can specify any directory that appears in the results, and any subdirectory of that directory. Ensure that the NFS export is accessible without Kerberos authentication. </p> <p>To transfer all the data in the folder you specified, DataSync needs to have permissions to read all the data. To ensure this, either configure the NFS export with <code>no_root_squash,</code> or ensure that the permissions for all of the files that you want sync allow read access for all users. Doing either enables the agent to read the files. For the agent to access directories, you must additionally enable all execute access. For information about NFS export configuration, see <a href=\"https://www.centos.org/docs/5/html/Deployment_Guide-en-US/s1-nfs-server-config-exports.html\">18.7. The /etc/exports Configuration File</a> in the Centos documentation. </p>"
        },
        "ServerHostname":{
          "shape":"ServerHostname",
          "documentation":"<p>The name of the NFS server. This value is the IP address or Domain Name Service (DNS) name of the NFS server. An agent that is installed on-premises uses this host name to mount the NFS server in a network. </p> <note> <p>This name must either be DNS-compliant or must be an IP version 4 (IPv4) address.</p> </note>"
        },
        "OnPremConfig":{
          "shape":"OnPremConfig",
          "documentation":"<p>Contains a list of Amazon Resource Names (ARNs) of agents that are used to connect to an NFS server.</p>"
        },
        "Tags":{
          "shape":"TagList",
          "documentation":"<p>The key-value pair that represents the tag that you want to add to the location. The value can be an empty string. We recommend using tags to name your resources.</p>"
        }
      },
      "documentation":"<p>CreateLocationNfsRequest</p>"
    },
    "CreateLocationNfsResponse":{
      "type":"structure",
      "members":{
        "LocationArn":{
          "shape":"LocationArn",
          "documentation":"<p>The Amazon Resource Name (ARN) of the source NFS file system location that is created.</p>"
        }
      },
      "documentation":"<p>CreateLocationNfsResponse</p>"
    },
    "CreateLocationS3Request":{
      "type":"structure",
      "required":[
        "Subdirectory",
        "S3BucketArn",
        "S3Config"
      ],
      "members":{
        "Subdirectory":{
          "shape":"Subdirectory",
          "documentation":"<p>A subdirectory in the Amazon S3 bucket. This subdirectory in Amazon S3 is used to read data from the S3 source location or write data to the S3 destination.</p>"
        },
        "S3BucketArn":{
          "shape":"S3BucketArn",
          "documentation":"<p>The Amazon Resource Name (ARN) of the Amazon S3 bucket.</p>"
        },
        "S3Config":{"shape":"S3Config"},
        "Tags":{
          "shape":"TagList",
          "documentation":"<p>The key-value pair that represents the tag that you want to add to the location. The value can be an empty string. We recommend using tags to name your resources.</p>"
        }
      },
      "documentation":"<p>CreateLocationS3Request</p>"
    },
    "CreateLocationS3Response":{
      "type":"structure",
      "members":{
        "LocationArn":{
          "shape":"LocationArn",
          "documentation":"<p>The Amazon Resource Name (ARN) of the source Amazon S3 bucket location that is created.</p>"
        }
      },
      "documentation":"<p>CreateLocationS3Response</p>"
    },
    "CreateTaskRequest":{
      "type":"structure",
      "required":[
        "SourceLocationArn",
        "DestinationLocationArn"
      ],
      "members":{
        "SourceLocationArn":{
          "shape":"LocationArn",
          "documentation":"<p>The Amazon Resource Name (ARN) of the source location for the task.</p>"
        },
        "DestinationLocationArn":{
          "shape":"LocationArn",
          "documentation":"<p>The Amazon Resource Name (ARN) of an AWS storage resource's location. </p>"
        },
        "CloudWatchLogGroupArn":{
          "shape":"LogGroupArn",
          "documentation":"<p>The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is used to monitor and log events in the task. For more information on these groups, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html\">Working with Log Groups and Log Streams</a> in the <i>Amazon CloudWatch User Guide. </i> </p> <p>For more information about how to useCloudWatchLogs with DataSync, see <a href=\"https://docs.aws.amazon.com/datasync/latest/userguide/monitor-datasync.html\">Monitoring Your Task</a>.</p>"
        },
        "Name":{
          "shape":"TagValue",
          "documentation":"<p>The name of a task. This value is a text reference that is used to identify the task in the console. </p>"
        },
        "Options":{
          "shape":"Options",
          "documentation":"<p>The set of configuration options that control the behavior of a single execution of the task that occurs when you call <code>StartTaskExecution</code>. You can configure these options to preserve metadata such as user ID (UID) and group ID (GID), file permissions, data integrity verification, and so on.</p> <p>For each individual task execution, you can override these options by specifying the <code>OverrideOptions</code> before starting a the task execution. For more information, see the operation. </p>"
        },
        "Tags":{
          "shape":"TagList",
          "documentation":"<p>The key-value pair that represents the tag that you want to add to the resource. The value can be an empty string. </p>"
        }
      },
      "documentation":"<p>CreateTaskRequest</p>"
    },
    "CreateTaskResponse":{
      "type":"structure",
      "members":{
        "TaskArn":{
          "shape":"TaskArn",
          "documentation":"<p>The Amazon Resource Name (ARN) of the task.</p>"
        }
      },
      "documentation":"<p>CreateTaskResponse</p>"
    },
    "DeleteAgentRequest":{
      "type":"structure",
      "required":["AgentArn"],
      "members":{
        "AgentArn":{
          "shape":"AgentArn",
          "documentation":"<p>The Amazon Resource Name (ARN) of the agent to delete. Use the <code>ListAgents</code> operation to return a list of agents for your account and AWS Region.</p>"
        }
      },
      "documentation":"<p>DeleteAgentRequest</p>"
    },
    "DeleteAgentResponse":{
      "type":"structure",
      "members":{
      }
    },
    "DeleteLocationRequest":{
      "type":"structure",
      "required":["LocationArn"],
      "members":{
        "LocationArn":{
          "shape":"LocationArn",
          "documentation":"<p>The Amazon Resource Name (ARN) of the location to delete.</p>"
        }
      },
      "documentation":"<p>DeleteLocation</p>"
    },
    "DeleteLocationResponse":{
      "type":"structure",
      "members":{
      }
    },
    "DeleteTaskRequest":{
      "type":"structure",
      "required":["TaskArn"],
      "members":{
        "TaskArn":{
          "shape":"TaskArn",
          "documentation":"<p>The Amazon Resource Name (ARN) of the task to delete.</p>"
        }
      },
      "documentation":"<p>DeleteTask</p>"
    },
    "DeleteTaskResponse":{
      "type":"structure",
      "members":{
      }
    },
    "DescribeAgentRequest":{
      "type":"structure",
      "required":["AgentArn"],
      "members":{
        "AgentArn":{
          "shape":"AgentArn",
          "documentation":"<p>The Amazon Resource Name (ARN) of the agent to describe.</p>"
        }
      },
      "documentation":"<p>DescribeAgent</p>"
    },
    "DescribeAgentResponse":{
      "type":"structure",
      "members":{
        "AgentArn":{
          "shape":"AgentArn",
          "documentation":"<p>The Amazon Resource Name (ARN) of the agent.</p>"
        },
        "Name":{
          "shape":"TagValue",
          "documentation":"<p>The name of the agent.</p>"
        },
        "Status":{
          "shape":"AgentStatus",
          "documentation":"<p>The status of the agent. If the status is ONLINE, then the agent is configured properly and is available to use. The Running status is the normal running status for an agent. If the status is OFFLINE, the agent's VM is turned off or the agent is in an unhealthy state. When the issue that caused the unhealthy state is resolved, the agent returns to ONLINE status.</p>"
        },
        "LastConnectionTime":{
          "shape":"Time",
          "documentation":"<p>The time that the agent was last connected.</p>"
        },
        "CreationTime":{
          "shape":"Time",
          "documentation":"<p>The time that the agent was activated (that is, created in your account).</p>"
        }
      },
      "documentation":"<p>DescribeAgentResponse</p>"
    },
    "DescribeLocationEfsRequest":{
      "type":"structure",
      "required":["LocationArn"],
      "members":{
        "LocationArn":{
          "shape":"LocationArn",
          "documentation":"<p>The Amazon Resource Name (ARN) of the EFS location to describe.</p>"
        }
      },
      "documentation":"<p>DescribeLocationEfsRequest</p>"
    },
    "DescribeLocationEfsResponse":{
      "type":"structure",
      "members":{
        "LocationArn":{
          "shape":"LocationArn",
          "documentation":"<p>The Amazon resource Name (ARN) of the EFS location that was described.</p>"
        },
        "LocationUri":{
          "shape":"LocationUri",
          "documentation":"<p>The URL of the EFS location that was described.</p>"
        },
        "Ec2Config":{"shape":"Ec2Config"},
        "CreationTime":{
          "shape":"Time",
          "documentation":"<p>The time that the EFS location was created.</p>"
        }
      },
      "documentation":"<p>DescribeLocationEfsResponse</p>"
    },
    "DescribeLocationNfsRequest":{
      "type":"structure",
      "required":["LocationArn"],
      "members":{
        "LocationArn":{
          "shape":"LocationArn",
          "documentation":"<p>The Amazon resource Name (ARN) of the NFS location to describe.</p>"
        }
      },
      "documentation":"<p>DescribeLocationNfsRequest</p>"
    },
    "DescribeLocationNfsResponse":{
      "type":"structure",
      "members":{
        "LocationArn":{
          "shape":"LocationArn",
          "documentation":"<p>The Amazon resource Name (ARN) of the NFS location that was described.</p>"
        },
        "LocationUri":{
          "shape":"LocationUri",
          "documentation":"<p>The URL of the source NFS location that was described.</p>"
        },
        "OnPremConfig":{"shape":"OnPremConfig"},
        "CreationTime":{
          "shape":"Time",
          "documentation":"<p>The time that the NFS location was created.</p>"
        }
      },
      "documentation":"<p>DescribeLocationNfsResponse</p>"
    },
    "DescribeLocationS3Request":{
      "type":"structure",
      "required":["LocationArn"],
      "members":{
        "LocationArn":{
          "shape":"LocationArn",
          "documentation":"<p>The Amazon Resource Name (ARN) of the Amazon S3 bucket location to describe.</p>"
        }
      },
      "documentation":"<p>DescribeLocationS3Request</p>"
    },
    "DescribeLocationS3Response":{
      "type":"structure",
      "members":{
        "LocationArn":{
          "shape":"LocationArn",
          "documentation":"<p>The Amazon Resource Name (ARN) of the Amazon S3 bucket location.</p>"
        },
        "LocationUri":{
          "shape":"LocationUri",
          "documentation":"<p>The URL of the Amazon S3 location that was described.</p>"
        },
        "S3Config":{"shape":"S3Config"},
        "CreationTime":{
          "shape":"Time",
          "documentation":"<p>The time that the Amazon S3 bucket location was created.</p>"
        }
      },
      "documentation":"<p>DescribeLocationS3Response</p>"
    },
    "DescribeTaskExecutionRequest":{
      "type":"structure",
      "required":["TaskExecutionArn"],
      "members":{
        "TaskExecutionArn":{
          "shape":"TaskExecutionArn",
          "documentation":"<p>The Amazon Resource Name (ARN) of the task that is being executed.</p>"
        }
      },
      "documentation":"<p>DescribeTaskExecutionRequest</p>"
    },
    "DescribeTaskExecutionResponse":{
      "type":"structure",
      "members":{
        "TaskExecutionArn":{
          "shape":"TaskExecutionArn",
          "documentation":"<p>The Amazon Resource Name (ARN) of the task execution that was described. <code>TaskExecutionArn</code> is hierarchical and includes <code>TaskArn</code> for the task that was executed. </p> <p>For example, a <code>TaskExecution</code> value with the ARN <code>arn:aws:sync:us-east-1:209870788375:task/task-0208075f79cedf4a2/execution/exec-08ef1e88ec491019b</code> executed the task with the ARN <code>arn:aws:sync:us-east-1:209870788375:task/task-0208075f79cedf4a2</code>. </p>"
        },
        "Status":{
          "shape":"TaskExecutionStatus",
          "documentation":"<p>The status of the task. For detailed information about sync statuses, see <a href=\"https://docs.aws.amazon.com/sync-service/latest/userguide/understand-sync-task-statuses.html\">Understanding Sync Task Statuses</a>.</p>"
        },
        "Options":{"shape":"Options"},
        "StartTime":{
          "shape":"Time",
          "documentation":"<p>The time that the task execution was started.</p>"
        },
        "EstimatedFilesToTransfer":{
          "shape":"long",
          "documentation":"<p>The expected number of files that is to be transferred over the network. This value is calculated during the PREPARING phase, before the TRANSFERRING phase. This value is the expected number of files to be transferred. It's calculated based on comparing the content of the source and destination locations and finding the delta that needs to be transferred. </p>"
        },
        "EstimatedBytesToTransfer":{
          "shape":"long",
          "documentation":"<p>The estimated physical number of bytes that is to be transferred over the network.</p>"
        },
        "FilesTransferred":{
          "shape":"long",
          "documentation":"<p>The actual number of files that was transferred over the network. This value is calculated and updated on an ongoing basis during the TRANSFERRING phase. It's updated periodically when each file is read from the source and sent over the network. </p> <p>If failures occur during a transfer, this value can be less than <code>EstimatedFilesToTransfer</code>. This value can also be greater than <code>EstimatedFilesTransferred</code> in some cases. This element is implementation-specific for some location types, so don't use it as an indicator for a correct file number or to monitor your task execution.</p>"
        },
        "BytesWritten":{
          "shape":"long",
          "documentation":"<p>The number of logical bytes written to the destination AWS storage resource.</p>"
        },
        "BytesTransferred":{
          "shape":"long",
          "documentation":"<p>The physical number of bytes transferred over the network.</p>"
        },
        "Result":{
          "shape":"TaskExecutionResultDetail",
          "documentation":"<p>The result of the task execution.</p>"
        }
      },
      "documentation":"<p>DescribeTaskExecutionResponse</p>"
    },
    "DescribeTaskRequest":{
      "type":"structure",
      "required":["TaskArn"],
      "members":{
        "TaskArn":{
          "shape":"TaskArn",
          "documentation":"<p>The Amazon Resource Name (ARN) of the task to describe.</p>"
        }
      },
      "documentation":"<p>DescribeTaskRequest</p>"
    },
    "DescribeTaskResponse":{
      "type":"structure",
      "members":{
        "TaskArn":{
          "shape":"TaskArn",
          "documentation":"<p>The Amazon Resource Name (ARN) of the task that was described.</p>"
        },
        "Status":{
          "shape":"TaskStatus",
          "documentation":"<p>The status of the task that was described. For detailed information about sync statuses, see <a href=\"https://docs.aws.amazon.com/sync-service/latest/userguide/understand-sync-task-statuses.html\">Understanding Sync Task Statuses</a>.</p>"
        },
        "Name":{
          "shape":"TagValue",
          "documentation":"<p>The name of the task that was described.</p>"
        },
        "CurrentTaskExecutionArn":{
          "shape":"TaskExecutionArn",
          "documentation":"<p>The Amazon Resource Name (ARN) of the task execution that is syncing files.</p>"
        },
        "SourceLocationArn":{
          "shape":"LocationArn",
          "documentation":"<p>The Amazon Resource Name (ARN) of the source file system's location.</p>"
        },
        "DestinationLocationArn":{
          "shape":"LocationArn",
          "documentation":"<p>The Amazon Resource Name (ARN) of the AWS storage resource's location.</p>"
        },
        "CloudWatchLogGroupArn":{
          "shape":"LogGroupArn",
          "documentation":"<p>The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that was used to monitor and log events in the task. For more information on these groups, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html\">Working with Log Groups and Log Streams</a> in the <i>Amazon CloudWatch User Guide.</i> </p>"
        },
        "Options":{
          "shape":"Options",
          "documentation":"<p>The set of configuration options that control the behavior of a single execution of the task that occurs when you call <code>StartTaskExecution</code>. You can configure these options to preserve metadata such as user ID (UID) and group (GID), file permissions, data integrity verification, and so on.</p> <p>For each individual task execution, you can override these options by specifying the overriding <code>OverrideOptions</code> value to operation. </p>"
        },
        "ErrorCode":{
          "shape":"string",
          "documentation":"<p>Errors that AWS DataSync encountered during execution of the task. You can use this error code to help troubleshoot issues.</p>"
        },
        "ErrorDetail":{
          "shape":"string",
          "documentation":"<p>Detailed description of an error that was encountered during the task execution. You can use this information to help troubleshoot issues. </p>"
        },
        "CreationTime":{
          "shape":"Time",
          "documentation":"<p>The time that the task was created.</p>"
        }
      },
      "documentation":"<p>DescribeTaskResponse</p>"
    },
    "Duration":{
      "type":"long",
      "min":0
    },
    "Ec2Config":{
      "type":"structure",
      "required":[
        "SubnetArn",
        "SecurityGroupArns"
      ],
      "members":{
        "SubnetArn":{
          "shape":"Ec2SubnetArn",
          "documentation":"<p>The ARN of the subnet that the Amazon EC2 resource belongs in. </p>"
        },
        "SecurityGroupArns":{
          "shape":"Ec2SecurityGroupArnList",
          "documentation":"<p>The Amazon Resource Names (ARNs) of the security groups that are configured for the Amazon EC2 resource.</p>"
        }
      },
      "documentation":"<p>The subnet and the security group that the target Amazon EFS file system uses. The subnet must have at least one mount target for that file system. The security group that you provide needs to be able to communicate with the security group on the mount target in the subnet specified. </p> <p>The exact relationship between security group M (of the mount target) and security group S (which you provide for DataSync to use at this stage) is as follows: </p> <ul> <li> <p> Security group M (which you associate with the mount target) must allow inbound access for the Transmission Control Protocol (TCP) on the NFS port (2049) from security group S. You can enable inbound connections either by IP address (CIDR range) or security group. </p> </li> <li> <p>Security group S (provided to DataSync to access EFS) should have a rule that enables outbound connections to the NFS port on one of the file system’s mount targets. You can enable outbound connections either by IP address (CIDR range) or security group. For information about security groups and mount targets, see <a href=\"https://docs.aws.amazon.com/efs/latest/ug/security-considerations.html#network-access\">Security Groups for Amazon EC2 Instances and Mount Targets</a> in the <i>Amazon EFS User Guide.</i> </p> </li> </ul>"
    },
    "Ec2SecurityGroupArn":{
      "type":"string",
      "max":128,
      "pattern":"^arn:(aws|aws-cn):ec2:[a-z\\-0-9]*:[0-9]{12}:security-group/.*$"
    },
    "Ec2SecurityGroupArnList":{
      "type":"list",
      "member":{"shape":"Ec2SecurityGroupArn"},
      "max":5,
      "min":1
    },
    "Ec2SubnetArn":{
      "type":"string",
      "max":128,
      "pattern":"^arn:(aws|aws-cn):ec2:[a-z\\-0-9]*:[0-9]{12}:subnet/.*$"
    },
    "EfsFilesystemArn":{
      "type":"string",
      "max":128,
      "pattern":"^arn:(aws|aws-cn):elasticfilesystem:[a-z\\-0-9]*:[0-9]{12}:file-system/fs-.*$"
    },
    "Gid":{
      "type":"string",
      "enum":[
        "NONE",
        "INT_VALUE",
        "NAME",
        "BOTH"
      ]
    },
    "IamRoleArn":{
      "type":"string",
      "max":2048,
      "pattern":"^arn:(aws|aws-cn):iam::[0-9]{12}:role/.*$"
    },
    "InvalidRequestException":{
      "type":"structure",
      "members":{
        "message":{"shape":"string"},
        "errorCode":{"shape":"string"}
      },
      "documentation":"<p>This exception is thrown when the client submits a malformed request.</p>",
      "exception":true
    },
    "ListAgentsRequest":{
      "type":"structure",
      "members":{
        "MaxResults":{
          "shape":"MaxResults",
          "documentation":"<p>The maximum number of agents to list.</p>"
        },
        "NextToken":{
          "shape":"NextToken",
          "documentation":"<p>An opaque string that indicates the position at which to begin the next list of agents.</p>"
        }
      },
      "documentation":"<p>ListAgentsRequest</p>"
    },
    "ListAgentsResponse":{
      "type":"structure",
      "members":{
        "Agents":{
          "shape":"AgentList",
          "documentation":"<p>A list of agents in your account.</p>"
        },
        "NextToken":{
          "shape":"NextToken",
          "documentation":"<p>An opaque string that indicates the position at which to begin returning the next list of agents.</p>"
        }
      },
      "documentation":"<p>ListAgentsResponse</p>"
    },
    "ListLocationsRequest":{
      "type":"structure",
      "members":{
        "MaxResults":{
          "shape":"MaxResults",
          "documentation":"<p>The maximum number of locations to return.</p>"
        },
        "NextToken":{
          "shape":"NextToken",
          "documentation":"<p>An opaque string that indicates the position at which to begin the next list of locations.</p>"
        }
      },
      "documentation":"<p>ListLocationsRequest</p>"
    },
    "ListLocationsResponse":{
      "type":"structure",
      "members":{
        "Locations":{
          "shape":"LocationList",
          "documentation":"<p>An array that contains a list of locations.</p>"
        },
        "NextToken":{
          "shape":"NextToken",
          "documentation":"<p>An opaque string that indicates the position at which to begin returning the next list of locations.</p>"
        }
      },
      "documentation":"<p>ListLocationsResponse</p>"
    },
    "ListTagsForResourceRequest":{
      "type":"structure",
      "required":["ResourceArn"],
      "members":{
        "ResourceArn":{
          "shape":"TaggableResourceArn",
          "documentation":"<p>The Amazon Resource Name (ARN) of the resource whose tags to list.</p>"
        },
        "MaxResults":{
          "shape":"MaxResults",
          "documentation":"<p>The maximum number of locations to return.</p>"
        },
        "NextToken":{
          "shape":"NextToken",
          "documentation":"<p>An opaque string that indicates the position at which to begin the next list of locations.</p>"
        }
      },
      "documentation":"<p>ListTagsForResourceRequest</p>"
    },
    "ListTagsForResourceResponse":{
      "type":"structure",
      "members":{
        "Tags":{
          "shape":"TagList",
          "documentation":"<p>Array of resource tags.</p>"
        },
        "NextToken":{
          "shape":"NextToken",
          "documentation":"<p>An opaque string that indicates the position at which to begin returning the next list of resource tags.</p>"
        }
      },
      "documentation":"<p>ListTagsForResourceResponse</p>"
    },
    "ListTaskExecutionsRequest":{
      "type":"structure",
      "members":{
        "TaskArn":{
          "shape":"TaskArn",
          "documentation":"<p>The Amazon Resource Name (ARN) of the task whose tasks you want to list.</p>"
        },
        "MaxResults":{
          "shape":"MaxResults",
          "documentation":"<p>The maximum number of executed tasks to list.</p>"
        },
        "NextToken":{
          "shape":"NextToken",
          "documentation":"<p>An opaque string that indicates the position at which to begin the next list of the executed tasks.</p>"
        }
      },
      "documentation":"<p>ListTaskExecutions</p>"
    },
    "ListTaskExecutionsResponse":{
      "type":"structure",
      "members":{
        "TaskExecutions":{
          "shape":"TaskExecutionList",
          "documentation":"<p>A list of executed tasks.</p>"
        },
        "NextToken":{
          "shape":"NextToken",
          "documentation":"<p>An opaque string that indicates the position at which to begin returning the next list of executed tasks.</p>"
        }
      },
      "documentation":"<p>ListTaskExecutionsResponse</p>"
    },
    "ListTasksRequest":{
      "type":"structure",
      "members":{
        "MaxResults":{
          "shape":"MaxResults",
          "documentation":"<p>The maximum number of tasks to return.</p>"
        },
        "NextToken":{
          "shape":"NextToken",
          "documentation":"<p>An opaque string that indicates the position at which to begin the next list of tasks.</p>"
        }
      },
      "documentation":"<p>ListTasksRequest</p>"
    },
    "ListTasksResponse":{
      "type":"structure",
      "members":{
        "Tasks":{
          "shape":"TaskList",
          "documentation":"<p>A list of all the tasks that are returned.</p>"
        },
        "NextToken":{
          "shape":"NextToken",
          "documentation":"<p>An opaque string that indicates the position at which to begin returning the next list of tasks.</p>"
        }
      },
      "documentation":"<p>ListTasksResponse</p>"
    },
    "LocationArn":{
      "type":"string",
      "max":128,
      "pattern":"^arn:(aws|aws-cn):datasync:[a-z\\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$"
    },
    "LocationList":{
      "type":"list",
      "member":{"shape":"LocationListEntry"}
    },
    "LocationListEntry":{
      "type":"structure",
      "members":{
        "LocationArn":{
          "shape":"LocationArn",
          "documentation":"<p>The Amazon Resource Name (ARN) of the location. For Network File System (NFS) or Amazon EFS, the location is the export path. For Amazon S3, the location is the prefix path that you want to mount and use as the root of the location.</p>"
        },
        "LocationUri":{
          "shape":"LocationUri",
          "documentation":"<p>Represents a list of URLs of a location. <code>LocationUri</code> returns an array that contains a list of locations when the <a>ListLocations</a> operation is called.</p> <p>Format: <code>TYPE://GLOBAL_ID/SUBDIR</code>.</p> <p>TYPE designates the type of location. Valid values: NFS | EFS | S3.</p> <p>GLOBAL_ID is the globally unique identifier of the resource that backs the location. An example for EFS is <code>us-east-2.fs-abcd1234</code>. An example for Amazon S3 is the bucket name, such as <code>myBucket</code>. An example for NFS is a valid IPv4 address or a host name compliant with Domain Name Service (DNS).</p> <p>SUBDIR is a valid file system path, delimited by forward slashes as is the *nix convention. For NFS and Amazon EFS, it's the export path to mount the location. For Amazon S3, it's the prefix path that you mount to and treat as the root of the location.</p> <p/>"
        }
      },
      "documentation":"<p>Represents a single entry in a list of locations. <code>LocationListEntry</code> returns an array that contains a list of locations when the <a>ListLocations</a> operation is called.</p>"
    },
    "LocationUri":{
      "type":"string",
      "pattern":"(efs|nfs|s3)://[a-zA-Z0-9.\\-]+"
    },
    "LogGroupArn":{
      "type":"string",
      "max":562,
      "pattern":"^arn:(aws|aws-cn):logs:[a-z\\-0-9]*:[0-9]{12}:log-group:([^:\\*]*)$"
    },
    "MaxResults":{
      "type":"integer",
      "max":100,
      "min":0
    },
    "Mtime":{
      "type":"string",
      "enum":[
        "NONE",
        "PRESERVE"
      ]
    },
    "NextToken":{
      "type":"string",
      "max":93,
      "pattern":"[a-zA-Z0-9=_-]+"
    },
    "OnPremConfig":{
      "type":"structure",
      "required":["AgentArns"],
      "members":{
        "AgentArns":{
          "shape":"AgentArnList",
          "documentation":"<p>ARNs)of the agents to use for an NFS location.</p>"
        }
      },
      "documentation":"<p>A list of Amazon Resource Names (ARNs) of agents to use for a Network File System (NFS) location.</p>"
    },
    "Options":{
      "type":"structure",
      "members":{
        "VerifyMode":{
          "shape":"VerifyMode",
          "documentation":"<p>A value that determines whether a data integrity verification should be performed at the end of a task execution after all data and metadata have been transferred. </p> <p>Default value: POINT_IN_TIME_CONSISTENT.</p> <p>POINT_IN_TIME_CONSISTENT: Perform verification (recommended). </p> <p>NONE: Skip verification.</p>"
        },
        "Atime":{
          "shape":"Atime",
          "documentation":"<p>A file metadata value that shows the last time a file was accessed (that is, when the file was read or written to). If you set <code>Atime</code> to BEST_EFFORT, DataSync attempts to preserve the original <code>Atime</code> attribute on all source files (that is, the version before the PREPARING phase). However, <code>Atime</code>'s behavior is not fully standard across platforms, so AWS DataSync can only do this on a best-effort basis. </p> <p>Default value: BEST_EFFORT.</p> <p>BEST_EFFORT: Attempt to preserve the per-file <code>Atime</code> value (recommended).</p> <p>NONE: Ignore <code>Atime</code>.</p> <note> <p>If <code>Atime</code> is set to BEST_EFFORT, <code>Mtime</code> must be set to PRESERVE. </p> <p>If <code>Atime</code> is set to NONE, <code>Mtime</code> must also be NONE. </p> </note>"
        },
        "Mtime":{
          "shape":"Mtime",
          "documentation":"<p>A value that indicates the last time that a file was modified (that is, a file was written to) before the PREPARING phase. </p> <p>Default value: PRESERVE. </p> <p>PRESERVE: Preserve original <code>Mtime</code> (recommended)</p> <p> NONE: Ignore <code>Mtime</code>. </p> <note> <p>If <code>Mtime</code> is set to PRESERVE, <code>Atime</code> must be set to BEST_EFFORT.</p> <p>If <code>Mtime</code> is set to NONE, <code>Atime</code> must also be set to NONE. </p> </note>"
        },
        "Uid":{
          "shape":"Uid",
          "documentation":"<p>The user ID (UID) of the file's owner. </p> <p>Default value: INT_VALUE. This preserves the integer value of the ID.</p> <p>INT_VALUE: Preserve the integer value of UID and group ID (GID) (recommended).</p> <p>NONE: Ignore UID and GID. </p>"
        },
        "Gid":{
          "shape":"Gid",
          "documentation":"<p>The group ID (GID) of the file's owners. </p> <p>Default value: INT_VALUE. This preserves the integer value of the ID.</p> <p>INT_VALUE: Preserve the integer value of user ID (UID) and GID (recommended).</p> <p>NONE: Ignore UID and GID. </p>"
        },
        "PreserveDeletedFiles":{
          "shape":"PreserveDeletedFiles",
          "documentation":"<p>A value that specifies whether files in the destination that don't exist in the source file system should be preserved. </p> <p>Default value: PRESERVE.</p> <p>PRESERVE: Ignore such destination files (recommended). </p> <p>REMOVE: Delete destination files that aren’t present in the source.</p>"
        },
        "PreserveDevices":{
          "shape":"PreserveDevices",
          "documentation":"<p>A value that determines whether AWS DataSync should preserve the metadata of block and character devices in the source file system, and recreate the files with that device name and metadata on the destination.</p> <note> <p>AWS DataSync can't sync the actual contents of such devices, because they are nonterminal and don't return an end-of-file (EOF) marker.</p> </note> <p>Default value: NONE.</p> <p>NONE: Ignore special devices (recommended). </p> <p>PRESERVE: Preserve character and block device metadata. This option isn't currently supported for Amazon EFS. </p>"
        },
        "PosixPermissions":{
          "shape":"PosixPermissions",
          "documentation":"<p>A value that determines which users or groups can access a file for a specific purpose such as reading, writing, or execution of the file. </p> <p>Default value: PRESERVE.</p> <p>PRESERVE: Preserve POSIX-style permissions (recommended).</p> <p>NONE: Ignore permissions. </p> <note> <p>AWS DataSync can preserve extant permissions of a source location.</p> </note>"
        },
        "BytesPerSecond":{
          "shape":"BytesPerSecond",
          "documentation":"<p>A value that limits the bandwidth used by AWS DataSync. For example, if you want AWS DataSync to use a maximum of 1 MB, set this value to <code>1048576</code> (<code>=1024*1024</code>).</p>"
        }
      },
      "documentation":"<p>Represents the options that are available to control the behavior of a <a>StartTaskExecution</a> operation. Behavior includes preserving metadata such as user ID (UID), group ID (GID), and file permissions, and also overwriting files in the destination, data integrity verification, and so on.</p> <p>A task has a set of default options associated with it. If you don't specify an option in <a>StartTaskExecution</a>, the default value is used. You can override the defaults options on each task execution by specifying an overriding <code>Options</code> value to <a>StartTaskExecution</a>.</p>"
    },
    "PhaseStatus":{
      "type":"string",
      "enum":[
        "PENDING",
        "SUCCESS",
        "ERROR"
      ]
    },
    "PosixPermissions":{
      "type":"string",
      "enum":[
        "NONE",
        "BEST_EFFORT",
        "PRESERVE"
      ]
    },
    "PreserveDeletedFiles":{
      "type":"string",
      "enum":[
        "PRESERVE",
        "REMOVE"
      ]
    },
    "PreserveDevices":{
      "type":"string",
      "enum":[
        "NONE",
        "PRESERVE"
      ]
    },
    "S3BucketArn":{
      "type":"string",
      "max":76,
      "pattern":"^arn:(aws|aws-cn):s3:::([^/]*)$"
    },
    "S3Config":{
      "type":"structure",
      "required":["BucketAccessRoleArn"],
      "members":{
        "BucketAccessRoleArn":{
          "shape":"IamRoleArn",
          "documentation":"<p>The Amazon S3 bucket to access. This bucket is used as a parameter in the <a>CreateLocationS3</a> operation. </p>"
        }
      },
      "documentation":"<p>The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that is used to access an Amazon S3 bucket. For detailed information about using such a role, see <a href=\"https://alpha-aws-docs.aws.amazon.com/sync-service/latest/userguide/create-locations-cli.html#create-location-s3-cli\">Components and Terminology</a> in the <i>AWS DataSync User Guide</i>.</p>"
    },
    "ServerHostname":{
      "type":"string",
      "max":255,
      "pattern":"^(([a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9\\-]*[A-Za-z0-9])$"
    },
    "StartTaskExecutionRequest":{
      "type":"structure",
      "required":["TaskArn"],
      "members":{
        "TaskArn":{
          "shape":"TaskArn",
          "documentation":"<p>The Amazon Resource Name (ARN) of the task to start.</p>"
        },
        "OverrideOptions":{"shape":"Options"}
      },
      "documentation":"<p>StartTaskExecutionRequest</p>"
    },
    "StartTaskExecutionResponse":{
      "type":"structure",
      "members":{
        "TaskExecutionArn":{
          "shape":"TaskExecutionArn",
          "documentation":"<p>The Amazon Resource Name (ARN) of the specific task execution that was started.</p>"
        }
      },
      "documentation":"<p>StartTaskExecutionResponse</p>"
    },
    "Subdirectory":{
      "type":"string",
      "max":4096,
      "pattern":"^[a-zA-Z0-9_\\-\\./]+$"
    },
    "TagKey":{
      "type":"string",
      "max":256,
      "min":1,
      "pattern":"^[a-zA-Z0-9\\s+=._:/-]{1,128}$"
    },
    "TagKeyList":{
      "type":"list",
      "member":{"shape":"TagKey"},
      "max":50,
      "min":1
    },
    "TagList":{
      "type":"list",
      "member":{"shape":"TagListEntry"},
      "max":55,
      "min":0
    },
    "TagListEntry":{
      "type":"structure",
      "members":{
        "Key":{
          "shape":"TagKey",
          "documentation":"<p>The key for an AWS resource tag.</p>"
        },
        "Value":{
          "shape":"TagValue",
          "documentation":"<p>The value for an AWS resource tag.</p>"
        }
      },
      "documentation":"<p>Represents a single entry in a list of AWS resource tags. <code>TagListEntry</code> returns an array that contains a list of tasks when the <a>ListTagsForResource</a> operation is called.</p>"
    },
    "TagResourceRequest":{
      "type":"structure",
      "required":[
        "ResourceArn",
        "Tags"
      ],
      "members":{
        "ResourceArn":{
          "shape":"TaggableResourceArn",
          "documentation":"<p>The Amazon Resource Name (ARN) of the resource to apply the tag to.</p>"
        },
        "Tags":{
          "shape":"TagList",
          "documentation":"<p>The tags to apply.</p>"
        }
      },
      "documentation":"<p>TagResourceRequest</p>"
    },
    "TagResourceResponse":{
      "type":"structure",
      "members":{
      }
    },
    "TagValue":{
      "type":"string",
      "max":256,
      "min":1,
      "pattern":"^[a-zA-Z0-9\\s+=._:/-]{1,256}$"
    },
    "TaggableResourceArn":{
      "type":"string",
      "max":128,
      "pattern":"^arn:(aws|aws-cn):datasync:[a-z\\-0-9]+:[0-9]{12}:(agent|task|location)/(agent|task|loc)-[0-9a-z]{17}$"
    },
    "TaskArn":{
      "type":"string",
      "max":128,
      "pattern":"^arn:(aws|aws-cn):datasync:[a-z\\-0-9]*:[0-9]{12}:task/task-[0-9a-f]{17}$"
    },
    "TaskExecutionArn":{
      "type":"string",
      "max":128,
      "pattern":"^arn:(aws|aws-cn):datasync:[a-z\\-0-9]*:[0-9]{12}:task/task-[0-9a-f]{17}/execution/exec-[0-9a-f]{17}$"
    },
    "TaskExecutionList":{
      "type":"list",
      "member":{"shape":"TaskExecutionListEntry"}
    },
    "TaskExecutionListEntry":{
      "type":"structure",
      "members":{
        "TaskExecutionArn":{
          "shape":"TaskExecutionArn",
          "documentation":"<p>The Amazon Resource Name (ARN) of the task that was executed.</p>"
        },
        "Status":{
          "shape":"TaskExecutionStatus",
          "documentation":"<p>The status of a task execution.</p>"
        }
      },
      "documentation":"<p>Represents a single entry in a list of task executions. <code>TaskExecutionListEntry</code> returns an array that contains a list of specific invocations of a task when <a>ListTaskExecutions</a> operation is called.</p>"
    },
    "TaskExecutionResultDetail":{
      "type":"structure",
      "members":{
        "PrepareDuration":{
          "shape":"Duration",
          "documentation":"<p>The total time in milliseconds that AWS DataSync spent in the PREPARING phase. </p>"
        },
        "PrepareStatus":{
          "shape":"PhaseStatus",
          "documentation":"<p>The status of the PREPARING phase.</p>"
        },
        "TransferDuration":{
          "shape":"Duration",
          "documentation":"<p>The total time in milliseconds that AWS DataSync spent in the TRANSFERRING phase.</p>"
        },
        "TransferStatus":{
          "shape":"PhaseStatus",
          "documentation":"<p>The status of the TRANSFERRING Phase.</p>"
        },
        "VerifyDuration":{
          "shape":"Duration",
          "documentation":"<p>The total time in milliseconds that AWS DataSync spent in the VERIFYING phase.</p>"
        },
        "VerifyStatus":{
          "shape":"PhaseStatus",
          "documentation":"<p>The status of the VERIFYING Phase.</p>"
        },
        "ErrorCode":{
          "shape":"string",
          "documentation":"<p>Errors that AWS DataSync encountered during execution of the task. You can use this error code to help troubleshoot issues.</p>"
        },
        "ErrorDetail":{
          "shape":"string",
          "documentation":"<p>Detailed description of an error that was encountered during the task execution. You can use this information to help troubleshoot issues. </p>"
        }
      },
      "documentation":"<p>Describes the detailed result of a <code>TaskExecution</code> operation. This result includes the time in milliseconds spent in each phase, the status of the task execution, and the errors encountered.</p>"
    },
    "TaskExecutionStatus":{
      "type":"string",
      "enum":[
        "LAUNCHING",
        "PREPARING",
        "TRANSFERRING",
        "VERIFYING",
        "SUCCESS",
        "ERROR"
      ]
    },
    "TaskList":{
      "type":"list",
      "member":{"shape":"TaskListEntry"}
    },
    "TaskListEntry":{
      "type":"structure",
      "members":{
        "TaskArn":{
          "shape":"TaskArn",
          "documentation":"<p>The Amazon Resource Name (ARN) of the task.</p>"
        },
        "Status":{
          "shape":"TaskStatus",
          "documentation":"<p>The status of the task.</p>"
        },
        "Name":{
          "shape":"TagValue",
          "documentation":"<p>The name of the task.</p>"
        }
      },
      "documentation":"<p>Represents a single entry in a list of tasks. <code>TaskListEntry</code> returns an array that contains a list of tasks when the <a>ListTasks</a> operation is called. A task includes the source and destination file systems to sync and the options to use for the tasks.</p>"
    },
    "TaskStatus":{
      "type":"string",
      "enum":[
        "AVAILABLE",
        "CREATING",
        "RUNNING",
        "UNAVAILABLE"
      ]
    },
    "Time":{"type":"timestamp"},
    "Uid":{
      "type":"string",
      "enum":[
        "NONE",
        "INT_VALUE",
        "NAME",
        "BOTH"
      ]
    },
    "UntagResourceRequest":{
      "type":"structure",
      "required":[
        "ResourceArn",
        "Keys"
      ],
      "members":{
        "ResourceArn":{
          "shape":"TaggableResourceArn",
          "documentation":"<p>The Amazon Resource Name (ARN) of the resource to remove the tag from.</p>"
        },
        "Keys":{
          "shape":"TagKeyList",
          "documentation":"<p>The keys in the key-value pair in the tag to remove.</p>"
        }
      },
      "documentation":"<p>UntagResourceRequest</p>"
    },
    "UntagResourceResponse":{
      "type":"structure",
      "members":{
      }
    },
    "UpdateAgentRequest":{
      "type":"structure",
      "required":["AgentArn"],
      "members":{
        "AgentArn":{
          "shape":"AgentArn",
          "documentation":"<p>The Amazon Resource Name (ARN) of the agent to update.</p>"
        },
        "Name":{
          "shape":"TagValue",
          "documentation":"<p>The name that you want to use to configure the agent.</p>"
        }
      },
      "documentation":"<p>UpdateAgentRequest</p>"
    },
    "UpdateAgentResponse":{
      "type":"structure",
      "members":{
      }
    },
    "UpdateTaskRequest":{
      "type":"structure",
      "required":["TaskArn"],
      "members":{
        "TaskArn":{
          "shape":"TaskArn",
          "documentation":"<p>The Amazon Resource Name (ARN) of the resource name of the task to update.</p>"
        },
        "Options":{"shape":"Options"},
        "Name":{
          "shape":"TagValue",
          "documentation":"<p>The name of the task to update.</p>"
        }
      },
      "documentation":"<p>UpdateTaskResponse</p>"
    },
    "UpdateTaskResponse":{
      "type":"structure",
      "members":{
      }
    },
    "VerifyMode":{
      "type":"string",
      "enum":[
        "POINT_IN_TIME_CONSISTENT",
        "NONE"
      ]
    },
    "long":{"type":"long"},
    "string":{"type":"string"}
  },
  "documentation":"<fullname>AWS DataSync</fullname> <p>AWS DataSync is a managed data transfer service that makes it simpler for you to automate moving data between on-premises storage and Amazon Simple Storage Service (Amazon S3) or Amazon Elastic File System (Amazon EFS). </p> <p>This API interface reference for AWS DataSync contains documentation for a programming interface that you can use to manage AWS DataSync.</p>"
}
