/AWS1/IF_CGS=>UNSUBSCRIBEFROMDATASET()¶
About UnsubscribeFromDataset¶
Unsubscribes from receiving notifications when a dataset is modified by another device.
This API can only be called with temporary credentials provided by Cognito Identity. You cannot call this API with developer credentials.
{
"Operation": "com.amazonaws.cognito.sync.model#UnsubscribeFromDataset",
"Service": "com.amazonaws.cognito.sync.model#AWSCognitoSyncService",
"Input":
{
"IdentityPoolId": "ID_POOL_ID",
"IdentityId": "IDENTITY_ID",
"DatasetName": "Rufus",
"DeviceId": "5cd28fbe-dd83-47ab-9f83-19093a5fb014"
}
}
{ "Output": { "__type": "com.amazonaws.cognito.sync.model#UnsubscribeFromDatasetResponse" }, "Version": "1.0" }
Method Signature¶
METHODS /AWS1/IF_CGS~UNSUBSCRIBEFROMDATASET
IMPORTING
!IV_IDENTITYPOOLID TYPE /AWS1/CGSIDENTITYPOOLID OPTIONAL
!IV_IDENTITYID TYPE /AWS1/CGSIDENTITYID OPTIONAL
!IV_DATASETNAME TYPE /AWS1/CGSDATASETNAME OPTIONAL
!IV_DEVICEID TYPE /AWS1/CGSDEVICEID OPTIONAL
RETURNING
VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_cgsunsubfromdsrsp
RAISING
/AWS1/CX_CGSINTERNALERROREX
/AWS1/CX_CGSINVALIDCONFEX
/AWS1/CX_CGSINVALIDPARAMETEREX
/AWS1/CX_CGSNOTAUTHORIZEDEX
/AWS1/CX_CGSRESOURCENOTFOUNDEX
/AWS1/CX_CGSTOOMANYREQUESTSEX
/AWS1/CX_CGSCLIENTEXC
/AWS1/CX_CGSSERVEREXC
/AWS1/CX_RT_TECHNICAL_GENERIC
/AWS1/CX_RT_SERVICE_GENERIC.
IMPORTING¶
Required arguments:¶
iv_identitypoolid TYPE /AWS1/CGSIDENTITYPOOLID /AWS1/CGSIDENTITYPOOLID¶
A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. The ID of the pool to which this identity belongs.
iv_identityid TYPE /AWS1/CGSIDENTITYID /AWS1/CGSIDENTITYID¶
Unique ID for this identity.
iv_datasetname TYPE /AWS1/CGSDATASETNAME /AWS1/CGSDATASETNAME¶
The name of the dataset from which to unsubcribe.
iv_deviceid TYPE /AWS1/CGSDEVICEID /AWS1/CGSDEVICEID¶
The unique ID generated for this device by Cognito.
RETURNING¶
oo_output TYPE REF TO /aws1/cl_cgsunsubfromdsrsp /AWS1/CL_CGSUNSUBFROMDSRSP¶
Domain /AWS1/RT_ACCOUNT_ID Primitive Type NUMC
Examples¶
Syntax Example¶
This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.
DATA(lo_result) = lo_client->unsubscribefromdataset(
iv_datasetname = |string|
iv_deviceid = |string|
iv_identityid = |string|
iv_identitypoolid = |string|
).
This is an example of reading all possible response values
lo_result = lo_result.
IF lo_result IS NOT INITIAL.
ENDIF.