UNPKG

openapi-directory

Version:

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

1 lines 55.9 kB
{"openapi":"3.0.0","info":{"version":"2018-11-09","x-release":"v4","title":"AWS DataSync","description":"<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>","x-logo":{"url":"https://twitter.com/awscloud/profile_image?size=original","backgroundColor":"#FFFFFF"},"termsOfService":"https://aws.amazon.com/service-terms/","contact":{"name":"Mike Ralphson","email":"mike.ralphson@gmail.com","url":"https://github.com/mermade/aws2openapi","x-twitter":"PermittedSoc"},"license":{"name":"Apache 2.0 License","url":"http://www.apache.org/licenses/"},"x-providerName":"amazonaws.com","x-serviceName":"datasync","x-origin":[{"contentType":"application/json","url":"https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/datasync-2018-11-09.normal.json","converter":{"url":"https://github.com/mermade/aws2openapi","version":"1.0.0"},"x-apisguru-direct":true}],"x-apiClientRegistration":{"url":"https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct"},"x-apisguru-categories":["cloud"],"x-preferred":true},"externalDocs":{"description":"Amazon Web Services documentation","url":"https://aws.amazon.com/datasync/"},"x-hasEquivalentPaths":true,"security":[{"hmac":[]}],"paths":{"/":{"post":{"operationId":"CancelTaskExecution","description":"<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>","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelTaskExecutionResponse"}}}},"480":{"description":"InvalidRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidRequestException"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelTaskExecutionRequest"}}},"required":true}},"parameters":[{"$ref":"#/components/parameters/Action"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/#CreateAgent":{"post":{"operationId":"CreateAgent","description":"<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/>","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAgentResponse"}}}},"480":{"description":"InvalidRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidRequestException"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAgentRequest"}}},"required":true}},"parameters":[{"$ref":"#/components/parameters/Action"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/#CreateLocationEfs":{"post":{"operationId":"CreateLocationEfs","description":"Creates an endpoint for an Amazon EFS file system.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateLocationEfsResponse"}}}},"480":{"description":"InvalidRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidRequestException"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateLocationEfsRequest"}}},"required":true}},"parameters":[{"$ref":"#/components/parameters/Action"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/#CreateLocationNfs":{"post":{"operationId":"CreateLocationNfs","description":"Creates an endpoint for a Network File System (NFS) file system.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateLocationNfsResponse"}}}},"480":{"description":"InvalidRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidRequestException"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateLocationNfsRequest"}}},"required":true}},"parameters":[{"$ref":"#/components/parameters/Action"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/#CreateLocationS3":{"post":{"operationId":"CreateLocationS3","description":"<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>","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateLocationS3Response"}}}},"480":{"description":"InvalidRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidRequestException"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateLocationS3Request"}}},"required":true}},"parameters":[{"$ref":"#/components/parameters/Action"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/#CreateTask":{"post":{"operationId":"CreateTask","description":"<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>","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateTaskResponse"}}}},"480":{"description":"InvalidRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidRequestException"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateTaskRequest"}}},"required":true}},"parameters":[{"$ref":"#/components/parameters/Action"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/#DeleteAgent":{"post":{"operationId":"DeleteAgent","description":"<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>","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteAgentResponse"}}}},"480":{"description":"InvalidRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidRequestException"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteAgentRequest"}}},"required":true}},"parameters":[{"$ref":"#/components/parameters/Action"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/#DeleteLocation":{"post":{"operationId":"DeleteLocation","description":"Deletes the configuration of a location used by AWS DataSync. ","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteLocationResponse"}}}},"480":{"description":"InvalidRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidRequestException"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteLocationRequest"}}},"required":true}},"parameters":[{"$ref":"#/components/parameters/Action"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/#DeleteTask":{"post":{"operationId":"DeleteTask","description":"Deletes a task.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteTaskResponse"}}}},"480":{"description":"InvalidRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidRequestException"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteTaskRequest"}}},"required":true}},"parameters":[{"$ref":"#/components/parameters/Action"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/#DescribeAgent":{"post":{"operationId":"DescribeAgent","description":"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. ","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DescribeAgentResponse"}}}},"480":{"description":"InvalidRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidRequestException"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DescribeAgentRequest"}}},"required":true}},"parameters":[{"$ref":"#/components/parameters/Action"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/#DescribeLocationEfs":{"post":{"operationId":"DescribeLocationEfs","description":"Returns metadata, such as the path information about an Amazon EFS location.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DescribeLocationEfsResponse"}}}},"480":{"description":"InvalidRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidRequestException"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DescribeLocationEfsRequest"}}},"required":true}},"parameters":[{"$ref":"#/components/parameters/Action"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/#DescribeLocationNfs":{"post":{"operationId":"DescribeLocationNfs","description":"Returns metadata, such as the path information, about a NFS location.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DescribeLocationNfsResponse"}}}},"480":{"description":"InvalidRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidRequestException"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DescribeLocationNfsRequest"}}},"required":true}},"parameters":[{"$ref":"#/components/parameters/Action"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/#DescribeLocationS3":{"post":{"operationId":"DescribeLocationS3","description":"Returns metadata, such as bucket name, about an Amazon S3 bucket location.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DescribeLocationS3Response"}}}},"480":{"description":"InvalidRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidRequestException"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DescribeLocationS3Request"}}},"required":true}},"parameters":[{"$ref":"#/components/parameters/Action"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/#DescribeTask":{"post":{"operationId":"DescribeTask","description":"Returns metadata about a task.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DescribeTaskResponse"}}}},"480":{"description":"InvalidRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidRequestException"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DescribeTaskRequest"}}},"required":true}},"parameters":[{"$ref":"#/components/parameters/Action"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/#DescribeTaskExecution":{"post":{"operationId":"DescribeTaskExecution","description":"Returns detailed metadata about a task that is being executed.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DescribeTaskExecutionResponse"}}}},"480":{"description":"InvalidRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidRequestException"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DescribeTaskExecutionRequest"}}},"required":true}},"parameters":[{"$ref":"#/components/parameters/Action"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/#ListAgents":{"post":{"operationId":"ListAgents","description":"<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>","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListAgentsResponse"}}}},"480":{"description":"InvalidRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidRequestException"}}}}},"parameters":[{"name":"MaxResults","in":"query","description":"Pagination limit","required":false,"schema":{"type":"string"}},{"name":"NextToken","in":"query","description":"Pagination token","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListAgentsRequest"}}},"required":true}},"parameters":[{"$ref":"#/components/parameters/Action"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/#ListLocations":{"post":{"operationId":"ListLocations","description":"<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>","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListLocationsResponse"}}}},"480":{"description":"InvalidRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidRequestException"}}}}},"parameters":[{"name":"MaxResults","in":"query","description":"Pagination limit","required":false,"schema":{"type":"string"}},{"name":"NextToken","in":"query","description":"Pagination token","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListLocationsRequest"}}},"required":true}},"parameters":[{"$ref":"#/components/parameters/Action"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/#ListTagsForResource":{"post":{"operationId":"ListTagsForResource","description":"Returns all the tags associated with a specified resources. ","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListTagsForResourceResponse"}}}},"480":{"description":"InvalidRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidRequestException"}}}}},"parameters":[{"name":"MaxResults","in":"query","description":"Pagination limit","required":false,"schema":{"type":"string"}},{"name":"NextToken","in":"query","description":"Pagination token","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListTagsForResourceRequest"}}},"required":true}},"parameters":[{"$ref":"#/components/parameters/Action"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/#ListTaskExecutions":{"post":{"operationId":"ListTaskExecutions","description":"Returns a list of executed tasks.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListTaskExecutionsResponse"}}}},"480":{"description":"InvalidRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidRequestException"}}}}},"parameters":[{"name":"MaxResults","in":"query","description":"Pagination limit","required":false,"schema":{"type":"string"}},{"name":"NextToken","in":"query","description":"Pagination token","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListTaskExecutionsRequest"}}},"required":true}},"parameters":[{"$ref":"#/components/parameters/Action"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/#ListTasks":{"post":{"operationId":"ListTasks","description":"Returns a list of all the tasks.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListTasksResponse"}}}},"480":{"description":"InvalidRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidRequestException"}}}}},"parameters":[{"name":"MaxResults","in":"query","description":"Pagination limit","required":false,"schema":{"type":"string"}},{"name":"NextToken","in":"query","description":"Pagination token","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListTasksRequest"}}},"required":true}},"parameters":[{"$ref":"#/components/parameters/Action"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/#StartTaskExecution":{"post":{"operationId":"StartTaskExecution","description":"<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>","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartTaskExecutionResponse"}}}},"480":{"description":"InvalidRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidRequestException"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartTaskExecutionRequest"}}},"required":true}},"parameters":[{"$ref":"#/components/parameters/Action"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/#TagResource":{"post":{"operationId":"TagResource","description":"Applies a key-value pair to an AWS resource.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TagResourceResponse"}}}},"480":{"description":"InvalidRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidRequestException"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TagResourceRequest"}}},"required":true}},"parameters":[{"$ref":"#/components/parameters/Action"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/#UntagResource":{"post":{"operationId":"UntagResource","description":"Removes a tag from an AWS resource.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UntagResourceResponse"}}}},"480":{"description":"InvalidRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidRequestException"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UntagResourceRequest"}}},"required":true}},"parameters":[{"$ref":"#/components/parameters/Action"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/#UpdateAgent":{"post":{"operationId":"UpdateAgent","description":"Updates the name of an agent.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAgentResponse"}}}},"480":{"description":"InvalidRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidRequestException"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAgentRequest"}}},"required":true}},"parameters":[{"$ref":"#/components/parameters/Action"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/#UpdateTask":{"post":{"operationId":"UpdateTask","description":"Updates the metadata associated with a task.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateTaskResponse"}}}},"480":{"description":"InvalidRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidRequestException"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateTaskRequest"}}},"required":true}},"parameters":[{"$ref":"#/components/parameters/Action"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]}},"servers":[{"url":"https://datasync.amazonaws.com/"},{"url":"http://datasync.amazonaws.com/"}],"components":{"parameters":{"Action":{"name":"Action","in":"query","required":true,"schema":{"type":"string"}},"Version":{"name":"Version","in":"query","required":true,"schema":{"type":"string"}},"X-Amz-Content-Sha256":{"name":"X-Amz-Content-Sha256","in":"header","required":false,"schema":{"type":"string"}},"X-Amz-Date":{"name":"X-Amz-Date","in":"header","required":false,"schema":{"type":"string"}},"X-Amz-Algorithm":{"name":"X-Amz-Algorithm","in":"header","required":false,"schema":{"type":"string"}},"X-Amz-Credential":{"name":"X-Amz-Credential","in":"header","required":false,"schema":{"type":"string"}},"X-Amz-Security-Token":{"name":"X-Amz-Security-Token","in":"header","required":false,"schema":{"type":"string"}},"X-Amz-Signature":{"name":"X-Amz-Signature","in":"header","required":false,"schema":{"type":"string"}},"X-Amz-SignedHeaders":{"name":"X-Amz-SignedHeaders","in":"header","required":false,"schema":{"type":"string"}}},"securitySchemes":{"hmac":{"type":"apiKey","name":"Authorization","in":"header","description":"Amazon Signature authorization v4","x-amazon-apigateway-authtype":"awsSigv4"}},"schemas":{"CancelTaskExecutionResponse":{"type":"object","properties":{}},"CancelTaskExecutionRequest":{"type":"object","required":["TaskExecutionArn"],"properties":{"TaskExecutionArn":{"$ref":"#/components/schemas/TaskExecutionArn"}},"description":"CancelTaskExecutionRequest"},"InvalidRequestException":{},"CreateAgentResponse":{"type":"object","properties":{"AgentArn":{"$ref":"#/components/schemas/AgentArn"}},"description":"CreateAgentResponse"},"CreateAgentRequest":{"type":"object","required":["ActivationKey"],"properties":{"ActivationKey":{"$ref":"#/components/schemas/ActivationKey"},"AgentName":{"$ref":"#/components/schemas/TagValue"},"Tags":{"$ref":"#/components/schemas/TagList"}},"description":"CreateAgentRequest"},"CreateLocationEfsResponse":{"type":"object","properties":{"LocationArn":{"$ref":"#/components/schemas/LocationArn"}},"description":"CreateLocationEfs"},"CreateLocationEfsRequest":{"type":"object","required":["Subdirectory","EfsFilesystemArn","Ec2Config"],"properties":{"Subdirectory":{"$ref":"#/components/schemas/Subdirectory"},"EfsFilesystemArn":{"$ref":"#/components/schemas/EfsFilesystemArn"},"Ec2Config":{"$ref":"#/components/schemas/Ec2Config"},"Tags":{"$ref":"#/components/schemas/TagList"}},"description":"CreateLocationEfsRequest"},"CreateLocationNfsResponse":{"type":"object","properties":{"LocationArn":{"$ref":"#/components/schemas/LocationArn"}},"description":"CreateLocationNfsResponse"},"CreateLocationNfsRequest":{"type":"object","required":["Subdirectory","ServerHostname","OnPremConfig"],"properties":{"Subdirectory":{"$ref":"#/components/schemas/Subdirectory"},"ServerHostname":{"$ref":"#/components/schemas/ServerHostname"},"OnPremConfig":{"$ref":"#/components/schemas/OnPremConfig"},"Tags":{"$ref":"#/components/schemas/TagList"}},"description":"CreateLocationNfsRequest"},"CreateLocationS3Response":{"type":"object","properties":{"LocationArn":{"$ref":"#/components/schemas/LocationArn"}},"description":"CreateLocationS3Response"},"CreateLocationS3Request":{"type":"object","required":["Subdirectory","S3BucketArn","S3Config"],"properties":{"Subdirectory":{"$ref":"#/components/schemas/Subdirectory"},"S3BucketArn":{"$ref":"#/components/schemas/S3BucketArn"},"S3Config":{"$ref":"#/components/schemas/S3Config"},"Tags":{"$ref":"#/components/schemas/TagList"}},"description":"CreateLocationS3Request"},"CreateTaskResponse":{"type":"object","properties":{"TaskArn":{"$ref":"#/components/schemas/TaskArn"}},"description":"CreateTaskResponse"},"CreateTaskRequest":{"type":"object","required":["SourceLocationArn","DestinationLocationArn"],"properties":{"SourceLocationArn":{"$ref":"#/components/schemas/LocationArn"},"DestinationLocationArn":{"$ref":"#/components/schemas/LocationArn"},"CloudWatchLogGroupArn":{"$ref":"#/components/schemas/LogGroupArn"},"Name":{"$ref":"#/components/schemas/TagValue"},"Options":{"$ref":"#/components/schemas/Options"},"Tags":{"$ref":"#/components/schemas/TagList"}},"description":"CreateTaskRequest"},"DeleteAgentResponse":{"type":"object","properties":{}},"DeleteAgentRequest":{"type":"object","required":["AgentArn"],"properties":{"AgentArn":{"$ref":"#/components/schemas/AgentArn"}},"description":"DeleteAgentRequest"},"DeleteLocationResponse":{"type":"object","properties":{}},"DeleteLocationRequest":{"type":"object","required":["LocationArn"],"properties":{"LocationArn":{"$ref":"#/components/schemas/LocationArn"}},"description":"DeleteLocation"},"DeleteTaskResponse":{"type":"object","properties":{}},"DeleteTaskRequest":{"type":"object","required":["TaskArn"],"properties":{"TaskArn":{"$ref":"#/components/schemas/TaskArn"}},"description":"DeleteTask"},"DescribeAgentResponse":{"type":"object","properties":{"AgentArn":{"$ref":"#/components/schemas/AgentArn"},"Name":{"$ref":"#/components/schemas/TagValue"},"Status":{"$ref":"#/components/schemas/AgentStatus"},"LastConnectionTime":{"$ref":"#/components/schemas/Time"},"CreationTime":{"$ref":"#/components/schemas/Time"}},"description":"DescribeAgentResponse"},"DescribeAgentRequest":{"type":"object","required":["AgentArn"],"properties":{"AgentArn":{"$ref":"#/components/schemas/AgentArn"}},"description":"DescribeAgent"},"DescribeLocationEfsResponse":{"type":"object","properties":{"LocationArn":{"$ref":"#/components/schemas/LocationArn"},"LocationUri":{"$ref":"#/components/schemas/LocationUri"},"Ec2Config":{"$ref":"#/components/schemas/Ec2Config"},"CreationTime":{"$ref":"#/components/schemas/Time"}},"description":"DescribeLocationEfsResponse"},"DescribeLocationEfsRequest":{"type":"object","required":["LocationArn"],"properties":{"LocationArn":{"$ref":"#/components/schemas/LocationArn"}},"description":"DescribeLocationEfsRequest"},"DescribeLocationNfsResponse":{"type":"object","properties":{"LocationArn":{"$ref":"#/components/schemas/LocationArn"},"LocationUri":{"$ref":"#/components/schemas/LocationUri"},"OnPremConfig":{"$ref":"#/components/schemas/OnPremConfig"},"CreationTime":{"$ref":"#/components/schemas/Time"}},"description":"DescribeLocationNfsResponse"},"DescribeLocationNfsRequest":{"type":"object","required":["LocationArn"],"properties":{"LocationArn":{"$ref":"#/components/schemas/LocationArn"}},"description":"DescribeLocationNfsRequest"},"DescribeLocationS3Response":{"type":"object","properties":{"LocationArn":{"$ref":"#/components/schemas/LocationArn"},"LocationUri":{"$ref":"#/components/schemas/LocationUri"},"S3Config":{"$ref":"#/components/schemas/S3Config"},"CreationTime":{"$ref":"#/components/schemas/Time"}},"description":"DescribeLocationS3Response"},"DescribeLocationS3Request":{"type":"object","required":["LocationArn"],"properties":{"LocationArn":{"$ref":"#/components/schemas/LocationArn"}},"description":"DescribeLocationS3Request"},"DescribeTaskResponse":{"type":"object","properties":{"TaskArn":{"$ref":"#/components/schemas/TaskArn"},"Status":{"$ref":"#/components/schemas/TaskStatus"},"Name":{"$ref":"#/components/schemas/TagValue"},"CurrentTaskExecutionArn":{"$ref":"#/components/schemas/TaskExecutionArn"},"SourceLocationArn":{"$ref":"#/components/schemas/LocationArn"},"DestinationLocationArn":{"$ref":"#/components/schemas/LocationArn"},"CloudWatchLogGroupArn":{"$ref":"#/components/schemas/LogGroupArn"},"Options":{"$ref":"#/components/schemas/Options"},"ErrorCode":{"$ref":"#/components/schemas/string"},"ErrorDetail":{"$ref":"#/components/schemas/string"},"CreationTime":{"$ref":"#/components/schemas/Time"}},"description":"DescribeTaskResponse"},"DescribeTaskRequest":{"type":"object","required":["TaskArn"],"properties":{"TaskArn":{"$ref":"#/components/schemas/TaskArn"}},"description":"DescribeTaskRequest"},"DescribeTaskExecutionResponse":{"type":"object","properties":{"TaskExecutionArn":{"$ref":"#/components/schemas/TaskExecutionArn"},"Status":{"$ref":"#/components/schemas/TaskExecutionStatus"},"Options":{"$ref":"#/components/schemas/Options"},"StartTime":{"$ref":"#/components/schemas/Time"},"EstimatedFilesToTransfer":{"$ref":"#/components/schemas/long"},"EstimatedBytesToTransfer":{"$ref":"#/components/schemas/long"},"FilesTransferred":{"$ref":"#/components/schemas/long"},"BytesWritten":{"$ref":"#/components/schemas/long"},"BytesTransferred":{"$ref":"#/components/schemas/long"},"Result":{"$ref":"#/components/schemas/TaskExecutionResultDetail"}},"description":"DescribeTaskExecutionResponse"},"DescribeTaskExecutionRequest":{"type":"object","required":["TaskExecutionArn"],"properties":{"TaskExecutionArn":{"$ref":"#/components/schemas/TaskExecutionArn"}},"description":"DescribeTaskExecutionRequest"},"ListAgentsResponse":{"type":"object","properties":{"Agents":{"$ref":"#/components/schemas/AgentList"},"NextToken":{"$ref":"#/components/schemas/NextToken"}},"description":"ListAgentsResponse"},"ListAgentsRequest":{"type":"object","properties":{"MaxResults":{"$ref":"#/components/schemas/MaxResults"},"NextToken":{"$ref":"#/components/schemas/NextToken"}},"description":"ListAgentsRequest"},"ListLocationsResponse":{"type":"object","properties":{"Locations":{"$ref":"#/components/schemas/LocationList"},"NextToken":{"$ref":"#/components/schemas/NextToken"}},"description":"ListLocationsResponse"},"ListLocationsRequest":{"type":"object","properties":{"MaxResults":{"$ref":"#/components/schemas/MaxResults"},"NextToken":{"$ref":"#/components/schemas/NextToken"}},"description":"ListLocationsRequest"},"ListTagsForResourceResponse":{"type":"object","properties":{"Tags":{"$ref":"#/components/schemas/TagList"},"NextToken":{"$ref":"#/components/schemas/NextToken"}},"description":"ListTagsForResourceResponse"},"ListTagsForResourceRequest":{"type":"object","required":["ResourceArn"],"properties":{"ResourceArn":{"$ref":"#/components/schemas/TaggableResourceArn"},"MaxResults":{"$ref":"#/components/schemas/MaxResults"},"NextToken":{"$ref":"#/components/schemas/NextToken"}},"description":"ListTagsForResourceRequest"},"ListTaskExecutionsResponse":{"type":"object","properties":{"TaskExecutions":{"$ref":"#/components/schemas/TaskExecutionList"},"NextToken":{"$ref":"#/components/schemas/NextToken"}},"description":"ListTaskExecutionsResponse"},"ListTaskExecutionsRequest":{"type":"object","properties":{"TaskArn":{"$ref":"#/components/schemas/TaskArn"},"MaxResults":{"$ref":"#/components/schemas/MaxResults"},"NextToken":{"$ref":"#/components/schemas/NextToken"}},"description":"ListTaskExecutions"},"ListTasksResponse":{"type":"object","properties":{"Tasks":{"$ref":"#/components/schemas/TaskList"},"NextToken":{"$ref":"#/components/schemas/NextToken"}},"description":"ListTasksResponse"},"ListTasksRequest":{"type":"object","properties":{"MaxResults":{"$ref":"#/components/schemas/MaxResults"},"NextToken":{"$ref":"#/components/schemas/NextToken"}},"description":"ListTasksRequest"},"StartTaskExecutionResponse":{"type":"object","properties":{"TaskExecutionArn":{"$ref":"#/components/schemas/TaskExecutionArn"}},"description":"StartTaskExecutionResponse"},"StartTaskExecutionRequest":{"type":"object","required":["TaskArn"],"properties":{"TaskArn":{"$ref":"#/components/schemas/TaskArn"},"OverrideOptions":{"$ref":"#/components/schemas/Options"}},"description":"StartTaskExecutionRequest"},"TagResourceResponse":{"type":"object","properties":{}},"TagResourceRequest":{"type":"object","required":["ResourceArn","Tags"],"properties":{"ResourceArn":{"$ref":"#/components/schemas/TaggableResourceArn"},"Tags":{"$ref":"#/components/schemas/TagList"}},"description":"TagResourceRequest"},"UntagResourceResponse":{"type":"object","properties":{}},"UntagResourceRequest":{"type":"object","required":["ResourceArn","Keys"],"properties":{"ResourceArn":{"$ref":"#/components/schemas/TaggableResourceArn"},"Keys":{"$ref":"#/components/schemas/TagKeyList"}},"description":"UntagResourceRequest"},"UpdateAgentResponse":{"type":"object","properties":{}},"UpdateAgentRequest":{"type":"object","required":["AgentArn"],"properties":{"AgentArn":{"$ref":"#/components/schemas/AgentArn"},"Name":{"$ref":"#/components/schemas/TagValue"}},"description":"UpdateAgentRequest"},"UpdateTaskResponse":{"type":"object","properties":{}},"UpdateTaskRequest":{"type":"object","required":["TaskArn"],"properties":{"TaskArn":{"$ref":"#/components/schemas/TaskArn"},"Options":{"$ref":"#/components/schemas/Options"},"Name":{"$ref":"#/components/schemas/TagValue"}},"description":"UpdateTaskResponse"},"ActivationKey":{"type":"string","pattern":"[A-Z0-9]{5}(-[A-Z0-9]{5}){4}","maxLength":29},"AgentArn":{"type":"string","pattern":"^arn:(aws|aws-cn):datasync:[a-z\\-0-9]+:[0-9]{12}:agent/agent-[0-9a-z]{17}$","maxLength":128},"AgentArnList":{"type":"array","items":{"$ref":"#/components/schemas/AgentArn"},"minItems":1,"maxItems":64},"AgentListEntry":{"type":"object","properties":{"AgentArn":{"$ref":"#/components/schemas/AgentArn"},"Name":{"$ref":"#/components/schemas/TagValue"},"Status":{"$ref":"#/components/schemas/AgentStatus"}},"description":"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."},"AgentList":{"type":"array","items":{"$ref":"#/components/schemas/AgentListEntry"}},"TagValue":{"type":"string","pattern":"^[a-zA-Z0-9\\s+=._:/-]{1,256}$","minLength":1,"maxLength":256},"AgentStatus":{"type":"string","enum":["ONLINE","OFFLINE"]},"Atime":{"type":"string","enum":["NONE","BEST_EFFORT"]},"BytesPerSecond":{"type":"integer","minimum":-1},"TaskExecutionArn":{"type":"string","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}$","maxLength":128},"TagList":{"type":"array","items":{"$ref":"#/components/schemas/TagListEntry"},"minItems":0,"maxItems":55},"Subdirectory":{"type":"string","pattern":"^[a-zA-Z0-9_\\-\\./]+$","maxLength":4096},"EfsFilesystemArn":{"type":"string","pattern":"^arn:(aws|aws-cn):elasticfilesystem:[a-z\\-0-9]*:[0-9]{12}:file-system/fs-.*$","maxLength":128},"Ec2Config":{"type":"object","required":["SubnetArn","SecurityGroupArns"],"properties":{"SubnetArn":{"$ref":"#/components/schemas/Ec2SubnetArn"},"SecurityGroupArns":{"$ref":"#/components/schemas/Ec2SecurityGroupArnList"}},"description":"<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>"},"LocationArn":{"type":"string","pattern":"^arn:(aws|aws-cn):datasync:[a-z\\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$","maxLength":128},"ServerHostname":{"type":"string","pattern":"^(([a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9\\-]*[A-Za-z0-9])$","maxLength":255},"OnPremConfig":{"type":"object","required":["AgentArns"],"properties":{"AgentArns":{"$ref":"#/components/schemas/AgentArnList"}},"description":"A list of Amazon Resource Names (ARNs) of agents to use for a Network File System (NFS) location."},"S3BucketArn":{"type":"string","pattern":"^arn:(aws|aws-cn):s3:::([^/]*)$","maxLength":76},"S3Config":{"type":"object","required":["BucketAccessRoleArn"],"properties":{"BucketAccessRoleArn":{"$ref":"#/components/schemas/IamRoleArn"}},"description":"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>."},"LogGroupArn":{"type":"string","pattern":"^arn:(aws|aws-cn):logs:[a-z\\-0-9]*:[0-9]{12}:log-group:([^:\\*]*)$","maxLength"