StopComposition
Stops and deletes a Composition resource. Any broadcast from the Composition resource is stopped.
Request Syntax
POST /StopComposition HTTP/1.1
Content-type: application/json
{
"arn": "string"
}URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- arn
-
ARN of the Composition.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
arn:aws:ivs:[a-z0-9-]+:[0-9]+:composition/[a-zA-Z0-9-]+Required: Yes
Response Syntax
HTTP/1.1 200
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
- accessControlAllowOrigin
- accessControlExposeHeaders
- cacheControl
- contentSecurityPolicy
- exceptionMessage
-
User does not have sufficient access to perform this action.
- strictTransportSecurity
- xAmznErrorType
- xContentTypeOptions
- xFrameOptions
HTTP Status Code: 403
- ConflictException
-
- accessControlAllowOrigin
- accessControlExposeHeaders
- cacheControl
- contentSecurityPolicy
- exceptionMessage
-
Updating or deleting a resource can cause an inconsistent state.
- strictTransportSecurity
- xAmznErrorType
- xContentTypeOptions
- xFrameOptions
HTTP Status Code: 409
- InternalServerException
-
- accessControlAllowOrigin
- accessControlExposeHeaders
- cacheControl
- contentSecurityPolicy
- exceptionMessage
-
Unexpected error during processing of request.
- strictTransportSecurity
- xAmznErrorType
- xContentTypeOptions
- xFrameOptions
HTTP Status Code: 500
- ResourceNotFoundException
-
- accessControlAllowOrigin
- accessControlExposeHeaders
- cacheControl
- contentSecurityPolicy
- exceptionMessage
-
Request references a resource which does not exist.
- strictTransportSecurity
- xAmznErrorType
- xContentTypeOptions
- xFrameOptions
HTTP Status Code: 404
- ServiceQuotaExceededException
-
- accessControlAllowOrigin
- accessControlExposeHeaders
- cacheControl
- contentSecurityPolicy
- exceptionMessage
-
Request would cause a service quota to be exceeded.
- strictTransportSecurity
- xAmznErrorType
- xContentTypeOptions
- xFrameOptions
HTTP Status Code: 402
- ValidationException
-
- accessControlAllowOrigin
- accessControlExposeHeaders
- cacheControl
- contentSecurityPolicy
- exceptionMessage
-
The input fails to satisfy the constraints specified by an AWS service.
- strictTransportSecurity
- xAmznErrorType
- xContentTypeOptions
- xFrameOptions
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
