github.com/aavshr/aws-sdk-go@v1.41.3/models/apis/chime-sdk-identity/2021-04-20/docs-2.json (about)

     1  {
     2    "version": "2.0",
     3    "service": "<p>The Amazon Chime SDK Identity APIs in this section allow software developers to create and manage unique instances of their messaging applications. These APIs provide the overarching framework for creating and sending messages. For more information about the identity APIs, refer to <a href=\"https://docs.aws.amazon.com/chime/latest/APIReference/API_Operations_Amazon_Chime_SDK_Identity.html\">Amazon Chime SDK identity</a>.</p>",
     4    "operations": {
     5      "CreateAppInstance": "<p>Creates an Amazon Chime SDK messaging <code>AppInstance</code> under an AWS account. Only SDK messaging customers use this API. <code>CreateAppInstance</code> supports idempotency behavior as described in the AWS API Standard.</p> <p>identity</p>",
     6      "CreateAppInstanceAdmin": "<p>Promotes an <code>AppInstanceUser</code> to an <code>AppInstanceAdmin</code>. The promoted user can perform the following actions. </p> <ul> <li> <p> <code>ChannelModerator</code> actions across all channels in the <code>AppInstance</code>.</p> </li> <li> <p> <code>DeleteChannelMessage</code> actions.</p> </li> </ul> <p>Only an <code>AppInstanceUser</code> can be promoted to an <code>AppInstanceAdmin</code> role.</p>",
     7      "CreateAppInstanceUser": "<p>Creates a user under an Amazon Chime <code>AppInstance</code>. The request consists of a unique <code>appInstanceUserId</code> and <code>Name</code> for that user.</p>",
     8      "DeleteAppInstance": "<p>Deletes an <code>AppInstance</code> and all associated data asynchronously.</p>",
     9      "DeleteAppInstanceAdmin": "<p>Demotes an <code>AppInstanceAdmin</code> to an <code>AppInstanceUser</code>. This action does not delete the user.</p>",
    10      "DeleteAppInstanceUser": "<p>Deletes an <code>AppInstanceUser</code>.</p>",
    11      "DescribeAppInstance": "<p>Returns the full details of an <code>AppInstance</code>.</p>",
    12      "DescribeAppInstanceAdmin": "<p>Returns the full details of an <code>AppInstanceAdmin</code>.</p>",
    13      "DescribeAppInstanceUser": "<p>Returns the full details of an <code>AppInstanceUser</code>.</p>",
    14      "GetAppInstanceRetentionSettings": "<p>Gets the retention settings for an <code>AppInstance</code>.</p>",
    15      "ListAppInstanceAdmins": "<p>Returns a list of the administrators in the <code>AppInstance</code>.</p>",
    16      "ListAppInstanceUsers": "<p>List all <code>AppInstanceUsers</code> created under a single <code>AppInstance</code>.</p>",
    17      "ListAppInstances": "<p>Lists all Amazon Chime <code>AppInstance</code>s created under a single AWS account.</p>",
    18      "PutAppInstanceRetentionSettings": "<p>Sets the amount of time in days that a given <code>AppInstance</code> retains data.</p>",
    19      "UpdateAppInstance": "<p>Updates <code>AppInstance</code> metadata.</p>",
    20      "UpdateAppInstanceUser": "<p>Updates the details of an <code>AppInstanceUser</code>. You can update names and metadata.</p>"
    21    },
    22    "shapes": {
    23      "AppInstance": {
    24        "base": "<p>The details of an <code>AppInstance</code>, an instance of an Amazon Chime SDK messaging application.</p>",
    25        "refs": {
    26          "DescribeAppInstanceResponse$AppInstance": "<p>The ARN, metadata, created and last-updated timestamps, and the name of the <code>AppInstance</code>. All timestamps use epoch milliseconds.</p>"
    27        }
    28      },
    29      "AppInstanceAdmin": {
    30        "base": "<p>The details of an <code>AppInstanceAdmin</code>.</p>",
    31        "refs": {
    32          "DescribeAppInstanceAdminResponse$AppInstanceAdmin": "<p>The ARN and name of the <code>AppInstanceUser</code>, the ARN of the <code>AppInstance</code>, and the created and last-updated timestamps. All timestamps use epoch milliseconds.</p>"
    33        }
    34      },
    35      "AppInstanceAdminList": {
    36        "base": null,
    37        "refs": {
    38          "ListAppInstanceAdminsResponse$AppInstanceAdmins": "<p>The information for each administrator.</p>"
    39        }
    40      },
    41      "AppInstanceAdminSummary": {
    42        "base": "<p>Summary of the details of an <code>AppInstanceAdmin</code>.</p>",
    43        "refs": {
    44          "AppInstanceAdminList$member": null
    45        }
    46      },
    47      "AppInstanceList": {
    48        "base": null,
    49        "refs": {
    50          "ListAppInstancesResponse$AppInstances": "<p>The information for each <code>AppInstance</code>.</p>"
    51        }
    52      },
    53      "AppInstanceRetentionSettings": {
    54        "base": "<p>The details of the data-retention settings for an <code>AppInstance</code>.</p>",
    55        "refs": {
    56          "GetAppInstanceRetentionSettingsResponse$AppInstanceRetentionSettings": "<p>The retention settings for the <code>AppInstance</code>.</p>",
    57          "PutAppInstanceRetentionSettingsRequest$AppInstanceRetentionSettings": "<p>The time in days to retain data. Data type: number.</p>",
    58          "PutAppInstanceRetentionSettingsResponse$AppInstanceRetentionSettings": "<p>The time in days to retain data. Data type: number.</p>"
    59        }
    60      },
    61      "AppInstanceSummary": {
    62        "base": "<p>Summary of the data for an <code>AppInstance</code>.</p>",
    63        "refs": {
    64          "AppInstanceList$member": null
    65        }
    66      },
    67      "AppInstanceUser": {
    68        "base": "<p>The details of an <code>AppInstanceUser</code>.</p>",
    69        "refs": {
    70          "DescribeAppInstanceUserResponse$AppInstanceUser": "<p>The name of the <code>AppInstanceUser</code>.</p>"
    71        }
    72      },
    73      "AppInstanceUserList": {
    74        "base": null,
    75        "refs": {
    76          "ListAppInstanceUsersResponse$AppInstanceUsers": "<p>The information for each requested <code>AppInstanceUser</code>.</p>"
    77        }
    78      },
    79      "AppInstanceUserSummary": {
    80        "base": "<p>Summary of the details of an <code>AppInstanceUser</code>.</p>",
    81        "refs": {
    82          "AppInstanceUserList$member": null
    83        }
    84      },
    85      "BadRequestException": {
    86        "base": "<p>The input parameters don't match the service's restrictions.</p>",
    87        "refs": {
    88        }
    89      },
    90      "ChannelRetentionSettings": {
    91        "base": "<p>The details of the retention settings for a channel.</p>",
    92        "refs": {
    93          "AppInstanceRetentionSettings$ChannelRetentionSettings": "<p>The length of time in days to retain the messages in a channel.</p>"
    94        }
    95      },
    96      "ChimeArn": {
    97        "base": null,
    98        "refs": {
    99          "AppInstance$AppInstanceArn": "<p>The ARN of the messaging instance.</p>",
   100          "AppInstanceAdmin$AppInstanceArn": "<p>The ARN of the <code>AppInstance</code> for which the user is an administrator.</p>",
   101          "AppInstanceSummary$AppInstanceArn": "<p>The <code>AppInstance</code> ARN.</p>",
   102          "AppInstanceUser$AppInstanceUserArn": "<p>The ARN of the <code>AppInstanceUser</code>.</p>",
   103          "AppInstanceUserSummary$AppInstanceUserArn": "<p>The ARN of the <code>AppInstanceUser</code>.</p>",
   104          "CreateAppInstanceAdminRequest$AppInstanceAdminArn": "<p>The ARN of the administrator of the current <code>AppInstance</code>.</p>",
   105          "CreateAppInstanceAdminRequest$AppInstanceArn": "<p>The ARN of the <code>AppInstance</code>.</p>",
   106          "CreateAppInstanceAdminResponse$AppInstanceArn": "<p>The ARN of the of the admin for the <code>AppInstance</code>.</p>",
   107          "CreateAppInstanceResponse$AppInstanceArn": "<p>The Amazon Resource Number (ARN) of the <code>AppInstance</code>.</p>",
   108          "CreateAppInstanceUserRequest$AppInstanceArn": "<p>The ARN of the <code>AppInstance</code> request.</p>",
   109          "CreateAppInstanceUserResponse$AppInstanceUserArn": "<p>The user's ARN.</p>",
   110          "DeleteAppInstanceAdminRequest$AppInstanceAdminArn": "<p>The ARN of the <code>AppInstance</code>'s administrator.</p>",
   111          "DeleteAppInstanceAdminRequest$AppInstanceArn": "<p>The ARN of the <code>AppInstance</code>.</p>",
   112          "DeleteAppInstanceRequest$AppInstanceArn": "<p>The ARN of the <code>AppInstance</code>.</p>",
   113          "DeleteAppInstanceUserRequest$AppInstanceUserArn": "<p>The ARN of the user request being deleted.</p>",
   114          "DescribeAppInstanceAdminRequest$AppInstanceAdminArn": "<p>The ARN of the <code>AppInstanceAdmin</code>.</p>",
   115          "DescribeAppInstanceAdminRequest$AppInstanceArn": "<p>The ARN of the <code>AppInstance</code>.</p>",
   116          "DescribeAppInstanceRequest$AppInstanceArn": "<p>The ARN of the <code>AppInstance</code>.</p>",
   117          "DescribeAppInstanceUserRequest$AppInstanceUserArn": "<p>The ARN of the <code>AppInstanceUser</code>.</p>",
   118          "GetAppInstanceRetentionSettingsRequest$AppInstanceArn": "<p>The ARN of the <code>AppInstance</code>.</p>",
   119          "Identity$Arn": "<p>The ARN in an Identity.</p>",
   120          "ListAppInstanceAdminsRequest$AppInstanceArn": "<p>The ARN of the <code>AppInstance</code>.</p>",
   121          "ListAppInstanceAdminsResponse$AppInstanceArn": "<p>The ARN of the <code>AppInstance</code>.</p>",
   122          "ListAppInstanceUsersRequest$AppInstanceArn": "<p>The ARN of the <code>AppInstance</code>.</p>",
   123          "ListAppInstanceUsersResponse$AppInstanceArn": "<p>The ARN of the <code>AppInstance</code>.</p>",
   124          "PutAppInstanceRetentionSettingsRequest$AppInstanceArn": "<p>The ARN of the <code>AppInstance</code>.</p>",
   125          "UpdateAppInstanceRequest$AppInstanceArn": "<p>The ARN of the <code>AppInstance</code>.</p>",
   126          "UpdateAppInstanceResponse$AppInstanceArn": "<p>The ARN of the <code>AppInstance</code>.</p>",
   127          "UpdateAppInstanceUserRequest$AppInstanceUserArn": "<p>The ARN of the <code>AppInstanceUser</code>.</p>",
   128          "UpdateAppInstanceUserResponse$AppInstanceUserArn": "<p>The ARN of the <code>AppInstanceUser</code>.</p>"
   129        }
   130      },
   131      "ClientRequestToken": {
   132        "base": null,
   133        "refs": {
   134          "CreateAppInstanceRequest$ClientRequestToken": "<p>The <code>ClientRequestToken</code> of the <code>AppInstance</code>.</p>",
   135          "CreateAppInstanceUserRequest$ClientRequestToken": "<p>The token assigned to the user requesting an <code>AppInstance</code>.</p>"
   136        }
   137      },
   138      "ConflictException": {
   139        "base": "<p>The request could not be processed because of conflict in the current state of the resource.</p>",
   140        "refs": {
   141        }
   142      },
   143      "CreateAppInstanceAdminRequest": {
   144        "base": null,
   145        "refs": {
   146        }
   147      },
   148      "CreateAppInstanceAdminResponse": {
   149        "base": null,
   150        "refs": {
   151        }
   152      },
   153      "CreateAppInstanceRequest": {
   154        "base": null,
   155        "refs": {
   156        }
   157      },
   158      "CreateAppInstanceResponse": {
   159        "base": null,
   160        "refs": {
   161        }
   162      },
   163      "CreateAppInstanceUserRequest": {
   164        "base": null,
   165        "refs": {
   166        }
   167      },
   168      "CreateAppInstanceUserResponse": {
   169        "base": null,
   170        "refs": {
   171        }
   172      },
   173      "DeleteAppInstanceAdminRequest": {
   174        "base": null,
   175        "refs": {
   176        }
   177      },
   178      "DeleteAppInstanceRequest": {
   179        "base": null,
   180        "refs": {
   181        }
   182      },
   183      "DeleteAppInstanceUserRequest": {
   184        "base": null,
   185        "refs": {
   186        }
   187      },
   188      "DescribeAppInstanceAdminRequest": {
   189        "base": null,
   190        "refs": {
   191        }
   192      },
   193      "DescribeAppInstanceAdminResponse": {
   194        "base": null,
   195        "refs": {
   196        }
   197      },
   198      "DescribeAppInstanceRequest": {
   199        "base": null,
   200        "refs": {
   201        }
   202      },
   203      "DescribeAppInstanceResponse": {
   204        "base": null,
   205        "refs": {
   206        }
   207      },
   208      "DescribeAppInstanceUserRequest": {
   209        "base": null,
   210        "refs": {
   211        }
   212      },
   213      "DescribeAppInstanceUserResponse": {
   214        "base": null,
   215        "refs": {
   216        }
   217      },
   218      "ErrorCode": {
   219        "base": null,
   220        "refs": {
   221          "BadRequestException$Code": null,
   222          "ConflictException$Code": null,
   223          "ForbiddenException$Code": null,
   224          "ResourceLimitExceededException$Code": null,
   225          "ServiceFailureException$Code": null,
   226          "ServiceUnavailableException$Code": null,
   227          "ThrottledClientException$Code": null,
   228          "UnauthorizedClientException$Code": null
   229        }
   230      },
   231      "ForbiddenException": {
   232        "base": "<p>The client is permanently forbidden from making the request.</p>",
   233        "refs": {
   234        }
   235      },
   236      "GetAppInstanceRetentionSettingsRequest": {
   237        "base": null,
   238        "refs": {
   239        }
   240      },
   241      "GetAppInstanceRetentionSettingsResponse": {
   242        "base": null,
   243        "refs": {
   244        }
   245      },
   246      "Identity": {
   247        "base": "<p>The details of a user.</p>",
   248        "refs": {
   249          "AppInstanceAdmin$Admin": "<p>The <code>AppInstanceAdmin</code> data.</p>",
   250          "AppInstanceAdminSummary$Admin": "<p>The details of the <code>AppInstanceAdmin</code>.</p>",
   251          "CreateAppInstanceAdminResponse$AppInstanceAdmin": "<p>The name and ARN of the admin for the <code>AppInstance</code>.</p>"
   252        }
   253      },
   254      "ListAppInstanceAdminsRequest": {
   255        "base": null,
   256        "refs": {
   257        }
   258      },
   259      "ListAppInstanceAdminsResponse": {
   260        "base": null,
   261        "refs": {
   262        }
   263      },
   264      "ListAppInstanceUsersRequest": {
   265        "base": null,
   266        "refs": {
   267        }
   268      },
   269      "ListAppInstanceUsersResponse": {
   270        "base": null,
   271        "refs": {
   272        }
   273      },
   274      "ListAppInstancesRequest": {
   275        "base": null,
   276        "refs": {
   277        }
   278      },
   279      "ListAppInstancesResponse": {
   280        "base": null,
   281        "refs": {
   282        }
   283      },
   284      "MaxResults": {
   285        "base": null,
   286        "refs": {
   287          "ListAppInstanceAdminsRequest$MaxResults": "<p>The maximum number of administrators that you want to return.</p>",
   288          "ListAppInstanceUsersRequest$MaxResults": "<p>The maximum number of requests that you want returned.</p>",
   289          "ListAppInstancesRequest$MaxResults": "<p>The maximum number of <code>AppInstance</code>s that you want to return.</p>"
   290        }
   291      },
   292      "Metadata": {
   293        "base": null,
   294        "refs": {
   295          "AppInstance$Metadata": "<p>The metadata of an <code>AppInstance</code>.</p>",
   296          "AppInstanceSummary$Metadata": "<p>The metadata of the <code>AppInstance</code>.</p>",
   297          "AppInstanceUser$Metadata": "<p>The metadata of the <code>AppInstanceUser</code>.</p>",
   298          "AppInstanceUserSummary$Metadata": "<p>The metadata of the <code>AppInstanceUser</code>.</p>",
   299          "CreateAppInstanceRequest$Metadata": "<p>The metadata of the <code>AppInstance</code>. Limited to a 1KB string in UTF-8.</p>",
   300          "CreateAppInstanceUserRequest$Metadata": "<p>The request's metadata. Limited to a 1KB string in UTF-8.</p>",
   301          "UpdateAppInstanceRequest$Metadata": "<p>The metadata that you want to change.</p>",
   302          "UpdateAppInstanceUserRequest$Metadata": "<p>The metadata of the <code>AppInstanceUser</code>.</p>"
   303        }
   304      },
   305      "NextToken": {
   306        "base": null,
   307        "refs": {
   308          "ListAppInstanceAdminsRequest$NextToken": "<p>The token returned from previous API requests until the number of administrators is reached.</p>",
   309          "ListAppInstanceAdminsResponse$NextToken": "<p>The token returned from previous API requests until the number of administrators is reached.</p>",
   310          "ListAppInstanceUsersRequest$NextToken": "<p>The token passed by previous API calls until all requested users are returned.</p>",
   311          "ListAppInstanceUsersResponse$NextToken": "<p>The token passed by previous API calls until all requested users are returned.</p>",
   312          "ListAppInstancesRequest$NextToken": "<p>The token passed by previous API requests until you reach the maximum number of <code>AppInstances</code>.</p>",
   313          "ListAppInstancesResponse$NextToken": "<p>The token passed by previous API requests until the maximum number of <code>AppInstance</code>s is reached.</p>"
   314        }
   315      },
   316      "NonEmptyResourceName": {
   317        "base": null,
   318        "refs": {
   319          "AppInstance$Name": "<p>The name of an <code>AppInstance</code>.</p>",
   320          "AppInstanceSummary$Name": "<p>The name of the <code>AppInstance</code>.</p>",
   321          "CreateAppInstanceRequest$Name": "<p>The name of the <code>AppInstance</code>.</p>",
   322          "UpdateAppInstanceRequest$Name": "<p>The name that you want to change.</p>"
   323        }
   324      },
   325      "PutAppInstanceRetentionSettingsRequest": {
   326        "base": null,
   327        "refs": {
   328        }
   329      },
   330      "PutAppInstanceRetentionSettingsResponse": {
   331        "base": null,
   332        "refs": {
   333        }
   334      },
   335      "ResourceLimitExceededException": {
   336        "base": "<p>The request exceeds the resource limit.</p>",
   337        "refs": {
   338        }
   339      },
   340      "ResourceName": {
   341        "base": null,
   342        "refs": {
   343          "Identity$Name": "<p>The name in an Identity.</p>"
   344        }
   345      },
   346      "RetentionDays": {
   347        "base": null,
   348        "refs": {
   349          "ChannelRetentionSettings$RetentionDays": "<p>The time in days to retain the messages in a channel.</p>"
   350        }
   351      },
   352      "ServiceFailureException": {
   353        "base": "<p>The service encountered an unexpected error.</p>",
   354        "refs": {
   355        }
   356      },
   357      "ServiceUnavailableException": {
   358        "base": "<p>The service is currently unavailable.</p>",
   359        "refs": {
   360        }
   361      },
   362      "String": {
   363        "base": null,
   364        "refs": {
   365          "BadRequestException$Message": null,
   366          "ConflictException$Message": null,
   367          "ForbiddenException$Message": null,
   368          "ResourceLimitExceededException$Message": null,
   369          "ServiceFailureException$Message": null,
   370          "ServiceUnavailableException$Message": null,
   371          "ThrottledClientException$Message": null,
   372          "UnauthorizedClientException$Message": null
   373        }
   374      },
   375      "Tag": {
   376        "base": "<p>Describes a tag applied to a resource.</p>",
   377        "refs": {
   378          "TagList$member": null
   379        }
   380      },
   381      "TagKey": {
   382        "base": null,
   383        "refs": {
   384          "Tag$Key": "<p>The key of the tag.</p>"
   385        }
   386      },
   387      "TagList": {
   388        "base": null,
   389        "refs": {
   390          "CreateAppInstanceRequest$Tags": "<p>Tags assigned to the <code>AppInstanceUser</code>.</p>",
   391          "CreateAppInstanceUserRequest$Tags": "<p>Tags assigned to the <code>AppInstanceUser</code>.</p>"
   392        }
   393      },
   394      "TagValue": {
   395        "base": null,
   396        "refs": {
   397          "Tag$Value": "<p>The value of the tag.</p>"
   398        }
   399      },
   400      "ThrottledClientException": {
   401        "base": "<p>The client exceeded its request rate limit.</p>",
   402        "refs": {
   403        }
   404      },
   405      "Timestamp": {
   406        "base": null,
   407        "refs": {
   408          "AppInstance$CreatedTimestamp": "<p>The time at which an <code>AppInstance</code> was created. In epoch milliseconds.</p>",
   409          "AppInstance$LastUpdatedTimestamp": "<p>The time an <code>AppInstance</code> was last updated. In epoch milliseconds.</p>",
   410          "AppInstanceAdmin$CreatedTimestamp": "<p>The time at which an administrator was created.</p>",
   411          "AppInstanceUser$CreatedTimestamp": "<p>The time at which the <code>AppInstanceUser</code> was created.</p>",
   412          "AppInstanceUser$LastUpdatedTimestamp": "<p>The time at which the <code>AppInstanceUser</code> was last updated.</p>",
   413          "GetAppInstanceRetentionSettingsResponse$InitiateDeletionTimestamp": "<p>The timestamp representing the time at which the specified items are retained, in Epoch Seconds.</p>",
   414          "PutAppInstanceRetentionSettingsResponse$InitiateDeletionTimestamp": "<p>The time at which the API deletes data.</p>"
   415        }
   416      },
   417      "UnauthorizedClientException": {
   418        "base": "<p>The client is not currently authorized to make the request.</p>",
   419        "refs": {
   420        }
   421      },
   422      "UpdateAppInstanceRequest": {
   423        "base": null,
   424        "refs": {
   425        }
   426      },
   427      "UpdateAppInstanceResponse": {
   428        "base": null,
   429        "refs": {
   430        }
   431      },
   432      "UpdateAppInstanceUserRequest": {
   433        "base": null,
   434        "refs": {
   435        }
   436      },
   437      "UpdateAppInstanceUserResponse": {
   438        "base": null,
   439        "refs": {
   440        }
   441      },
   442      "UserId": {
   443        "base": null,
   444        "refs": {
   445          "CreateAppInstanceUserRequest$AppInstanceUserId": "<p>The user ID of the <code>AppInstance</code>.</p>"
   446        }
   447      },
   448      "UserName": {
   449        "base": null,
   450        "refs": {
   451          "AppInstanceUser$Name": "<p>The name of the <code>AppInstanceUser</code>.</p>",
   452          "AppInstanceUserSummary$Name": "<p>The name of an <code>AppInstanceUser</code>.</p>",
   453          "CreateAppInstanceUserRequest$Name": "<p>The user's name.</p>",
   454          "UpdateAppInstanceUserRequest$Name": "<p>The name of the <code>AppInstanceUser</code>.</p>"
   455        }
   456      }
   457    }
   458  }