DataMapperApi.md 2.8 KB

DataMapperApi

All URIs are relative to https://your-apigw-id.execute-api.region.amazonaws.com/Prod

Method HTTP request Description
DeleteDataMapper DELETE /v1/data_mappers/{data_mapper_id} Removes a data mapper
GetDataMapper GET /v1/data_mappers/{data_mapper_id} Returns the details of a data mapper
ListDataMappers GET /v1/data_mappers Lists data mappers
PutDataMapper PUT /v1/data_mappers/{data_mapper_id} Creates or modifies a data mapper

DeleteDataMapper

Removes a data mapper

Parameters

Name Type Description Notes
DataMapperId String Data Mapper ID path parameter [default to null]

Return type

null (empty response body)

Authorization

Authorizer

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

GetDataMapper

Returns the details of a data mapper

Parameters

Name Type Description Notes
DataMapperId String Data Mapper ID path parameter [default to null]

Return type

DataMapper

Authorization

Authorizer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

ListDataMappers

Lists data mappers

Parameters

Name Type Description Notes
StartAt String Start at watermark query string parameter [optional] [default to 0]
PageSize Integer Page size query string parameter. Min: 1. Max: 1000 [optional] [default to null]

Return type

ListOfDataMappers

Authorization

Authorizer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

PutDataMapper

Creates or modifies a data mapper

Parameters

Name Type Description Notes
DataMapperId String Data Mapper ID path parameter [default to null]
DataMapper DataMapper Request body containing details of the Data Mapper to create or modify

Return type

DataMapper

Authorization

Authorizer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json