Get Details of a Cloud Staging Area | RESTful API | Teradata Data Mover - Get Cloud Staging Area (RESTful API) - Teradata Data Mover

Teradata® Data Mover User Guide
Product
Teradata Data Mover
Release Number
17.20
Published
September 2022
Language
English (United States)
Last Update
2022-09-26
dita:mapPath
tsn1650877444606.ditamap
dita:ditavalPath
mpm1591127278842.ditaval
dita:id
B035-4101
lifecycle
previous
Product Category
Analytical Ecosystem

Overview

Retrieve the details of an existing cloud staging area using the following URL and method:
Item Description
URL /datamover/cloud-staging-areas/staging_area_name
Method GET

Request Parameters

No request parameters required.

Response Parameters

name
Description: Name of the cloud staging area
JSON Data Type: String
Required: Yes
storage_type
Description: Specify cloud storage type. Currently only S3 is supported
JSON Data Type: String
Required: Yes
s3_properties
Description: AWS S3 information used to create the cloud staging area
JSON Data Type: Object (S3Properties)
Required: No
source_target_pairs
Description: Source and target system information
JSON Data Type: JSON Array (SourceTargetPair)
Required: Yes
messages
Description: Contains error and warning messages
JSON Data Type: Object (Messages)