Skip to content

/AWS1/CL_CGS=>SETIDENTITYPOOLCONFIGURATION()

About SetIdentityPoolConfiguration

Sets the necessary configuration for push sync.

This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.

SetIdentityPoolConfiguration The following examples have been edited for readability. POST / HTTP/1.1 CONTENT-TYPE: application/json X-AMZN-REQUESTID: a46db021-f5dd-45d6-af5b-7069fa4a211b X-AMZ-TARGET: com.amazonaws.cognito.sync.model.AWSCognitoSyncService.SetIdentityPoolConfiguration HOST: cognito-sync.us-east-1.amazonaws.com X-AMZ-DATE: 20141004T200006Z AUTHORIZATION: AWS4-HMAC-SHA256 Credential=, SignedHeaders=content-type;content-length;host;x-amz-date;x-amz-target, Signature=

{ "Operation": "com.amazonaws.cognito.sync.model#SetIdentityPoolConfiguration", "Service": "com.amazonaws.cognito.sync.model#AWSCognitoSyncService", "Input": { "IdentityPoolId": "ID_POOL_ID", "PushSync": { "ApplicationArns": ["PLATFORMARN1", "PLATFORMARN2"], "RoleArn": "ROLEARN" } } } 1.1 200 OK x-amzn-requestid: a46db021-f5dd-45d6-af5b-7069fa4a211b date: Sat, 04 Oct 2014 20:00:06 GMT content-type: application/json content-length: 332

{ "Output": { "__type": "com.amazonaws.cognito.sync.model#SetIdentityPoolConfigurationResponse", "IdentityPoolId": "ID_POOL_ID", "PushSync": { "ApplicationArns": ["PLATFORMARN1", "PLATFORMARN2"], "RoleArn": "ROLEARN" } }, "Version": "1.0" }

Method Signature

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. This is the ID of the pool to modify.

Optional arguments:

io_pushsync TYPE REF TO /AWS1/CL_CGSPUSHSYNC /AWS1/CL_CGSPUSHSYNC

Options to apply to this identity pool for push synchronization.

io_cognitostreams TYPE REF TO /AWS1/CL_CGSCOGNITOSTREAMS /AWS1/CL_CGSCOGNITOSTREAMS

Options to apply to this identity pool for Amazon Cognito streams.

RETURNING

oo_output TYPE REF TO /aws1/cl_cgssetidpoolconfrsp /AWS1/CL_CGSSETIDPOOLCONFRSP

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->/aws1/if_cgs~setidentitypoolconfiguration(
  io_cognitostreams = new /aws1/cl_cgscognitostreams(
    iv_rolearn = |string|
    iv_streamingstatus = |string|
    iv_streamname = |string|
  )
  io_pushsync = new /aws1/cl_cgspushsync(
    it_applicationarns = VALUE /aws1/cl_cgsapplicationarnls00=>tt_applicationarnlist(
      ( new /aws1/cl_cgsapplicationarnls00( |string| ) )
    )
    iv_rolearn = |string|
  )
  iv_identitypoolid = |string|
).

This is an example of reading all possible response values

lv_identitypoolid = lo_result->get_identitypoolid( ).
LOOP AT lo_pushsync->get_applicationarns( ) into lo_row.
  lv_applicationarn = lo_row_1->get_value( ).
ENDLOOP.
lv_assumerolearn = lo_pushsync->get_rolearn( ).
lv_streamname = lo_cognitostreams->get_streamname( ).
lv_assumerolearn = lo_cognitostreams->get_rolearn( ).
lv_streamingstatus = lo_cognitostreams->get_streamingstatus( ).