Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

UpdateAdConfiguration

Updates a specified ad configuration.

Request Syntax


POST /UpdateAdConfiguration HTTP/1.1
Content-type: application/json

{
   "arn": "string",
   "mediaTailorPlaybackConfigurations": [ 
      { 
         "playbackConfigurationArn": "string"
      }
   ],
   "name": "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 ad configuration to be updated.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 128.

Pattern: arn:aws:ivs:[a-z0-9-]+:[0-9]+:ad-configuration/[a-zA-Z0-9-]+

Required: Yes

mediaTailorPlaybackConfigurations

List of integration configurations with MediaTailor resources. The first item in the list is the default playback configuration used for the ad configuration. To select a different configuration per viewing session, see Generate and Sign IVS Playback Tokens.

Type: Array of MediaTailorPlaybackConfiguration objects

Array Members: Minimum number of 1 item. Maximum number of 3 items.

Required: No

name

Ad configuration name. The value does not need to be unique.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 128.

Pattern: [a-zA-Z0-9-_]*

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "adConfiguration": { 
      "arn": "string",
      "mediaTailorPlaybackConfigurations": [ 
         { 
            "playbackConfigurationArn": "string"
         }
      ],
      "name": "string",
      "tags": { 
         "string" : "string" 
      }
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

adConfiguration

Object specifying the updated ad configuration.

Type: AdConfiguration object

Errors

For information about the errors that are common to all actions, see Common Error Types.

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

PendingVerification

accessControlAllowOrigin
accessControlExposeHeaders
cacheControl
contentSecurityPolicy
exceptionMessage: Your account is pending verification.
strictTransportSecurity
xAmznErrorType
xContentTypeOptions
xFrameOptions

HTTP Status Code: 403

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

ThrottlingException

accessControlAllowOrigin
accessControlExposeHeaders
cacheControl
contentSecurityPolicy
exceptionMessage: Request was denied due to request throttling.
strictTransportSecurity
xAmznErrorType
xContentTypeOptions
xFrameOptions

HTTP Status Code: 429

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