openapi-directory

Version:

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

github.com/httptoolkit/openapi-directory-js

1 lines • 63.6 kB

JSON

{"openapi":"3.0.0","info":{"version":"2020-07-14","x-release":"v4","title":"Amazon Interactive Video Service RealTime","description":" Introduction The Amazon Interactive Video Service (IVS) real-time API is REST compatible, using a standard HTTP API and an AWS EventBridge event stream for responses. JSON is used for both requests and responses, including errors. Terminology: <ul> <li> A stage is a virtual space where participants can exchange video in real time. </li> <li> A participant token is a token that authenticates a participant when they join a stage. </li> <li> A participant object represents participants (people) in the stage and contains information about them. When a token is created, it includes a participant ID; when a participant uses that token to join a stage, the participant is associated with that participant ID There is a 1:1 mapping between participant tokens and participants. </li> </ul> Resources The following resources contain information about your IVS live stream (see <a href=\"https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/getting-started.html\">Getting Started with Amazon IVS Real-Time Streaming</a>): <ul> <li> Stage — A stage is a virtual space where participants can exchange video in real time. </li> </ul> Tagging A tag is a metadata label that you assign to an AWS resource. A tag comprises a key and a value, both set by you. For example, you might set a tag as <code>topic:nature</code> to label a particular video category. See <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html\">Tagging AWS Resources</a> for more information, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS stages has no service-specific constraints beyond what is documented there. Tags can help you identify and organize your AWS resources. For example, you can use the same tag for different resources to indicate that they are related. You can also use tags to manage access (see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html\">Access Tags</a>). The Amazon IVS real-time API has these tag-related endpoints: <a>TagResource</a>, <a>UntagResource</a>, and <a>ListTagsForResource</a>. The following resource supports tagging: Stage. At most 50 tags can be applied to a resource. Stages Endpoints <ul> <li> <a>CreateParticipantToken</a> — Creates an additional token for a specified stage. This can be done after stage creation or when tokens expire. </li> <li> <a>CreateStage</a> — Creates a new stage (and optionally participant tokens). </li> <li> <a>DeleteStage</a> — Shuts down and deletes the specified stage (disconnecting all participants). </li> <li> <a>DisconnectParticipant</a> — Disconnects a specified participant and revokes the participant permanently from a specified stage. </li> <li> <a>GetParticipant</a> — Gets information about the specified participant token. </li> <li> <a>GetStage</a> — Gets information for the specified stage. </li> <li> <a>GetStageSession</a> — Gets information for the specified stage session. </li> <li> <a>ListParticipantEvents</a> — Lists events for a specified participant that occurred during a specified stage session. </li> <li> <a>ListParticipants</a> — Lists all participants in a specified stage session. </li> <li> <a>ListStages</a> — Gets summary information about all stages in your account, in the AWS region where the API request is processed. </li> <li> <a>ListStageSessions</a> — Gets all sessions for a specified stage. </li> <li> <a>UpdateStage</a> — Updates a stage’s configuration. </li> </ul> Tags Endpoints <ul> <li> <a>ListTagsForResource</a> — Gets information about AWS tags for the specified ARN. </li> <li> <a>TagResource</a> — Adds or updates tags for the AWS resource with the specified ARN. </li> <li> <a>UntagResource</a> — Removes tags from the resource with the specified ARN. </li> </ul>","x-logo":{"url":"https://twitter.com/awscloud/profile_image?size=original","backgroundColor":"#FFFFFF"},"termsOfService":"https://aws.amazon.com/service-terms/","contact":{"name":"Mike Ralphson","email":"mike.ralphson@gmail.com","url":"https://github.com/mermade/aws2openapi","x-twitter":"PermittedSoc"},"license":{"name":"Apache 2.0 License","url":"http://www.apache.org/licenses/"},"x-providerName":"amazonaws.com","x-serviceName":"ivs-realtime","x-aws-signingName":"ivs","x-origin":[{"contentType":"application/json","url":"https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/ivs-realtime-2020-07-14.normal.json","converter":{"url":"https://github.com/mermade/aws2openapi","version":"1.0.0"},"x-apisguru-driver":"external"}],"x-apiClientRegistration":{"url":"https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct"},"x-apisguru-categories":["cloud"],"x-preferred":true},"externalDocs":{"description":"Amazon Web Services documentation","url":"https://docs.aws.amazon.com/ivsrealtime/"},"servers":[{"url":"http://ivsrealtime.{region}.amazonaws.com","variables":{"region":{"description":"The AWS region","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1"}},"description":"The ivsrealtime multi-region endpoint"},{"url":"https://ivsrealtime.{region}.amazonaws.com","variables":{"region":{"description":"The AWS region","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1"}},"description":"The ivsrealtime multi-region endpoint"},{"url":"http://ivsrealtime.{region}.amazonaws.com.cn","variables":{"region":{"description":"The AWS region","enum":["cn-north-1","cn-northwest-1"],"default":"cn-north-1"}},"description":"The ivsrealtime endpoint for China (Beijing) and China (Ningxia)"},{"url":"https://ivsrealtime.{region}.amazonaws.com.cn","variables":{"region":{"description":"The AWS region","enum":["cn-north-1","cn-northwest-1"],"default":"cn-north-1"}},"description":"The ivsrealtime endpoint for China (Beijing) and China (Ningxia)"}],"x-hasEquivalentPaths":true,"paths":{"/CreateParticipantToken":{"post":{"operationId":"CreateParticipantToken","description":"Creates an additional token for a specified stage. This can be done after stage creation or when tokens expire. Tokens always are scoped to the stage for which they are created. Encryption keys are owned by Amazon IVS and never used directly by your application.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateParticipantTokenResponse"}}}},"480":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"481":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"482":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"483":{"description":"ServiceQuotaExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceQuotaExceededException"}}}},"484":{"description":"PendingVerification","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PendingVerification"}}}}},"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["stageArn"],"properties":{"attributes":{"description":"Application-provided attributes to encode into the token and attach to a stage. Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information. ","type":"object","additionalProperties":{"$ref":"#/components/schemas/String"}},"capabilities":{"description":"Set of capabilities that the user is allowed to perform in the stage. Default: <code>PUBLISH, SUBSCRIBE</code>.","type":"array","items":{"$ref":"#/components/schemas/ParticipantTokenCapability"},"minItems":0,"maxItems":2},"duration":{"description":"Duration (in minutes), after which the token expires. Default: 720 (12 hours).","type":"integer","minimum":1,"maximum":20160},"stageArn":{"description":"ARN of the stage to which this token is scoped.","type":"string","pattern":"^arn:aws:ivs:[a-z0-9-]+:[0-9]+:stage/[a-zA-Z0-9-]+$","minLength":1,"maxLength":128},"userId":{"description":"Name that can be specified to help identify the token. This can be any UTF-8 encoded text. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information. ","type":"string","minLength":0,"maxLength":128}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/CreateStage":{"post":{"operationId":"CreateStage","description":"Creates a new stage (and optionally participant tokens).","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateStageResponse"}}}},"480":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"481":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"482":{"description":"ServiceQuotaExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceQuotaExceededException"}}}},"483":{"description":"PendingVerification","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PendingVerification"}}}}},"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"description":"Optional name that can be specified for the stage being created.","type":"string","pattern":"^[a-zA-Z0-9-_]*$","minLength":0,"maxLength":128},"participantTokenConfigurations":{"description":"Array of participant token configuration objects to attach to the new stage.","type":"array","items":{"$ref":"#/components/schemas/ParticipantTokenConfiguration"},"minItems":0,"maxItems":12},"tags":{"description":"Tags attached to the resource. Array of maps, each of the form <code>string:string (key:value)</code>. See <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html\">Tagging AWS Resources</a> for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there. ","type":"object","minProperties":0,"maxProperties":50,"additionalProperties":{"$ref":"#/components/schemas/TagValue"}}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/DeleteStage":{"post":{"operationId":"DeleteStage","description":"Shuts down and deletes the specified stage (disconnecting all participants).","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteStageResponse"}}}},"480":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"481":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"482":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"483":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"484":{"description":"PendingVerification","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PendingVerification"}}}}},"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["arn"],"properties":{"arn":{"description":"ARN of the stage to be deleted.","type":"string","pattern":"^arn:aws:ivs:[a-z0-9-]+:[0-9]+:stage/[a-zA-Z0-9-]+$","minLength":1,"maxLength":128}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/DisconnectParticipant":{"post":{"operationId":"DisconnectParticipant","description":"Disconnects a specified participant and revokes the participant permanently from a specified stage.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DisconnectParticipantResponse"}}}},"480":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"481":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"482":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"483":{"description":"PendingVerification","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PendingVerification"}}}}},"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["participantId","stageArn"],"properties":{"participantId":{"description":"Identifier of the participant to be disconnected. This is assigned by IVS and returned by <a>CreateParticipantToken</a>.","type":"string"},"reason":{"description":"Description of why this participant is being disconnected.","type":"string","minLength":0,"maxLength":128},"stageArn":{"description":"ARN of the stage to which the participant is attached.","type":"string","pattern":"^arn:aws:ivs:[a-z0-9-]+:[0-9]+:stage/[a-zA-Z0-9-]+$","minLength":1,"maxLength":128}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/GetParticipant":{"post":{"operationId":"GetParticipant","description":"Gets information about the specified participant token.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetParticipantResponse"}}}},"480":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"481":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"482":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}}},"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["participantId","sessionId","stageArn"],"properties":{"participantId":{"description":"Unique identifier for the participant. This is assigned by IVS and returned by <a>CreateParticipantToken</a>.","type":"string"},"sessionId":{"description":"ID of a session within the stage.","type":"string","pattern":"^st-[a-zA-Z0-9]+$","minLength":16,"maxLength":16},"stageArn":{"description":"Stage ARN.","type":"string","pattern":"^arn:aws:ivs:[a-z0-9-]+:[0-9]+:stage/[a-zA-Z0-9-]+$","minLength":1,"maxLength":128}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/GetStage":{"post":{"operationId":"GetStage","description":"Gets information for the specified stage.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetStageResponse"}}}},"480":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"481":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"482":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}}},"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["arn"],"properties":{"arn":{"description":"ARN of the stage for which the information is to be retrieved.","type":"string","pattern":"^arn:aws:ivs:[a-z0-9-]+:[0-9]+:stage/[a-zA-Z0-9-]+$","minLength":1,"maxLength":128}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/GetStageSession":{"post":{"operationId":"GetStageSession","description":"Gets information for the specified stage session.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetStageSessionResponse"}}}},"480":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"481":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"482":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}}},"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["sessionId","stageArn"],"properties":{"sessionId":{"description":"ID of a session within the stage.","type":"string","pattern":"^st-[a-zA-Z0-9]+$","minLength":16,"maxLength":16},"stageArn":{"description":"ARN of the stage for which the information is to be retrieved.","type":"string","pattern":"^arn:aws:ivs:[a-z0-9-]+:[0-9]+:stage/[a-zA-Z0-9-]+$","minLength":1,"maxLength":128}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/ListParticipantEvents":{"post":{"operationId":"ListParticipantEvents","description":"Lists events for a specified participant that occurred during a specified stage session.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListParticipantEventsResponse"}}}},"480":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"481":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}}},"parameters":[{"name":"maxResults","in":"query","schema":{"type":"string"},"description":"Pagination limit","required":false},{"name":"nextToken","in":"query","schema":{"type":"string"},"description":"Pagination token","required":false}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["participantId","sessionId","stageArn"],"properties":{"maxResults":{"description":"Maximum number of results to return. Default: 50.","type":"integer","minimum":1,"maximum":100},"nextToken":{"description":"The first participant to retrieve. This is used for pagination; see the <code>nextToken</code> response field.","type":"string","pattern":"^[a-zA-Z0-9+/=_-]*$","minLength":0,"maxLength":1024},"participantId":{"description":"Unique identifier for this participant. This is assigned by IVS and returned by <a>CreateParticipantToken</a>.","type":"string"},"sessionId":{"description":"ID of a session within the stage.","type":"string","pattern":"^st-[a-zA-Z0-9]+$","minLength":16,"maxLength":16},"stageArn":{"description":"Stage ARN.","type":"string","pattern":"^arn:aws:ivs:[a-z0-9-]+:[0-9]+:stage/[a-zA-Z0-9-]+$","minLength":1,"maxLength":128}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/ListParticipants":{"post":{"operationId":"ListParticipants","description":"Lists all participants in a specified stage session.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListParticipantsResponse"}}}},"480":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"481":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}}},"parameters":[{"name":"maxResults","in":"query","schema":{"type":"string"},"description":"Pagination limit","required":false},{"name":"nextToken","in":"query","schema":{"type":"string"},"description":"Pagination token","required":false}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["sessionId","stageArn"],"properties":{"filterByPublished":{"description":"Filters the response list to only show participants who published during the stage session. Only one of <code>filterByUserId</code>, <code>filterByPublished</code>, or <code>filterByState</code> can be provided per request.","type":"boolean"},"filterByState":{"description":"Filters the response list to only show participants in the specified state. Only one of <code>filterByUserId</code>, <code>filterByPublished</code>, or <code>filterByState</code> can be provided per request.","type":"string","enum":["CONNECTED","DISCONNECTED"]},"filterByUserId":{"description":"Filters the response list to match the specified user ID. Only one of <code>filterByUserId</code>, <code>filterByPublished</code>, or <code>filterByState</code> can be provided per request. A <code>userId</code> is a customer-assigned name to help identify the token; this can be used to link a participant to a user in the customer’s own systems.","type":"string","minLength":0,"maxLength":128},"maxResults":{"description":"Maximum number of results to return. Default: 50.","type":"integer","minimum":1,"maximum":100},"nextToken":{"description":"The first participant to retrieve. This is used for pagination; see the <code>nextToken</code> response field.","type":"string","pattern":"^[a-zA-Z0-9+/=_-]*$","minLength":0,"maxLength":1024},"sessionId":{"description":"ID of the session within the stage.","type":"string","pattern":"^st-[a-zA-Z0-9]+$","minLength":16,"maxLength":16},"stageArn":{"description":"Stage ARN.","type":"string","pattern":"^arn:aws:ivs:[a-z0-9-]+:[0-9]+:stage/[a-zA-Z0-9-]+$","minLength":1,"maxLength":128}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/ListStageSessions":{"post":{"operationId":"ListStageSessions","description":"Gets all sessions for a specified stage.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListStageSessionsResponse"}}}},"480":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"481":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}}},"parameters":[{"name":"maxResults","in":"query","schema":{"type":"string"},"description":"Pagination limit","required":false},{"name":"nextToken","in":"query","schema":{"type":"string"},"description":"Pagination token","required":false}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["stageArn"],"properties":{"maxResults":{"description":"Maximum number of results to return. Default: 50.","type":"integer","minimum":1,"maximum":100},"nextToken":{"description":"The first stage to retrieve. This is used for pagination; see the <code>nextToken</code> response field.","type":"string","pattern":"^[a-zA-Z0-9+/=_-]*$","minLength":0,"maxLength":1024},"stageArn":{"description":"Stage ARN.","type":"string","pattern":"^arn:aws:ivs:[a-z0-9-]+:[0-9]+:stage/[a-zA-Z0-9-]+$","minLength":1,"maxLength":128}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/ListStages":{"post":{"operationId":"ListStages","description":"Gets summary information about all stages in your account, in the AWS region where the API request is processed.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListStagesResponse"}}}},"480":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"481":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"482":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}}},"parameters":[{"name":"maxResults","in":"query","schema":{"type":"string"},"description":"Pagination limit","required":false},{"name":"nextToken","in":"query","schema":{"type":"string"},"description":"Pagination token","required":false}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"maxResults":{"description":"Maximum number of results to return. Default: 50.","type":"integer","minimum":1,"maximum":100},"nextToken":{"description":"The first stage to retrieve. This is used for pagination; see the <code>nextToken</code> response field.","type":"string","pattern":"^[a-zA-Z0-9+/=_-]*$","minLength":0,"maxLength":1024}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/tags/{resourceArn}":{"get":{"operationId":"ListTagsForResource","description":"Gets information about AWS tags for the specified ARN.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListTagsForResourceResponse"}}}},"480":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"481":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"482":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}}},"parameters":[{"name":"resourceArn","in":"path","required":true,"description":"The ARN of the resource to be retrieved. The ARN must be URL-encoded.","schema":{"type":"string","pattern":"^arn:aws:[is]vs:[a-z0-9-]+:[0-9]+:[a-z-]/[a-zA-Z0-9-]+$","minLength":1,"maxLength":128}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"post":{"operationId":"TagResource","description":"Adds or updates tags for the AWS resource with the specified ARN.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TagResourceResponse"}}}},"480":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"481":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"482":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}}},"parameters":[{"name":"resourceArn","in":"path","required":true,"description":"The ARN of the resource to be tagged. The ARN must be URL-encoded.","schema":{"type":"string","pattern":"^arn:aws:[is]vs:[a-z0-9-]+:[0-9]+:[a-z-]/[a-zA-Z0-9-]+$","minLength":1,"maxLength":128}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["tags"],"properties":{"tags":{"description":"Array of tags to be added or updated. Array of maps, each of the form <code>string:string (key:value)</code>. See <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html\">Tagging AWS Resources</a> for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints beyond what is documented there.","type":"object","minProperties":0,"maxProperties":50,"additionalProperties":{"$ref":"#/components/schemas/TagValue"}}}}}}}}},"/tags/{resourceArn}#tagKeys":{"delete":{"operationId":"UntagResource","description":"Removes tags from the resource with the specified ARN.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UntagResourceResponse"}}}},"480":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"481":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"482":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}}},"parameters":[{"name":"resourceArn","in":"path","required":true,"description":"The ARN of the resource to be untagged. The ARN must be URL-encoded.","schema":{"type":"string","pattern":"^arn:aws:[is]vs:[a-z0-9-]+:[0-9]+:[a-z-]/[a-zA-Z0-9-]+$","minLength":1,"maxLength":128}},{"name":"tagKeys","in":"query","required":true,"description":"Array of tags to be removed. Array of maps, each of the form <code>string:string (key:value)</code>. See <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html\">Tagging AWS Resources</a> for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints beyond what is documented there.","schema":{"type":"array","items":{"$ref":"#/components/schemas/TagKey"},"minItems":0,"maxItems":50}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/UpdateStage":{"post":{"operationId":"UpdateStage","description":"Updates a stage’s configuration.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateStageResponse"}}}},"480":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"481":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"482":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"483":{"description":"ServiceQuotaExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceQuotaExceededException"}}}},"484":{"description":"PendingVerification","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PendingVerification"}}}}},"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["arn"],"properties":{"arn":{"description":"ARN of the stage to be updated.","type":"string","pattern":"^arn:aws:ivs:[a-z0-9-]+:[0-9]+:stage/[a-zA-Z0-9-]+$","minLength":1,"maxLength":128},"name":{"description":"Name of the stage to be updated.","type":"string","pattern":"^[a-zA-Z0-9-_]*$","minLength":0,"maxLength":128}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]}},"components":{"parameters":{"X-Amz-Content-Sha256":{"name":"X-Amz-Content-Sha256","in":"header","schema":{"type":"string"},"required":false},"X-Amz-Date":{"name":"X-Amz-Date","in":"header","schema":{"type":"string"},"required":false},"X-Amz-Algorithm":{"name":"X-Amz-Algorithm","in":"header","schema":{"type":"string"},"required":false},"X-Amz-Credential":{"name":"X-Amz-Credential","in":"header","schema":{"type":"string"},"required":false},"X-Amz-Security-Token":{"name":"X-Amz-Security-Token","in":"header","schema":{"type":"string"},"required":false},"X-Amz-Signature":{"name":"X-Amz-Signature","in":"header","schema":{"type":"string"},"required":false},"X-Amz-SignedHeaders":{"name":"X-Amz-SignedHeaders","in":"header","schema":{"type":"string"},"required":false}},"securitySchemes":{"hmac":{"type":"apiKey","name":"Authorization","in":"header","description":"Amazon Signature authorization v4","x-amazon-apigateway-authtype":"awsSigv4"}},"schemas":{"CreateParticipantTokenResponse":{"type":"object","properties":{"participantToken":{"allOf":[{"$ref":"#/components/schemas/ParticipantToken"},{"description":"The participant token that was created."}]}}},"String":{"type":"string"},"ParticipantTokenCapability":{"type":"string","enum":["PUBLISH","SUBSCRIBE"]},"ResourceNotFoundException":{},"ValidationException":{},"AccessDeniedException":{},"ServiceQuotaExceededException":{},"PendingVerification":{},"CreateStageResponse":{"type":"object","properties":{"participantTokens":{"allOf":[{"$ref":"#/components/schemas/ParticipantTokenList"},{"description":"Participant tokens attached to the stage. These correspond to the <code>participants</code> in the request."}]},"stage":{"allOf":[{"$ref":"#/components/schemas/Stage"},{"description":"The stage that was created."}]}}},"ParticipantTokenConfiguration":{"type":"object","properties":{"attributes":{"allOf":[{"$ref":"#/components/schemas/ParticipantTokenAttributes"},{"description":"Application-provided attributes to encode into the corresponding participant token and attach to a stage. Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information. "}]},"capabilities":{"allOf":[{"$ref":"#/components/schemas/ParticipantTokenCapabilities"},{"description":"Set of capabilities that the user is allowed to perform in the stage."}]},"duration":{"allOf":[{"$ref":"#/components/schemas/ParticipantTokenDurationMinutes"},{"description":"Duration (in minutes), after which the corresponding participant token expires. Default: 720 (12 hours)."}]},"userId":{"allOf":[{"$ref":"#/components/schemas/ParticipantTokenUserId"},{"description":"Customer-assigned name to help identify the token; this can be used to link a participant to a user in the customer’s own systems. This can be any UTF-8 encoded text. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information. "}]}},"description":"Object specifying a participant token configuration in a stage."},"TagValue":{"type":"string","minLength":0,"maxLength":256},"DeleteStageResponse":{"type":"object","properties":{}},"ConflictException":{},"DisconnectParticipantResponse":{"type":"object","properties":{}},"GetParticipantResponse":{"type":"object","properties":{"participant":{"allOf":[{"$ref":"#/components/schemas/Participant"},{"description":"The participant that is returned."}]}}},"GetStageResponse":{"type":"object","properties":{"stage":{"allOf":[{"$ref":"#/components/schemas/Stage"},{"description":"The stage that is returned."}]}}},"GetStageSessionResponse":{"type":"object","properties":{"stageSession":{"allOf":[{"$ref":"#/components/schemas/StageSession"},{"description":"The stage session that is returned."}]}}},"ListParticipantEventsResponse":{"type":"object","required":["events"],"properties":{"events":{"allOf":[{"$ref":"#/components/schemas/EventList"},{"description":"List of the matching events."}]},"nextToken":{"allOf":[{"$ref":"#/components/schemas/PaginationToken"},{"description":"If there are more rooms than <code>maxResults</code>, use <code>nextToken</code> in the request to get the next set. "}]}}},"ListParticipantsResponse":{"type":"object","required":["participants"],"properties":{"nextToken":{"allOf":[{"$ref":"#/components/schemas/PaginationToken"},{"description":"If there are more rooms than <code>maxResults</code>, use <code>nextToken</code> in the request to get the next set."}]},"participants":{"allOf":[{"$ref":"#/components/schemas/ParticipantList"},{"description":"List of the matching participants (summary information only)."}]}}},"ListStageSessionsResponse":{"type":"object","required":["stageSessions"],"properties":{"nextToken":{"allOf":[{"$ref":"#/components/schemas/PaginationToken"},{"description":"If there are more rooms than <code>maxResults</code>, use <code>nextToken</code> in the request to get the next set."}]},"stageSessions":{"allOf":[{"$ref":"#/components/schemas/StageSessionList"},{"description":"List of matching stage sessions."}]}}},"ListStagesResponse":{"type":"object","required":["stages"],"properties":{"nextToken":{"allOf":[{"$ref":"#/components/schemas/PaginationToken"},{"description":"If there are more rooms than <code>maxResults</code>, use <code>nextToken</code> in the request to get the next set."}]},"stages":{"allOf":[{"$ref":"#/components/schemas/StageSummaryList"},{"description":"List of the matching stages (summary information only)."}]}}},"ListTagsForResourceResponse":{"type":"object","required":["tags"],"properties":{"tags":{"allOf":[{"$ref":"#/components/schemas/Tags"},{"description":"Tags attached to the resource. Array of maps, each of the form <code>string:string (key:value)</code>."}]}}},"InternalServerException":{},"TagResourceResponse":{"type":"object","properties":{}},"UntagResourceResponse":{"type":"object","properties":{}},"TagKey":{"type":"string","minLength":1,"maxLength":128},"UpdateStageResponse":{"type":"object","properties":{"stage":{"allOf":[{"$ref":"#/components/schemas/Stage"},{"description":"The updated stage."}]}}},"ParticipantTokenAttributes":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/String"}},"ParticipantTokenCapabilities":{"type":"array","items":{"$ref":"#/components/schemas/ParticipantTokenCapability"},"minItems":0,"maxItems":2},"ParticipantTokenDurationMinutes":{"type":"integer","minimum":1,"maximum":20160},"StageArn":{"type":"string","pattern":"^arn:aws:ivs:[a-z0-9-]+:[0-9]+:stage/[a-zA-Z0-9-]+$","minLength":1,"maxLength":128},"ParticipantTokenUserId":{"type":"string","minLength":0,"maxLength":128},"CreateParticipantTokenRequest":{"type":"object","required":["stageArn"],"title":"CreateParticipantTokenRequest","properties":{"attributes":{"allOf":[{"$ref":"#/components/schemas/ParticipantTokenAttributes"},{"description":"Application-provided attributes to encode into the token and attach to a stage. Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information. "}]},"capabilities":{"allOf":[{"$ref":"#/components/schemas/ParticipantTokenCapabilities"},{"description":"Set of capabilities that the user is allowed to perform in the stage. Default: <code>PUBLISH, SUBSCRIBE</code>."}]},"duration":{"allOf":[{"$ref":"#/components/schemas/ParticipantTokenDurationMinutes"},{"description":"Duration (in minutes), after which the token expires. Default: 720 (12 hours)."}]},"stageArn":{"allOf":[{"$ref":"#/components/schemas/StageArn"},{"description":"ARN of the stage to which this token is scoped."}]},"userId":{"allOf":[{"$ref":"#/components/schemas/ParticipantTokenUserId"},{"description":"Name that can be specified to help identify the token. This can be any UTF-8 encoded text. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information. "}]}}},"ParticipantToken":{"type":"object","properties":{"attributes":{"allOf":[{"$ref":"#/components/schemas/ParticipantTokenAttributes"},{"description":"Application-provided attributes to encode into the token and attach to a stage. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information. "}]},"capabilities":{"allOf":[{"$ref":"#/components/schemas/ParticipantTokenCapabilities"},{"description":"Set of capabilities that the user is allowed to perform in the stage."}]},"duration":{"allOf":[{"$ref":"#/components/schemas/ParticipantTokenDurationMinutes"},{"description":"Duration (in minutes), after which the participant token expires. Default: 720 (12 hours)."}]},"expirationTime":{"allOf":[{"$ref":"#/components/schemas/ParticipantTokenExpirationTime"},{"description":"ISO 8601 timestamp (returned as a string) for when this token expires."}]},"participantId":{"allOf":[{"$ref":"#/components/schemas/ParticipantTokenId"},{"description":"Unique identifier for this participant token, assigned by IVS."}]},"token":{"allOf":[{"$ref":"#/components/schemas/ParticipantTokenString"},{"description":"The issued client token, encrypted."}]},"userId":{"allOf":[{"$ref":"#/components/schemas/ParticipantTokenUserId"},{"description":"Customer-assigned name to help identify the token; this can be used to link a participant to a user in the customer’s own systems. This can be any UTF-8 encoded text. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information. "}]}},"description":"Object specifying a participant token in a stage."},"StageName":{"type":"string","pattern":"^[a-zA-Z0-9-_]*$","minLength":0,"maxLength":128},"ParticipantTokenConfigurations":{"type":"array","items":{"$ref":"#/components/schemas/ParticipantTokenConfiguration"},"minItems":0,"maxItems":12},"Tags":{"type":"object","minProperties":0,"maxProperties":50,"additionalProperties":{"$ref":"#/components/schemas/TagValue"}},"CreateStageRequest":{"type":"object","title":"CreateStageRequest","properties":{"name":{"allOf":[{"$ref":"#/components/schemas/StageName"},{"description":"Optional name that can be specified for the stage being created."}]},"participantTokenConfigurations":{"allOf":[{"$ref":"#/components/schemas/ParticipantTokenConfigurations"},{"description":"Array of participant token configuration objects to attach to the new stage."}]},"tags":{"allOf":[{"$ref":"#/components/schemas/Tags"},{"description":"Tags attached to the resource. Array of maps, each of the form <code>string:string (key:value)</code>. See <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html\">Tagging AWS Resources</a> for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there. "}]}}},"ParticipantTokenList":{"type":"array","items":{"$ref":"#/components/schemas/ParticipantToken"}},"Stage":{"type":"object","required":["arn"],"properties":{"activeSessionId":{"allOf":[{"$ref":"#/components/schemas/StageSessionId"},{"description":"ID of the active session within the stage."}]},"arn":{"allOf":[{"$ref":"#/components/schemas/StageArn"},{"description":"Stage ARN."}]},"name":{"allOf":[{"$ref":"#/components/schemas/StageName"},{"description":"Stage name."}]},"tags":{"allOf":[{"$ref":"#/components/schemas/Tags"},{"description":"Tags attached to the resource. Array of maps, each of the form <code>string:string (key:value)</code>. See <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html\">Tagging AWS Resources</a> for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there."}]}},"description":"Object specifying a stage."},"DeleteStageRequest":{"type":"object","required":["arn"],"title":"DeleteStageRequest","properties":{"arn":{"allOf":[{"$ref":"#/components/schemas/StageArn"},{"description":"ARN of the stage to be deleted."}]}}},"DisconnectParticipantReason":{"type":"string","minLength":0,"maxLength":128},"ParticipantTokenId":{"type":"string"},"DisconnectParticipantRequest":{"type":"object","required":["participantId","stageArn"],"title":"DisconnectParticipantRequest","properties":{"participantId":{"allOf":[{"$ref":"#/components/schemas/ParticipantTokenId"},{"description":"Identifier of the participant to be disconnected. This is assigned by IVS and returned by <a>CreateParticipantToken</a>."}]},"reason":{"allOf":[{"$ref":"#/components/schemas/DisconnectParticipantReason"},{"description":"Description of why this participant is being disconnected."}]},"stageArn":{"allOf":[{"$ref":"#/components/schemas/StageArn"},{"description":"ARN of the stage to which the participant is attached."}]}}},"EventErrorCode":{"type":"string","enum":["INSUFFICIENT_CAPABILITIES","QUOTA_EXCEEDED","PUBLISHER_NOT_FOUND"]},"Time":{"type":"string","format":"date-time"},"EventName":{"type":"string","enum":["JOINED","LEFT","PUBLISH_STARTED","PUBLISH_STOPPED","SUBSCRIBE_STARTED","SUBSCRIBE_STOPPED","PUBLISH_ERROR","SUBSCRIBE_ERROR","JOIN_ERROR"]},"ParticipantId":{"type":"string"},"Event":{"type":"object","properties":{"errorCode":{"allOf":[{"$ref":"#/components/schemas/EventErrorCode"},{"description":"If the event is an error event, the error code is provided to give insight into the specific error that occurred. If the event is not an error event, this field is null. <code>INSUFFICIENT_CAPABILITIES</code> indicates that the participant tried to take an action that the participant’s token is not allowed to do. For more information about participant capabilities, see the <code>capabilities</code> field in <a>CreateParticipantToken</a>. <code>QUOTA_EXCEEDED</code> indica