"documentation":"<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>"
"documentation":"<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>"
"documentation":"<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>"
},
"DeleteAppInstance":{
"name":"DeleteAppInstance",
"http":{
"method":"DELETE",
"requestUri":"/app-instances/{appInstanceArn}",
"responseCode":204
},
"input":{"shape":"DeleteAppInstanceRequest"},
"errors":[
{"shape":"BadRequestException"},
{"shape":"ForbiddenException"},
{"shape":"ResourceLimitExceededException"},
{"shape":"ThrottledClientException"},
{"shape":"UnauthorizedClientException"},
{"shape":"ServiceUnavailableException"},
{"shape":"ServiceFailureException"}
],
"documentation":"<p>Deletes an <code>AppInstance</code> and all associated data asynchronously.</p>"
"documentation":"<p>The request could not be processed because of conflict in the current state of the resource.</p>",
"error":{"httpStatusCode":409},
"exception":true
},
"CreateAppInstanceAdminRequest":{
"type":"structure",
"required":[
"AppInstanceAdminArn",
"AppInstanceArn"
],
"members":{
"AppInstanceAdminArn":{
"shape":"ChimeArn",
"documentation":"<p>The ARN of the administrator of the current <code>AppInstance</code>.</p>"
},
"AppInstanceArn":{
"shape":"ChimeArn",
"documentation":"<p>The ARN of the <code>AppInstance</code>.</p>",
"location":"uri",
"locationName":"appInstanceArn"
}
}
},
"CreateAppInstanceAdminResponse":{
"type":"structure",
"members":{
"AppInstanceAdmin":{
"shape":"Identity",
"documentation":"<p>The name and ARN of the admin for the <code>AppInstance</code>.</p>"
},
"AppInstanceArn":{
"shape":"ChimeArn",
"documentation":"<p>The ARN of the of the admin for the <code>AppInstance</code>.</p>"
}
}
},
"CreateAppInstanceRequest":{
"type":"structure",
"required":[
"Name",
"ClientRequestToken"
],
"members":{
"Name":{
"shape":"NonEmptyResourceName",
"documentation":"<p>The name of the <code>AppInstance</code>.</p>"
},
"Metadata":{
"shape":"Metadata",
"documentation":"<p>The metadata of the <code>AppInstance</code>. Limited to a 1KB string in UTF-8.</p>"
},
"ClientRequestToken":{
"shape":"ClientRequestToken",
"documentation":"<p>The <code>ClientRequestToken</code> of the <code>AppInstance</code>.</p>",
"idempotencyToken":true
},
"Tags":{
"shape":"TagList",
"documentation":"<p>Tags assigned to the <code>AppInstanceUser</code>.</p>"
}
}
},
"CreateAppInstanceResponse":{
"type":"structure",
"members":{
"AppInstanceArn":{
"shape":"ChimeArn",
"documentation":"<p>The Amazon Resource Number (ARN) of the <code>AppInstance</code>.</p>"
}
}
},
"CreateAppInstanceUserRequest":{
"type":"structure",
"required":[
"AppInstanceArn",
"AppInstanceUserId",
"Name",
"ClientRequestToken"
],
"members":{
"AppInstanceArn":{
"shape":"ChimeArn",
"documentation":"<p>The ARN of the <code>AppInstance</code> request.</p>"
},
"AppInstanceUserId":{
"shape":"UserId",
"documentation":"<p>The user ID of the <code>AppInstance</code>.</p>"
},
"Name":{
"shape":"UserName",
"documentation":"<p>The user's name.</p>"
},
"Metadata":{
"shape":"Metadata",
"documentation":"<p>The request's metadata. Limited to a 1KB string in UTF-8.</p>"
},
"ClientRequestToken":{
"shape":"ClientRequestToken",
"documentation":"<p>The token assigned to the user requesting an <code>AppInstance</code>.</p>",
"idempotencyToken":true
},
"Tags":{
"shape":"TagList",
"documentation":"<p>Tags assigned to the <code>AppInstanceUser</code>.</p>"
}
}
},
"CreateAppInstanceUserResponse":{
"type":"structure",
"members":{
"AppInstanceUserArn":{
"shape":"ChimeArn",
"documentation":"<p>The user's ARN.</p>"
}
}
},
"DeleteAppInstanceAdminRequest":{
"type":"structure",
"required":[
"AppInstanceAdminArn",
"AppInstanceArn"
],
"members":{
"AppInstanceAdminArn":{
"shape":"ChimeArn",
"documentation":"<p>The ARN of the <code>AppInstance</code>'s administrator.</p>",
"location":"uri",
"locationName":"appInstanceAdminArn"
},
"AppInstanceArn":{
"shape":"ChimeArn",
"documentation":"<p>The ARN of the <code>AppInstance</code>.</p>",
"location":"uri",
"locationName":"appInstanceArn"
}
}
},
"DeleteAppInstanceRequest":{
"type":"structure",
"required":["AppInstanceArn"],
"members":{
"AppInstanceArn":{
"shape":"ChimeArn",
"documentation":"<p>The ARN of the <code>AppInstance</code>.</p>",
"location":"uri",
"locationName":"appInstanceArn"
}
}
},
"DeleteAppInstanceUserRequest":{
"type":"structure",
"required":["AppInstanceUserArn"],
"members":{
"AppInstanceUserArn":{
"shape":"ChimeArn",
"documentation":"<p>The ARN of the user request being deleted.</p>",
"location":"uri",
"locationName":"appInstanceUserArn"
}
}
},
"DescribeAppInstanceAdminRequest":{
"type":"structure",
"required":[
"AppInstanceAdminArn",
"AppInstanceArn"
],
"members":{
"AppInstanceAdminArn":{
"shape":"ChimeArn",
"documentation":"<p>The ARN of the <code>AppInstanceAdmin</code>.</p>",
"location":"uri",
"locationName":"appInstanceAdminArn"
},
"AppInstanceArn":{
"shape":"ChimeArn",
"documentation":"<p>The ARN of the <code>AppInstance</code>.</p>",
"location":"uri",
"locationName":"appInstanceArn"
}
}
},
"DescribeAppInstanceAdminResponse":{
"type":"structure",
"members":{
"AppInstanceAdmin":{
"shape":"AppInstanceAdmin",
"documentation":"<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>"
}
}
},
"DescribeAppInstanceRequest":{
"type":"structure",
"required":["AppInstanceArn"],
"members":{
"AppInstanceArn":{
"shape":"ChimeArn",
"documentation":"<p>The ARN of the <code>AppInstance</code>.</p>",
"location":"uri",
"locationName":"appInstanceArn"
}
}
},
"DescribeAppInstanceResponse":{
"type":"structure",
"members":{
"AppInstance":{
"shape":"AppInstance",
"documentation":"<p>The ARN, metadata, created and last-updated timestamps, and the name of the <code>AppInstance</code>. All timestamps use epoch milliseconds.</p>"
}
}
},
"DescribeAppInstanceUserRequest":{
"type":"structure",
"required":["AppInstanceUserArn"],
"members":{
"AppInstanceUserArn":{
"shape":"ChimeArn",
"documentation":"<p>The ARN of the <code>AppInstanceUser</code>.</p>",
"location":"uri",
"locationName":"appInstanceUserArn"
}
}
},
"DescribeAppInstanceUserResponse":{
"type":"structure",
"members":{
"AppInstanceUser":{
"shape":"AppInstanceUser",
"documentation":"<p>The name of the <code>AppInstanceUser</code>.</p>"
}
}
},
"ErrorCode":{
"type":"string",
"enum":[
"BadRequest",
"Conflict",
"Forbidden",
"NotFound",
"PreconditionFailed",
"ResourceLimitExceeded",
"ServiceFailure",
"AccessDenied",
"ServiceUnavailable",
"Throttled",
"Throttling",
"Unauthorized",
"Unprocessable",
"VoiceConnectorGroupAssociationsExist",
"PhoneNumberAssociationsExist"
]
},
"ForbiddenException":{
"type":"structure",
"members":{
"Code":{"shape":"ErrorCode"},
"Message":{"shape":"String"}
},
"documentation":"<p>The client is permanently forbidden from making the request.</p>",
"error":{"httpStatusCode":403},
"exception":true
},
"GetAppInstanceRetentionSettingsRequest":{
"type":"structure",
"required":["AppInstanceArn"],
"members":{
"AppInstanceArn":{
"shape":"ChimeArn",
"documentation":"<p>The ARN of the <code>AppInstance</code>.</p>",
"location":"uri",
"locationName":"appInstanceArn"
}
}
},
"GetAppInstanceRetentionSettingsResponse":{
"type":"structure",
"members":{
"AppInstanceRetentionSettings":{
"shape":"AppInstanceRetentionSettings",
"documentation":"<p>The retention settings for the <code>AppInstance</code>.</p>"
},
"InitiateDeletionTimestamp":{
"shape":"Timestamp",
"documentation":"<p>The timestamp representing the time at which the specified items are retained, in Epoch Seconds.</p>"
}
}
},
"Identity":{
"type":"structure",
"members":{
"Arn":{
"shape":"ChimeArn",
"documentation":"<p>The ARN in an Identity.</p>"
},
"Name":{
"shape":"ResourceName",
"documentation":"<p>The name in an Identity.</p>"
}
},
"documentation":"<p>The details of a user.</p>"
},
"ListAppInstanceAdminsRequest":{
"type":"structure",
"required":["AppInstanceArn"],
"members":{
"AppInstanceArn":{
"shape":"ChimeArn",
"documentation":"<p>The ARN of the <code>AppInstance</code>.</p>",
"location":"uri",
"locationName":"appInstanceArn"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of administrators that you want to return.</p>",
"location":"querystring",
"locationName":"max-results"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The token returned from previous API requests until the number of administrators is reached.</p>",
"location":"querystring",
"locationName":"next-token"
}
}
},
"ListAppInstanceAdminsResponse":{
"type":"structure",
"members":{
"AppInstanceArn":{
"shape":"ChimeArn",
"documentation":"<p>The ARN of the <code>AppInstance</code>.</p>"
},
"AppInstanceAdmins":{
"shape":"AppInstanceAdminList",
"documentation":"<p>The information for each administrator.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The token returned from previous API requests until the number of administrators is reached.</p>"
}
}
},
"ListAppInstanceUsersRequest":{
"type":"structure",
"required":["AppInstanceArn"],
"members":{
"AppInstanceArn":{
"shape":"ChimeArn",
"documentation":"<p>The ARN of the <code>AppInstance</code>.</p>",
"location":"querystring",
"locationName":"app-instance-arn"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of requests that you want returned.</p>",
"location":"querystring",
"locationName":"max-results"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The token passed by previous API calls until all requested users are returned.</p>",
"location":"querystring",
"locationName":"next-token"
}
}
},
"ListAppInstanceUsersResponse":{
"type":"structure",
"members":{
"AppInstanceArn":{
"shape":"ChimeArn",
"documentation":"<p>The ARN of the <code>AppInstance</code>.</p>"
},
"AppInstanceUsers":{
"shape":"AppInstanceUserList",
"documentation":"<p>The information for each requested <code>AppInstanceUser</code>.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The token passed by previous API calls until all requested users are returned.</p>"
}
}
},
"ListAppInstancesRequest":{
"type":"structure",
"members":{
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of <code>AppInstance</code>s that you want to return.</p>",
"location":"querystring",
"locationName":"max-results"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The token passed by previous API requests until you reach the maximum number of <code>AppInstances</code>.</p>",
"location":"querystring",
"locationName":"next-token"
}
}
},
"ListAppInstancesResponse":{
"type":"structure",
"members":{
"AppInstances":{
"shape":"AppInstanceList",
"documentation":"<p>The information for each <code>AppInstance</code>.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The token passed by previous API requests until the maximum number of <code>AppInstance</code>s is reached.</p>"
"documentation":"<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>"