AWSKinesisVideo

@interface AWSKinesisVideo

  • The service configuration used to instantiate this service client.

    Warning

    Once the client is instantiated, do not modify the configuration object. It may cause unspecified behaviors.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) AWSServiceConfiguration *configuration

    Swift

    var configuration: UnsafeMutablePointer<Int32> { get }
  • Returns the singleton service client. If the singleton object does not exist, the SDK instantiates the default service client with defaultServiceConfiguration from [AWSServiceManager defaultServiceManager]. The reference to this object is maintained by the SDK, and you do not need to retain it manually.

    For example, set the default service configuration in - application:didFinishLaunchingWithOptions:

    Swift

    func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
       let credentialProvider = AWSCognitoCredentialsProvider(regionType: .USEast1, identityPoolId: "YourIdentityPoolId")
       let configuration = AWSServiceConfiguration(region: .USEast1, credentialsProvider: credentialProvider)
       AWSServiceManager.default().defaultServiceConfiguration = configuration
    
       return true
    

    }

    Objective-C

    - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
         AWSCognitoCredentialsProvider *credentialsProvider = [[AWSCognitoCredentialsProvider alloc] initWithRegionType:AWSRegionUSEast1
                                                                                                         identityPoolId:@"YourIdentityPoolId"];
         AWSServiceConfiguration *configuration = [[AWSServiceConfiguration alloc] initWithRegion:AWSRegionUSEast1
                                                                              credentialsProvider:credentialsProvider];
         [AWSServiceManager defaultServiceManager].defaultServiceConfiguration = configuration;
    
         return YES;
     }
    

    Then call the following to get the default service client:

    Swift

    let KinesisVideo = AWSKinesisVideo.default()
    

    Objective-C

    AWSKinesisVideo *KinesisVideo = [AWSKinesisVideo defaultKinesisVideo];
    

    Declaration

    Objective-C

    + (nonnull instancetype)defaultKinesisVideo;

    Swift

    class func `default`() -> Self

    Return Value

    The default service client.

  • Creates a service client with the given service configuration and registers it for the key.

    For example, set the default service configuration in - application:didFinishLaunchingWithOptions:

    Swift

    func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
       let credentialProvider = AWSCognitoCredentialsProvider(regionType: .USEast1, identityPoolId: "YourIdentityPoolId")
       let configuration = AWSServiceConfiguration(region: .USWest2, credentialsProvider: credentialProvider)
       AWSKinesisVideo.register(with: configuration!, forKey: "USWest2KinesisVideo")
    
       return true
    

    }

    Objective-C

    - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
        AWSCognitoCredentialsProvider *credentialsProvider = [[AWSCognitoCredentialsProvider alloc] initWithRegionType:AWSRegionUSEast1
                                                                                                        identityPoolId:@"YourIdentityPoolId"];
        AWSServiceConfiguration *configuration = [[AWSServiceConfiguration alloc] initWithRegion:AWSRegionUSWest2
                                                                             credentialsProvider:credentialsProvider];
    
        [AWSKinesisVideo registerKinesisVideoWithConfiguration:configuration forKey:@"USWest2KinesisVideo"];
    
        return YES;
    }
    

    Then call the following to get the service client:

    Swift

    let KinesisVideo = AWSKinesisVideo(forKey: "USWest2KinesisVideo")
    

    Objective-C

    AWSKinesisVideo *KinesisVideo = [AWSKinesisVideo KinesisVideoForKey:@"USWest2KinesisVideo"];
    

    Warning

    After calling this method, do not modify the configuration object. It may cause unspecified behaviors.

    Declaration

    Objective-C

    + (void)registerKinesisVideoWithConfiguration:(id)configuration
                                           forKey:(nonnull NSString *)key;

    Swift

    class func register(withConfiguration configuration: Any!, forKey key: String)

    Parameters

    configuration

    A service configuration object.

    key

    A string to identify the service client.

  • Retrieves the service client associated with the key. You need to call + registerKinesisVideoWithConfiguration:forKey: before invoking this method.

    For example, set the default service configuration in - application:didFinishLaunchingWithOptions:

    Swift

    func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
       let credentialProvider = AWSCognitoCredentialsProvider(regionType: .USEast1, identityPoolId: "YourIdentityPoolId")
       let configuration = AWSServiceConfiguration(region: .USWest2, credentialsProvider: credentialProvider)
       AWSKinesisVideo.register(with: configuration!, forKey: "USWest2KinesisVideo")
    
       return true
    

    }

    Objective-C

    - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
        AWSCognitoCredentialsProvider *credentialsProvider = [[AWSCognitoCredentialsProvider alloc] initWithRegionType:AWSRegionUSEast1
                                                                                                        identityPoolId:@"YourIdentityPoolId"];
        AWSServiceConfiguration *configuration = [[AWSServiceConfiguration alloc] initWithRegion:AWSRegionUSWest2
                                                                             credentialsProvider:credentialsProvider];
    
        [AWSKinesisVideo registerKinesisVideoWithConfiguration:configuration forKey:@"USWest2KinesisVideo"];
    
        return YES;
    }
    

    Then call the following to get the service client:

    Swift

    let KinesisVideo = AWSKinesisVideo(forKey: "USWest2KinesisVideo")
    

    Objective-C

    AWSKinesisVideo *KinesisVideo = [AWSKinesisVideo KinesisVideoForKey:@"USWest2KinesisVideo"];
    

    Declaration

    Objective-C

    + (nonnull instancetype)KinesisVideoForKey:(nonnull NSString *)key;

    Swift

    convenience init(forKey key: String)

    Parameters

    key

    A string to identify the service client.

    Return Value

    An instance of the service client.

  • Removes the service client associated with the key and release it.

    Warning

    Before calling this method, make sure no method is running on this client.

    Declaration

    Objective-C

    + (void)removeKinesisVideoForKey:(nonnull NSString *)key;

    Swift

    class func remove(forKey key: String)

    Parameters

    key

    A string to identify the service client.

  • Creates a signaling channel.

    CreateSignalingChannel is an asynchronous operation.

    See

    AWSKinesisVideoCreateSignalingChannelInput

    See

    AWSKinesisVideoCreateSignalingChannelOutput

    Declaration

    Objective-C

    - (id)createSignalingChannel:
        (nonnull AWSKinesisVideoCreateSignalingChannelInput *)request;

    Swift

    func createSignalingChannel(_ request: AWSKinesisVideoCreateSignalingChannelInput) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the CreateSignalingChannel service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSKinesisVideoCreateSignalingChannelOutput. On failed execution, task.error may contain an NSError with AWSKinesisVideoErrorDomain domain and the following error code: AWSKinesisVideoErrorInvalidArgument, AWSKinesisVideoErrorClientLimitExceeded, AWSKinesisVideoErrorAccountChannelLimitExceeded, AWSKinesisVideoErrorResourceInUse, AWSKinesisVideoErrorAccessDenied, AWSKinesisVideoErrorTagsPerResourceExceededLimit.

  • Creates a signaling channel.

    CreateSignalingChannel is an asynchronous operation.

    See

    AWSKinesisVideoCreateSignalingChannelInput

    See

    AWSKinesisVideoCreateSignalingChannelOutput

    Declaration

    Objective-C

    - (void)createSignalingChannel:
                (nonnull AWSKinesisVideoCreateSignalingChannelInput *)request
                 completionHandler:
                     (void (^_Nullable)(
                         AWSKinesisVideoCreateSignalingChannelOutput *_Nullable,
                         NSError *_Nullable))completionHandler;

    Swift

    func createSignalingChannel(_ request: AWSKinesisVideoCreateSignalingChannelInput, completionHandler: ((AWSKinesisVideoCreateSignalingChannelOutput?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the CreateSignalingChannel service method.

    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSKinesisVideoErrorDomain domain and the following error code: AWSKinesisVideoErrorInvalidArgument, AWSKinesisVideoErrorClientLimitExceeded, AWSKinesisVideoErrorAccountChannelLimitExceeded, AWSKinesisVideoErrorResourceInUse, AWSKinesisVideoErrorAccessDenied, AWSKinesisVideoErrorTagsPerResourceExceededLimit.

  • Creates a new Kinesis video stream.

    When you create a new stream, Kinesis Video Streams assigns it a version number. When you change the stream’s metadata, Kinesis Video Streams updates the version.

    CreateStream is an asynchronous operation.

    For information about how the service works, see How it Works.

    You must have permissions for the KinesisVideo:CreateStream action.

    See

    AWSKinesisVideoCreateStreamInput

    See

    AWSKinesisVideoCreateStreamOutput

    Declaration

    Objective-C

    - (id)createStream:(nonnull AWSKinesisVideoCreateStreamInput *)request;

    Swift

    func createStream(_ request: AWSKinesisVideoCreateStreamInput) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the CreateStream service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSKinesisVideoCreateStreamOutput. On failed execution, task.error may contain an NSError with AWSKinesisVideoErrorDomain domain and the following error code: AWSKinesisVideoErrorAccountStreamLimitExceeded, AWSKinesisVideoErrorDeviceStreamLimitExceeded, AWSKinesisVideoErrorResourceInUse, AWSKinesisVideoErrorInvalidDevice, AWSKinesisVideoErrorInvalidArgument, AWSKinesisVideoErrorClientLimitExceeded, AWSKinesisVideoErrorTagsPerResourceExceededLimit.

  • Creates a new Kinesis video stream.

    When you create a new stream, Kinesis Video Streams assigns it a version number. When you change the stream’s metadata, Kinesis Video Streams updates the version.

    CreateStream is an asynchronous operation.

    For information about how the service works, see How it Works.

    You must have permissions for the KinesisVideo:CreateStream action.

    See

    AWSKinesisVideoCreateStreamInput

    See

    AWSKinesisVideoCreateStreamOutput

    Declaration

    Objective-C

    - (void)createStream:(nonnull AWSKinesisVideoCreateStreamInput *)request
        completionHandler:
            (void (^_Nullable)(AWSKinesisVideoCreateStreamOutput *_Nullable,
                               NSError *_Nullable))completionHandler;

    Swift

    func createStream(_ request: AWSKinesisVideoCreateStreamInput, completionHandler: ((AWSKinesisVideoCreateStreamOutput?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the CreateStream service method.

    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSKinesisVideoErrorDomain domain and the following error code: AWSKinesisVideoErrorAccountStreamLimitExceeded, AWSKinesisVideoErrorDeviceStreamLimitExceeded, AWSKinesisVideoErrorResourceInUse, AWSKinesisVideoErrorInvalidDevice, AWSKinesisVideoErrorInvalidArgument, AWSKinesisVideoErrorClientLimitExceeded, AWSKinesisVideoErrorTagsPerResourceExceededLimit.

  • Deletes a specified signaling channel. DeleteSignalingChannel is an asynchronous operation. If you don’t specify the channel’s current version, the most recent version is deleted.

    See

    AWSKinesisVideoDeleteSignalingChannelInput

    See

    AWSKinesisVideoDeleteSignalingChannelOutput

    Declaration

    Objective-C

    - (id)deleteSignalingChannel:
        (nonnull AWSKinesisVideoDeleteSignalingChannelInput *)request;

    Swift

    func deleteSignalingChannel(_ request: AWSKinesisVideoDeleteSignalingChannelInput) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the DeleteSignalingChannel service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSKinesisVideoDeleteSignalingChannelOutput. On failed execution, task.error may contain an NSError with AWSKinesisVideoErrorDomain domain and the following error code: AWSKinesisVideoErrorInvalidArgument, AWSKinesisVideoErrorClientLimitExceeded, AWSKinesisVideoErrorResourceNotFound, AWSKinesisVideoErrorAccessDenied, AWSKinesisVideoErrorVersionMismatch.

  • Deletes a specified signaling channel. DeleteSignalingChannel is an asynchronous operation. If you don’t specify the channel’s current version, the most recent version is deleted.

    See

    AWSKinesisVideoDeleteSignalingChannelInput

    See

    AWSKinesisVideoDeleteSignalingChannelOutput

    Declaration

    Objective-C

    - (void)deleteSignalingChannel:
                (nonnull AWSKinesisVideoDeleteSignalingChannelInput *)request
                 completionHandler:
                     (void (^_Nullable)(
                         AWSKinesisVideoDeleteSignalingChannelOutput *_Nullable,
                         NSError *_Nullable))completionHandler;

    Swift

    func deleteSignalingChannel(_ request: AWSKinesisVideoDeleteSignalingChannelInput, completionHandler: ((AWSKinesisVideoDeleteSignalingChannelOutput?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the DeleteSignalingChannel service method.

    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSKinesisVideoErrorDomain domain and the following error code: AWSKinesisVideoErrorInvalidArgument, AWSKinesisVideoErrorClientLimitExceeded, AWSKinesisVideoErrorResourceNotFound, AWSKinesisVideoErrorAccessDenied, AWSKinesisVideoErrorVersionMismatch.

  • Deletes a Kinesis video stream and the data contained in the stream.

    This method marks the stream for deletion, and makes the data in the stream inaccessible immediately.

    To ensure that you have the latest version of the stream before deleting it, you can specify the stream version. Kinesis Video Streams assigns a version to each stream. When you update a stream, Kinesis Video Streams assigns a new version number. To get the latest stream version, use the DescribeStream API.

    This operation requires permission for the KinesisVideo:DeleteStream action.

    See

    AWSKinesisVideoDeleteStreamInput

    See

    AWSKinesisVideoDeleteStreamOutput

    Declaration

    Objective-C

    - (id)deleteStream:(nonnull AWSKinesisVideoDeleteStreamInput *)request;

    Swift

    func deleteStream(_ request: AWSKinesisVideoDeleteStreamInput) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the DeleteStream service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSKinesisVideoDeleteStreamOutput. On failed execution, task.error may contain an NSError with AWSKinesisVideoErrorDomain domain and the following error code: AWSKinesisVideoErrorClientLimitExceeded, AWSKinesisVideoErrorInvalidArgument, AWSKinesisVideoErrorResourceNotFound, AWSKinesisVideoErrorNotAuthorized, AWSKinesisVideoErrorVersionMismatch.

  • Deletes a Kinesis video stream and the data contained in the stream.

    This method marks the stream for deletion, and makes the data in the stream inaccessible immediately.

    To ensure that you have the latest version of the stream before deleting it, you can specify the stream version. Kinesis Video Streams assigns a version to each stream. When you update a stream, Kinesis Video Streams assigns a new version number. To get the latest stream version, use the DescribeStream API.

    This operation requires permission for the KinesisVideo:DeleteStream action.

    See

    AWSKinesisVideoDeleteStreamInput

    See

    AWSKinesisVideoDeleteStreamOutput

    Declaration

    Objective-C

    - (void)deleteStream:(nonnull AWSKinesisVideoDeleteStreamInput *)request
        completionHandler:
            (void (^_Nullable)(AWSKinesisVideoDeleteStreamOutput *_Nullable,
                               NSError *_Nullable))completionHandler;

    Swift

    func deleteStream(_ request: AWSKinesisVideoDeleteStreamInput, completionHandler: ((AWSKinesisVideoDeleteStreamOutput?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the DeleteStream service method.

    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSKinesisVideoErrorDomain domain and the following error code: AWSKinesisVideoErrorClientLimitExceeded, AWSKinesisVideoErrorInvalidArgument, AWSKinesisVideoErrorResourceNotFound, AWSKinesisVideoErrorNotAuthorized, AWSKinesisVideoErrorVersionMismatch.

  • Returns the most current information about the signaling channel. You must specify either the name or the ARN of the channel that you want to describe.

    See

    AWSKinesisVideoDescribeSignalingChannelInput

    See

    AWSKinesisVideoDescribeSignalingChannelOutput

    Declaration

    Objective-C

    - (id)describeSignalingChannel:
        (nonnull AWSKinesisVideoDescribeSignalingChannelInput *)request;

    Swift

    func describeSignalingChannel(_ request: AWSKinesisVideoDescribeSignalingChannelInput) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the DescribeSignalingChannel service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSKinesisVideoDescribeSignalingChannelOutput. On failed execution, task.error may contain an NSError with AWSKinesisVideoErrorDomain domain and the following error code: AWSKinesisVideoErrorInvalidArgument, AWSKinesisVideoErrorClientLimitExceeded, AWSKinesisVideoErrorResourceNotFound, AWSKinesisVideoErrorAccessDenied.

  • Returns the most current information about the signaling channel. You must specify either the name or the ARN of the channel that you want to describe.

    See

    AWSKinesisVideoDescribeSignalingChannelInput

    See

    AWSKinesisVideoDescribeSignalingChannelOutput

    Declaration

    Objective-C

    - (void)describeSignalingChannel:
                (nonnull AWSKinesisVideoDescribeSignalingChannelInput *)request
                   completionHandler:
                       (void (^_Nullable)(
                           AWSKinesisVideoDescribeSignalingChannelOutput *_Nullable,
                           NSError *_Nullable))completionHandler;

    Swift

    func describeSignalingChannel(_ request: AWSKinesisVideoDescribeSignalingChannelInput, completionHandler: ((AWSKinesisVideoDescribeSignalingChannelOutput?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the DescribeSignalingChannel service method.

    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSKinesisVideoErrorDomain domain and the following error code: AWSKinesisVideoErrorInvalidArgument, AWSKinesisVideoErrorClientLimitExceeded, AWSKinesisVideoErrorResourceNotFound, AWSKinesisVideoErrorAccessDenied.

  • Returns the most current information about the specified stream. You must specify either the StreamName or the StreamARN.

    See

    AWSKinesisVideoDescribeStreamInput

    See

    AWSKinesisVideoDescribeStreamOutput

    Declaration

    Objective-C

    - (id)describeStream:(nonnull AWSKinesisVideoDescribeStreamInput *)request;

    Swift

    func describeStream(_ request: AWSKinesisVideoDescribeStreamInput) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the DescribeStream service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSKinesisVideoDescribeStreamOutput. On failed execution, task.error may contain an NSError with AWSKinesisVideoErrorDomain domain and the following error code: AWSKinesisVideoErrorInvalidArgument, AWSKinesisVideoErrorResourceNotFound, AWSKinesisVideoErrorClientLimitExceeded, AWSKinesisVideoErrorNotAuthorized.

  • Returns the most current information about the specified stream. You must specify either the StreamName or the StreamARN.

    See

    AWSKinesisVideoDescribeStreamInput

    See

    AWSKinesisVideoDescribeStreamOutput

    Declaration

    Objective-C

    - (void)describeStream:(nonnull AWSKinesisVideoDescribeStreamInput *)request
         completionHandler:
             (void (^_Nullable)(AWSKinesisVideoDescribeStreamOutput *_Nullable,
                                NSError *_Nullable))completionHandler;

    Swift

    func describeStream(_ request: AWSKinesisVideoDescribeStreamInput, completionHandler: ((AWSKinesisVideoDescribeStreamOutput?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the DescribeStream service method.

    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSKinesisVideoErrorDomain domain and the following error code: AWSKinesisVideoErrorInvalidArgument, AWSKinesisVideoErrorResourceNotFound, AWSKinesisVideoErrorClientLimitExceeded, AWSKinesisVideoErrorNotAuthorized.

  • Gets an endpoint for a specified stream for either reading or writing. Use this endpoint in your application to read from the specified stream (using the GetMedia or GetMediaForFragmentList operations) or write to it (using the PutMedia operation).

    The returned endpoint does not have the API name appended. The client needs to add the API name to the returned endpoint.

    In the request, specify the stream either by StreamName or StreamARN.

    See

    AWSKinesisVideoGetDataEndpointInput

    See

    AWSKinesisVideoGetDataEndpointOutput

    Declaration

    Objective-C

    - (id)getDataEndpoint:(nonnull AWSKinesisVideoGetDataEndpointInput *)request;

    Swift

    func getDataEndpoint(_ request: AWSKinesisVideoGetDataEndpointInput) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the GetDataEndpoint service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSKinesisVideoGetDataEndpointOutput. On failed execution, task.error may contain an NSError with AWSKinesisVideoErrorDomain domain and the following error code: AWSKinesisVideoErrorInvalidArgument, AWSKinesisVideoErrorResourceNotFound, AWSKinesisVideoErrorClientLimitExceeded, AWSKinesisVideoErrorNotAuthorized.

  • Gets an endpoint for a specified stream for either reading or writing. Use this endpoint in your application to read from the specified stream (using the GetMedia or GetMediaForFragmentList operations) or write to it (using the PutMedia operation).

    The returned endpoint does not have the API name appended. The client needs to add the API name to the returned endpoint.

    In the request, specify the stream either by StreamName or StreamARN.

    See

    AWSKinesisVideoGetDataEndpointInput

    See

    AWSKinesisVideoGetDataEndpointOutput

    Declaration

    Objective-C

    - (void)getDataEndpoint:(nonnull AWSKinesisVideoGetDataEndpointInput *)request
          completionHandler:
              (void (^_Nullable)(AWSKinesisVideoGetDataEndpointOutput *_Nullable,
                                 NSError *_Nullable))completionHandler;

    Swift

    func getDataEndpoint(_ request: AWSKinesisVideoGetDataEndpointInput, completionHandler: ((AWSKinesisVideoGetDataEndpointOutput?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the GetDataEndpoint service method.

    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSKinesisVideoErrorDomain domain and the following error code: AWSKinesisVideoErrorInvalidArgument, AWSKinesisVideoErrorResourceNotFound, AWSKinesisVideoErrorClientLimitExceeded, AWSKinesisVideoErrorNotAuthorized.

  • Provides an endpoint for the specified signaling channel to send and receive messages. This API uses the SingleMasterChannelEndpointConfiguration input parameter, which consists of the Protocols and Role properties.

    Protocols is used to determine the communication mechanism. For example, specifying WSS as the protocol, results in this API producing a secure websocket endpoint, and specifying HTTPS as the protocol, results in this API generating an HTTPS endpoint.

    Role determines the messaging permissions. A MASTER role results in this API generating an endpoint that a client can use to communicate with any of the viewers on the channel. A VIEWER role results in this API generating an endpoint that a client can use to communicate only with a MASTER.

    See

    AWSKinesisVideoGetSignalingChannelEndpointInput

    See

    AWSKinesisVideoGetSignalingChannelEndpointOutput

    Declaration

    Objective-C

    - (id)getSignalingChannelEndpoint:
        (nonnull AWSKinesisVideoGetSignalingChannelEndpointInput *)request;

    Swift

    func getSignalingChannelEndpoint(_ request: AWSKinesisVideoGetSignalingChannelEndpointInput) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the GetSignalingChannelEndpoint service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSKinesisVideoGetSignalingChannelEndpointOutput. On failed execution, task.error may contain an NSError with AWSKinesisVideoErrorDomain domain and the following error code: AWSKinesisVideoErrorInvalidArgument, AWSKinesisVideoErrorClientLimitExceeded, AWSKinesisVideoErrorResourceNotFound, AWSKinesisVideoErrorResourceInUse, AWSKinesisVideoErrorAccessDenied.

  • Provides an endpoint for the specified signaling channel to send and receive messages. This API uses the SingleMasterChannelEndpointConfiguration input parameter, which consists of the Protocols and Role properties.

    Protocols is used to determine the communication mechanism. For example, specifying WSS as the protocol, results in this API producing a secure websocket endpoint, and specifying HTTPS as the protocol, results in this API generating an HTTPS endpoint.

    Role determines the messaging permissions. A MASTER role results in this API generating an endpoint that a client can use to communicate with any of the viewers on the channel. A VIEWER role results in this API generating an endpoint that a client can use to communicate only with a MASTER.

    See

    AWSKinesisVideoGetSignalingChannelEndpointInput

    See

    AWSKinesisVideoGetSignalingChannelEndpointOutput

    Declaration

    Objective-C

    - (void)getSignalingChannelEndpoint:
                (nonnull AWSKinesisVideoGetSignalingChannelEndpointInput *)request
                      completionHandler:
                          (void (^_Nullable)(
                              AWSKinesisVideoGetSignalingChannelEndpointOutput
                                  *_Nullable,
                              NSError *_Nullable))completionHandler;

    Swift

    func getSignalingChannelEndpoint(_ request: AWSKinesisVideoGetSignalingChannelEndpointInput, completionHandler: ((AWSKinesisVideoGetSignalingChannelEndpointOutput?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the GetSignalingChannelEndpoint service method.

    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSKinesisVideoErrorDomain domain and the following error code: AWSKinesisVideoErrorInvalidArgument, AWSKinesisVideoErrorClientLimitExceeded, AWSKinesisVideoErrorResourceNotFound, AWSKinesisVideoErrorResourceInUse, AWSKinesisVideoErrorAccessDenied.

  • Returns an array of ChannelInfo objects. Each object describes a signaling channel. To retrieve only those channels that satisfy a specific condition, you can specify a ChannelNameCondition.

    See

    AWSKinesisVideoListSignalingChannelsInput

    See

    AWSKinesisVideoListSignalingChannelsOutput

    Declaration

    Objective-C

    - (id)listSignalingChannels:
        (nonnull AWSKinesisVideoListSignalingChannelsInput *)request;

    Swift

    func listSignalingChannels(_ request: AWSKinesisVideoListSignalingChannelsInput) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the ListSignalingChannels service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSKinesisVideoListSignalingChannelsOutput. On failed execution, task.error may contain an NSError with AWSKinesisVideoErrorDomain domain and the following error code: AWSKinesisVideoErrorInvalidArgument, AWSKinesisVideoErrorClientLimitExceeded, AWSKinesisVideoErrorAccessDenied.

  • Returns an array of ChannelInfo objects. Each object describes a signaling channel. To retrieve only those channels that satisfy a specific condition, you can specify a ChannelNameCondition.

    See

    AWSKinesisVideoListSignalingChannelsInput

    See

    AWSKinesisVideoListSignalingChannelsOutput

    Declaration

    Objective-C

    - (void)listSignalingChannels:
                (nonnull AWSKinesisVideoListSignalingChannelsInput *)request
                completionHandler:
                    (void (^_Nullable)(
                        AWSKinesisVideoListSignalingChannelsOutput *_Nullable,
                        NSError *_Nullable))completionHandler;

    Swift

    func listSignalingChannels(_ request: AWSKinesisVideoListSignalingChannelsInput, completionHandler: ((AWSKinesisVideoListSignalingChannelsOutput?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the ListSignalingChannels service method.

    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSKinesisVideoErrorDomain domain and the following error code: AWSKinesisVideoErrorInvalidArgument, AWSKinesisVideoErrorClientLimitExceeded, AWSKinesisVideoErrorAccessDenied.

  • Returns an array of StreamInfo objects. Each object describes a stream. To retrieve only streams that satisfy a specific condition, you can specify a StreamNameCondition.

    See

    AWSKinesisVideoListStreamsInput

    See

    AWSKinesisVideoListStreamsOutput

    Declaration

    Objective-C

    - (id)listStreams:(nonnull AWSKinesisVideoListStreamsInput *)request;

    Swift

    func listStreams(_ request: AWSKinesisVideoListStreamsInput) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the ListStreams service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSKinesisVideoListStreamsOutput. On failed execution, task.error may contain an NSError with AWSKinesisVideoErrorDomain domain and the following error code: AWSKinesisVideoErrorClientLimitExceeded, AWSKinesisVideoErrorInvalidArgument.

  • Returns an array of StreamInfo objects. Each object describes a stream. To retrieve only streams that satisfy a specific condition, you can specify a StreamNameCondition.

    See

    AWSKinesisVideoListStreamsInput

    See

    AWSKinesisVideoListStreamsOutput

    Declaration

    Objective-C

    - (void)listStreams:(nonnull AWSKinesisVideoListStreamsInput *)request
        completionHandler:
            (void (^_Nullable)(AWSKinesisVideoListStreamsOutput *_Nullable,
                               NSError *_Nullable))completionHandler;

    Swift

    func listStreams(_ request: AWSKinesisVideoListStreamsInput, completionHandler: ((AWSKinesisVideoListStreamsOutput?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the ListStreams service method.

    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSKinesisVideoErrorDomain domain and the following error code: AWSKinesisVideoErrorClientLimitExceeded, AWSKinesisVideoErrorInvalidArgument.

  • Returns a list of tags associated with the specified signaling channel.

    See

    AWSKinesisVideoListTagsForResourceInput

    See

    AWSKinesisVideoListTagsForResourceOutput

    Declaration

    Objective-C

    - (id)listTagsForResource:
        (nonnull AWSKinesisVideoListTagsForResourceInput *)request;

    Swift

    func listTags(forResource request: AWSKinesisVideoListTagsForResourceInput) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the ListTagsForResource service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSKinesisVideoListTagsForResourceOutput. On failed execution, task.error may contain an NSError with AWSKinesisVideoErrorDomain domain and the following error code: AWSKinesisVideoErrorInvalidArgument, AWSKinesisVideoErrorClientLimitExceeded, AWSKinesisVideoErrorResourceNotFound, AWSKinesisVideoErrorAccessDenied.

  • Returns a list of tags associated with the specified signaling channel.

    See

    AWSKinesisVideoListTagsForResourceInput

    See

    AWSKinesisVideoListTagsForResourceOutput

    Declaration

    Objective-C

    - (void)listTagsForResource:
                (nonnull AWSKinesisVideoListTagsForResourceInput *)request
              completionHandler:
                  (void (^_Nullable)(
                      AWSKinesisVideoListTagsForResourceOutput *_Nullable,
                      NSError *_Nullable))completionHandler;

    Swift

    func listTags(forResource request: AWSKinesisVideoListTagsForResourceInput, completionHandler: ((AWSKinesisVideoListTagsForResourceOutput?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the ListTagsForResource service method.

    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSKinesisVideoErrorDomain domain and the following error code: AWSKinesisVideoErrorInvalidArgument, AWSKinesisVideoErrorClientLimitExceeded, AWSKinesisVideoErrorResourceNotFound, AWSKinesisVideoErrorAccessDenied.

  • Returns a list of tags associated with the specified stream.

    In the request, you must specify either the StreamName or the StreamARN.

    See

    AWSKinesisVideoListTagsForStreamInput

    See

    AWSKinesisVideoListTagsForStreamOutput

    Declaration

    Objective-C

    - (id)listTagsForStream:
        (nonnull AWSKinesisVideoListTagsForStreamInput *)request;

    Swift

    func listTags(forStream request: AWSKinesisVideoListTagsForStreamInput) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the ListTagsForStream service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSKinesisVideoListTagsForStreamOutput. On failed execution, task.error may contain an NSError with AWSKinesisVideoErrorDomain domain and the following error code: AWSKinesisVideoErrorClientLimitExceeded, AWSKinesisVideoErrorInvalidArgument, AWSKinesisVideoErrorResourceNotFound, AWSKinesisVideoErrorNotAuthorized, AWSKinesisVideoErrorInvalidResourceFormat.

  • Returns a list of tags associated with the specified stream.

    In the request, you must specify either the StreamName or the StreamARN.

    See

    AWSKinesisVideoListTagsForStreamInput

    See

    AWSKinesisVideoListTagsForStreamOutput

    Declaration

    Objective-C

    - (void)
        listTagsForStream:(nonnull AWSKinesisVideoListTagsForStreamInput *)request
        completionHandler:
            (void (^_Nullable)(AWSKinesisVideoListTagsForStreamOutput *_Nullable,
                               NSError *_Nullable))completionHandler;

    Swift

    func listTags(forStream request: AWSKinesisVideoListTagsForStreamInput, completionHandler: ((AWSKinesisVideoListTagsForStreamOutput?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the ListTagsForStream service method.

    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSKinesisVideoErrorDomain domain and the following error code: AWSKinesisVideoErrorClientLimitExceeded, AWSKinesisVideoErrorInvalidArgument, AWSKinesisVideoErrorResourceNotFound, AWSKinesisVideoErrorNotAuthorized, AWSKinesisVideoErrorInvalidResourceFormat.

  • Adds one or more tags to a signaling channel. A tag is a key-value pair (the value is optional) that you can define and assign to AWS resources. If you specify a tag that already exists, the tag value is replaced with the value that you specify in the request. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.

    See

    AWSKinesisVideoTagResourceInput

    See

    AWSKinesisVideoTagResourceOutput

    Declaration

    Objective-C

    - (id)tagResource:(nonnull AWSKinesisVideoTagResourceInput *)request;

    Swift

    func tagResource(_ request: AWSKinesisVideoTagResourceInput) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the TagResource service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSKinesisVideoTagResourceOutput. On failed execution, task.error may contain an NSError with AWSKinesisVideoErrorDomain domain and the following error code: AWSKinesisVideoErrorInvalidArgument, AWSKinesisVideoErrorClientLimitExceeded, AWSKinesisVideoErrorResourceNotFound, AWSKinesisVideoErrorAccessDenied, AWSKinesisVideoErrorTagsPerResourceExceededLimit.

  • Adds one or more tags to a signaling channel. A tag is a key-value pair (the value is optional) that you can define and assign to AWS resources. If you specify a tag that already exists, the tag value is replaced with the value that you specify in the request. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.

    See

    AWSKinesisVideoTagResourceInput

    See

    AWSKinesisVideoTagResourceOutput

    Declaration

    Objective-C

    - (void)tagResource:(nonnull AWSKinesisVideoTagResourceInput *)request
        completionHandler:
            (void (^_Nullable)(AWSKinesisVideoTagResourceOutput *_Nullable,
                               NSError *_Nullable))completionHandler;

    Swift

    func tagResource(_ request: AWSKinesisVideoTagResourceInput, completionHandler: ((AWSKinesisVideoTagResourceOutput?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the TagResource service method.

    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSKinesisVideoErrorDomain domain and the following error code: AWSKinesisVideoErrorInvalidArgument, AWSKinesisVideoErrorClientLimitExceeded, AWSKinesisVideoErrorResourceNotFound, AWSKinesisVideoErrorAccessDenied, AWSKinesisVideoErrorTagsPerResourceExceededLimit.

  • Adds one or more tags to a stream. A tag is a key-value pair (the value is optional) that you can define and assign to AWS resources. If you specify a tag that already exists, the tag value is replaced with the value that you specify in the request. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.

    You must provide either the StreamName or the StreamARN.

    This operation requires permission for the KinesisVideo:TagStream action.

    Kinesis video streams support up to 50 tags.

    See

    AWSKinesisVideoTagStreamInput

    See

    AWSKinesisVideoTagStreamOutput

    Declaration

    Objective-C

    - (id)tagStream:(nonnull AWSKinesisVideoTagStreamInput *)request;

    Swift

    func tagStream(_ request: AWSKinesisVideoTagStreamInput) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the TagStream service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSKinesisVideoTagStreamOutput. On failed execution, task.error may contain an NSError with AWSKinesisVideoErrorDomain domain and the following error code: AWSKinesisVideoErrorClientLimitExceeded, AWSKinesisVideoErrorInvalidArgument, AWSKinesisVideoErrorResourceNotFound, AWSKinesisVideoErrorNotAuthorized, AWSKinesisVideoErrorInvalidResourceFormat, AWSKinesisVideoErrorTagsPerResourceExceededLimit.

  • Adds one or more tags to a stream. A tag is a key-value pair (the value is optional) that you can define and assign to AWS resources. If you specify a tag that already exists, the tag value is replaced with the value that you specify in the request. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.

    You must provide either the StreamName or the StreamARN.

    This operation requires permission for the KinesisVideo:TagStream action.

    Kinesis video streams support up to 50 tags.

    See

    AWSKinesisVideoTagStreamInput

    See

    AWSKinesisVideoTagStreamOutput

    Declaration

    Objective-C

    - (void)tagStream:(nonnull AWSKinesisVideoTagStreamInput *)request
        completionHandler:
            (void (^_Nullable)(AWSKinesisVideoTagStreamOutput *_Nullable,
                               NSError *_Nullable))completionHandler;

    Swift

    func tagStream(_ request: AWSKinesisVideoTagStreamInput, completionHandler: ((AWSKinesisVideoTagStreamOutput?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the TagStream service method.

    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSKinesisVideoErrorDomain domain and the following error code: AWSKinesisVideoErrorClientLimitExceeded, AWSKinesisVideoErrorInvalidArgument, AWSKinesisVideoErrorResourceNotFound, AWSKinesisVideoErrorNotAuthorized, AWSKinesisVideoErrorInvalidResourceFormat, AWSKinesisVideoErrorTagsPerResourceExceededLimit.

  • Removes one or more tags from a signaling channel. In the request, specify only a tag key or keys; don’t specify the value. If you specify a tag key that does not exist, it’s ignored.

    See

    AWSKinesisVideoUntagResourceInput

    See

    AWSKinesisVideoUntagResourceOutput

    Declaration

    Objective-C

    - (id)untagResource:(nonnull AWSKinesisVideoUntagResourceInput *)request;

    Swift

    func untagResource(_ request: AWSKinesisVideoUntagResourceInput) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the UntagResource service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSKinesisVideoUntagResourceOutput. On failed execution, task.error may contain an NSError with AWSKinesisVideoErrorDomain domain and the following error code: AWSKinesisVideoErrorInvalidArgument, AWSKinesisVideoErrorClientLimitExceeded, AWSKinesisVideoErrorResourceNotFound, AWSKinesisVideoErrorAccessDenied.

  • Removes one or more tags from a signaling channel. In the request, specify only a tag key or keys; don’t specify the value. If you specify a tag key that does not exist, it’s ignored.

    See

    AWSKinesisVideoUntagResourceInput

    See

    AWSKinesisVideoUntagResourceOutput

    Declaration

    Objective-C

    - (void)untagResource:(nonnull AWSKinesisVideoUntagResourceInput *)request
        completionHandler:
            (void (^_Nullable)(AWSKinesisVideoUntagResourceOutput *_Nullable,
                               NSError *_Nullable))completionHandler;

    Swift

    func untagResource(_ request: AWSKinesisVideoUntagResourceInput, completionHandler: ((AWSKinesisVideoUntagResourceOutput?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the UntagResource service method.

    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSKinesisVideoErrorDomain domain and the following error code: AWSKinesisVideoErrorInvalidArgument, AWSKinesisVideoErrorClientLimitExceeded, AWSKinesisVideoErrorResourceNotFound, AWSKinesisVideoErrorAccessDenied.

  • Removes one or more tags from a stream. In the request, specify only a tag key or keys; don’t specify the value. If you specify a tag key that does not exist, it’s ignored.

    In the request, you must provide the StreamName or StreamARN.

    See

    AWSKinesisVideoUntagStreamInput

    See

    AWSKinesisVideoUntagStreamOutput

    Declaration

    Objective-C

    - (id)untagStream:(nonnull AWSKinesisVideoUntagStreamInput *)request;

    Swift

    func untagStream(_ request: AWSKinesisVideoUntagStreamInput) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the UntagStream service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSKinesisVideoUntagStreamOutput. On failed execution, task.error may contain an NSError with AWSKinesisVideoErrorDomain domain and the following error code: AWSKinesisVideoErrorClientLimitExceeded, AWSKinesisVideoErrorInvalidArgument, AWSKinesisVideoErrorResourceNotFound, AWSKinesisVideoErrorNotAuthorized, AWSKinesisVideoErrorInvalidResourceFormat.

  • Removes one or more tags from a stream. In the request, specify only a tag key or keys; don’t specify the value. If you specify a tag key that does not exist, it’s ignored.

    In the request, you must provide the StreamName or StreamARN.

    See

    AWSKinesisVideoUntagStreamInput

    See

    AWSKinesisVideoUntagStreamOutput

    Declaration

    Objective-C

    - (void)untagStream:(nonnull AWSKinesisVideoUntagStreamInput *)request
        completionHandler:
            (void (^_Nullable)(AWSKinesisVideoUntagStreamOutput *_Nullable,
                               NSError *_Nullable))completionHandler;

    Swift

    func untagStream(_ request: AWSKinesisVideoUntagStreamInput, completionHandler: ((AWSKinesisVideoUntagStreamOutput?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the UntagStream service method.

    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSKinesisVideoErrorDomain domain and the following error code: AWSKinesisVideoErrorClientLimitExceeded, AWSKinesisVideoErrorInvalidArgument, AWSKinesisVideoErrorResourceNotFound, AWSKinesisVideoErrorNotAuthorized, AWSKinesisVideoErrorInvalidResourceFormat.

  • Increases or decreases the stream’s data retention period by the value that you specify. To indicate whether you want to increase or decrease the data retention period, specify the Operation parameter in the request body. In the request, you must specify either the StreamName or the StreamARN.

    The retention period that you specify replaces the current value.

    This operation requires permission for the KinesisVideo:UpdateDataRetention action.

    Changing the data retention period affects the data in the stream as follows:

    • If the data retention period is increased, existing data is retained for the new retention period. For example, if the data retention period is increased from one hour to seven hours, all existing data is retained for seven hours.

    • If the data retention period is decreased, existing data is retained for the new retention period. For example, if the data retention period is decreased from seven hours to one hour, all existing data is retained for one hour, and any data older than one hour is deleted immediately.

    See

    AWSKinesisVideoUpdateDataRetentionInput

    See

    AWSKinesisVideoUpdateDataRetentionOutput

    Declaration

    Objective-C

    - (id)updateDataRetention:
        (nonnull AWSKinesisVideoUpdateDataRetentionInput *)request;

    Swift

    func updateDataRetention(_ request: AWSKinesisVideoUpdateDataRetentionInput) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the UpdateDataRetention service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSKinesisVideoUpdateDataRetentionOutput. On failed execution, task.error may contain an NSError with AWSKinesisVideoErrorDomain domain and the following error code: AWSKinesisVideoErrorClientLimitExceeded, AWSKinesisVideoErrorInvalidArgument, AWSKinesisVideoErrorResourceNotFound, AWSKinesisVideoErrorResourceInUse, AWSKinesisVideoErrorNotAuthorized, AWSKinesisVideoErrorVersionMismatch.

  • Increases or decreases the stream’s data retention period by the value that you specify. To indicate whether you want to increase or decrease the data retention period, specify the Operation parameter in the request body. In the request, you must specify either the StreamName or the StreamARN.

    The retention period that you specify replaces the current value.

    This operation requires permission for the KinesisVideo:UpdateDataRetention action.

    Changing the data retention period affects the data in the stream as follows:

    • If the data retention period is increased, existing data is retained for the new retention period. For example, if the data retention period is increased from one hour to seven hours, all existing data is retained for seven hours.

    • If the data retention period is decreased, existing data is retained for the new retention period. For example, if the data retention period is decreased from seven hours to one hour, all existing data is retained for one hour, and any data older than one hour is deleted immediately.

    See

    AWSKinesisVideoUpdateDataRetentionInput

    See

    AWSKinesisVideoUpdateDataRetentionOutput

    Declaration

    Objective-C

    - (void)updateDataRetention:
                (nonnull AWSKinesisVideoUpdateDataRetentionInput *)request
              completionHandler:
                  (void (^_Nullable)(
                      AWSKinesisVideoUpdateDataRetentionOutput *_Nullable,
                      NSError *_Nullable))completionHandler;

    Swift

    func updateDataRetention(_ request: AWSKinesisVideoUpdateDataRetentionInput, completionHandler: ((AWSKinesisVideoUpdateDataRetentionOutput?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the UpdateDataRetention service method.

    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSKinesisVideoErrorDomain domain and the following error code: AWSKinesisVideoErrorClientLimitExceeded, AWSKinesisVideoErrorInvalidArgument, AWSKinesisVideoErrorResourceNotFound, AWSKinesisVideoErrorResourceInUse, AWSKinesisVideoErrorNotAuthorized, AWSKinesisVideoErrorVersionMismatch.

  • Updates the existing signaling channel. This is an asynchronous operation and takes time to complete.

    If the MessageTtlSeconds value is updated (either increased or reduced), then it only applies to new messages sent via this channel after it’s been updated. Existing messages are still expire as per the previous MessageTtlSeconds value.

    See

    AWSKinesisVideoUpdateSignalingChannelInput

    See

    AWSKinesisVideoUpdateSignalingChannelOutput

    Declaration

    Objective-C

    - (id)updateSignalingChannel:
        (nonnull AWSKinesisVideoUpdateSignalingChannelInput *)request;

    Swift

    func updateSignalingChannel(_ request: AWSKinesisVideoUpdateSignalingChannelInput) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the UpdateSignalingChannel service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSKinesisVideoUpdateSignalingChannelOutput. On failed execution, task.error may contain an NSError with AWSKinesisVideoErrorDomain domain and the following error code: AWSKinesisVideoErrorInvalidArgument, AWSKinesisVideoErrorClientLimitExceeded, AWSKinesisVideoErrorResourceNotFound, AWSKinesisVideoErrorResourceInUse, AWSKinesisVideoErrorAccessDenied, AWSKinesisVideoErrorVersionMismatch.

  • Updates the existing signaling channel. This is an asynchronous operation and takes time to complete.

    If the MessageTtlSeconds value is updated (either increased or reduced), then it only applies to new messages sent via this channel after it’s been updated. Existing messages are still expire as per the previous MessageTtlSeconds value.

    See

    AWSKinesisVideoUpdateSignalingChannelInput

    See

    AWSKinesisVideoUpdateSignalingChannelOutput

    Declaration

    Objective-C

    - (void)updateSignalingChannel:
                (nonnull AWSKinesisVideoUpdateSignalingChannelInput *)request
                 completionHandler:
                     (void (^_Nullable)(
                         AWSKinesisVideoUpdateSignalingChannelOutput *_Nullable,
                         NSError *_Nullable))completionHandler;

    Swift

    func updateSignalingChannel(_ request: AWSKinesisVideoUpdateSignalingChannelInput, completionHandler: ((AWSKinesisVideoUpdateSignalingChannelOutput?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the UpdateSignalingChannel service method.

    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSKinesisVideoErrorDomain domain and the following error code: AWSKinesisVideoErrorInvalidArgument, AWSKinesisVideoErrorClientLimitExceeded, AWSKinesisVideoErrorResourceNotFound, AWSKinesisVideoErrorResourceInUse, AWSKinesisVideoErrorAccessDenied, AWSKinesisVideoErrorVersionMismatch.

  • Updates stream metadata, such as the device name and media type.

    You must provide the stream name or the Amazon Resource Name (ARN) of the stream.

    To make sure that you have the latest version of the stream before updating it, you can specify the stream version. Kinesis Video Streams assigns a version to each stream. When you update a stream, Kinesis Video Streams assigns a new version number. To get the latest stream version, use the DescribeStream API.

    UpdateStream is an asynchronous operation, and takes time to complete.

    See

    AWSKinesisVideoUpdateStreamInput

    See

    AWSKinesisVideoUpdateStreamOutput

    Declaration

    Objective-C

    - (id)updateStream:(nonnull AWSKinesisVideoUpdateStreamInput *)request;

    Swift

    func updateStream(_ request: AWSKinesisVideoUpdateStreamInput) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the UpdateStream service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSKinesisVideoUpdateStreamOutput. On failed execution, task.error may contain an NSError with AWSKinesisVideoErrorDomain domain and the following error code: AWSKinesisVideoErrorClientLimitExceeded, AWSKinesisVideoErrorInvalidArgument, AWSKinesisVideoErrorResourceNotFound, AWSKinesisVideoErrorResourceInUse, AWSKinesisVideoErrorNotAuthorized, AWSKinesisVideoErrorVersionMismatch.

  • Updates stream metadata, such as the device name and media type.

    You must provide the stream name or the Amazon Resource Name (ARN) of the stream.

    To make sure that you have the latest version of the stream before updating it, you can specify the stream version. Kinesis Video Streams assigns a version to each stream. When you update a stream, Kinesis Video Streams assigns a new version number. To get the latest stream version, use the DescribeStream API.

    UpdateStream is an asynchronous operation, and takes time to complete.

    See

    AWSKinesisVideoUpdateStreamInput

    See

    AWSKinesisVideoUpdateStreamOutput

    Declaration

    Objective-C

    - (void)updateStream:(nonnull AWSKinesisVideoUpdateStreamInput *)request
        completionHandler:
            (void (^_Nullable)(AWSKinesisVideoUpdateStreamOutput *_Nullable,
                               NSError *_Nullable))completionHandler;

    Swift

    func updateStream(_ request: AWSKinesisVideoUpdateStreamInput, completionHandler: ((AWSKinesisVideoUpdateStreamOutput?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the UpdateStream service method.

    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSKinesisVideoErrorDomain domain and the following error code: AWSKinesisVideoErrorClientLimitExceeded, AWSKinesisVideoErrorInvalidArgument, AWSKinesisVideoErrorResourceNotFound, AWSKinesisVideoErrorResourceInUse, AWSKinesisVideoErrorNotAuthorized, AWSKinesisVideoErrorVersionMismatch.