Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

CreateDataSetImportTask

Starts a data set import task for a specific application.

Request Syntax


POST /applications/applicationId/dataset-import-task HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "importConfig": { ... }
}

URI Request Parameters

The request uses the following URI parameters.

applicationId

The unique identifier of the application for which you want to import data sets.

Pattern: \S{1,80}

Required: Yes

Request Body

The request accepts the following data in JSON format.

clientToken

Unique, case-sensitive identifier you provide to ensure the idempotency of the request to create a data set import. The service generates the clientToken when the API call is triggered. The token expires after one hour, so if you retry the API within this timeframe with the same clientToken, you will get the same response. The service also handles deleting the clientToken after it expires.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 128.

Pattern: [!-~]+

Required: No

importConfig

The data set import task configuration.

Type: DataSetImportConfig object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "taskId": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

taskId

The task identifier. This operation is asynchronous. Use this identifier with the GetDataSetImportTask operation to obtain the status of this task.

Type: String

Pattern: \S{1,80}

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

The account or role doesn't have the right permissions to make the request.

HTTP Status Code: 403

ConflictException

The parameters provided in the request conflict with existing resources.

resourceId: The ID of the conflicting resource.
resourceType: The type of the conflicting resource.

HTTP Status Code: 409

InternalServerException

An unexpected error occurred during the processing of the request.

retryAfterSeconds: The number of seconds to wait before retrying the request.

HTTP Status Code: 500

ResourceNotFoundException

The specified resource was not found.

resourceId: The ID of the missing resource.
resourceType: The type of the missing resource.

HTTP Status Code: 404

ServiceQuotaExceededException

One or more quotas for AWS Mainframe Modernization exceeds the limit.

quotaCode: The identifier of the exceeded quota.
resourceId: The ID of the resource that is exceeding the quota limit.
resourceType: The type of resource that is exceeding the quota limit for AWS Mainframe Modernization.
serviceCode: A code that identifies the service that the exceeded quota belongs to.

HTTP Status Code: 402

ThrottlingException

The number of requests made exceeds the limit.

quotaCode: The identifier of the throttled request.
retryAfterSeconds: The number of seconds to wait before retrying the request.
serviceCode: The identifier of the service that the throttled request was made to.

HTTP Status Code: 429

ValidationException

One or more parameters provided in the request is not valid.

fieldList: The list of fields that failed service validation.
reason: The reason why it failed service validation.

HTTP Status Code: 400