AWSKinesisVideoArchivedMedia

Objective-C

@interface AWSKinesisVideoArchivedMedia

Swift

class AWSKinesisVideoArchivedMedia

  • 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

  • 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 KinesisVideoArchivedMedia = AWSKinesisVideoArchivedMedia.default()

    Objective-C

    AWSKinesisVideoArchivedMedia *KinesisVideoArchivedMedia = [AWSKinesisVideoArchivedMedia defaultKinesisVideoArchivedMedia];

    Declaration

    Objective-C

    + (nonnull instancetype)defaultKinesisVideoArchivedMedia;

    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)
   AWSKinesisVideoArchivedMedia.register(with: configuration!, forKey: "USWest2KinesisVideoArchivedMedia")

   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];

    [AWSKinesisVideoArchivedMedia registerKinesisVideoArchivedMediaWithConfiguration:configuration forKey:@"USWest2KinesisVideoArchivedMedia"];

    return YES;
}

    Then call the following to get the service client:

    Swift

    let KinesisVideoArchivedMedia = AWSKinesisVideoArchivedMedia(forKey: "USWest2KinesisVideoArchivedMedia")

    Objective-C

    AWSKinesisVideoArchivedMedia *KinesisVideoArchivedMedia = [AWSKinesisVideoArchivedMedia KinesisVideoArchivedMediaForKey:@"USWest2KinesisVideoArchivedMedia"];

    Warning

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

    Declaration

    Objective-C

    + (void)registerKinesisVideoArchivedMediaWithConfiguration:(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 + registerKinesisVideoArchivedMediaWithConfiguration: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)
   AWSKinesisVideoArchivedMedia.register(with: configuration!, forKey: "USWest2KinesisVideoArchivedMedia")

   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];

    [AWSKinesisVideoArchivedMedia registerKinesisVideoArchivedMediaWithConfiguration:configuration forKey:@"USWest2KinesisVideoArchivedMedia"];

    return YES;
}

    Then call the following to get the service client:

    Swift

    let KinesisVideoArchivedMedia = AWSKinesisVideoArchivedMedia(forKey: "USWest2KinesisVideoArchivedMedia")

    Objective-C

    AWSKinesisVideoArchivedMedia *KinesisVideoArchivedMedia = [AWSKinesisVideoArchivedMedia KinesisVideoArchivedMediaForKey:@"USWest2KinesisVideoArchivedMedia"];

    Declaration

    Objective-C

    + (nonnull instancetype)KinesisVideoArchivedMediaForKey:(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)removeKinesisVideoArchivedMediaForKey:(nonnull NSString *)key;

    Swift

    class func remove(forKey key: String)

    Parameters

    key

    A string to identify the service client.

  • Downloads an MP4 file (clip) containing the archived, on-demand media from the specified video stream over the specified time range.

    Both the StreamName and the StreamARN parameters are optional, but you must specify either the StreamName or the StreamARN when invoking this API operation.

    As a prerequisite to using GetCLip API, you must obtain an endpoint using GetDataEndpoint, specifying GET_CLIP for the APIName parameter.

    An Amazon Kinesis video stream has the following requirements for providing data through MP4:

    • The media must contain h.264 or h.265 encoded video and, optionally, AAC or G.711 encoded audio. Specifically, the codec ID of track 1 should be V_MPEG/ISO/AVC (for h.264) or V_MPEGH/ISO/HEVC (for H.265). Optionally, the codec ID of track 2 should be A_AAC (for AAC) or A_MS/ACM (for G.711).

    • Data retention must be greater than 0.

    • The video track of each fragment must contain codec private data in the Advanced Video Coding (AVC) for H.264 format and HEVC for H.265 format. For more information, see MPEG-4 specification ISO/IEC 14496-15. For information about adapting stream data to a given format, see NAL Adaptation Flags.

    • The audio track (if present) of each fragment must contain codec private data in the AAC format (AAC specification ISO/IEC 13818-7) or the MS Wave format.

    You can monitor the amount of outgoing data by monitoring the GetClip.OutgoingBytes Amazon CloudWatch metric. For information about using CloudWatch to monitor Kinesis Video Streams, see Monitoring Kinesis Video Streams. For pricing information, see Amazon Kinesis Video Streams Pricing and Amazon Web Services Pricing. Charges for outgoing Amazon Web Services data apply.

    See

    AWSKinesisVideoArchivedMediaGetClipInput

    See

    AWSKinesisVideoArchivedMediaGetClipOutput

    Declaration

    Objective-C

    - (id)getClip:(nonnull AWSKinesisVideoArchivedMediaGetClipInput *)request;

    Swift

    func getClip(_ request: AWSKinesisVideoArchivedMediaGetClipInput) -> Any!

    Parameters

    request

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

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSKinesisVideoArchivedMediaGetClipOutput. On failed execution, task.error may contain an NSError with AWSKinesisVideoArchivedMediaErrorDomain domain and the following error code: AWSKinesisVideoArchivedMediaErrorResourceNotFound, AWSKinesisVideoArchivedMediaErrorInvalidArgument, AWSKinesisVideoArchivedMediaErrorClientLimitExceeded, AWSKinesisVideoArchivedMediaErrorNotAuthorized, AWSKinesisVideoArchivedMediaErrorUnsupportedStreamMediaType, AWSKinesisVideoArchivedMediaErrorMissingCodecPrivateData, AWSKinesisVideoArchivedMediaErrorInvalidCodecPrivateData, AWSKinesisVideoArchivedMediaErrorInvalidMediaFrame, AWSKinesisVideoArchivedMediaErrorNoDataRetention.

  • Downloads an MP4 file (clip) containing the archived, on-demand media from the specified video stream over the specified time range.

    Both the StreamName and the StreamARN parameters are optional, but you must specify either the StreamName or the StreamARN when invoking this API operation.

    As a prerequisite to using GetCLip API, you must obtain an endpoint using GetDataEndpoint, specifying GET_CLIP for the APIName parameter.

    An Amazon Kinesis video stream has the following requirements for providing data through MP4:

    • The media must contain h.264 or h.265 encoded video and, optionally, AAC or G.711 encoded audio. Specifically, the codec ID of track 1 should be V_MPEG/ISO/AVC (for h.264) or V_MPEGH/ISO/HEVC (for H.265). Optionally, the codec ID of track 2 should be A_AAC (for AAC) or A_MS/ACM (for G.711).

    • Data retention must be greater than 0.

    • The video track of each fragment must contain codec private data in the Advanced Video Coding (AVC) for H.264 format and HEVC for H.265 format. For more information, see MPEG-4 specification ISO/IEC 14496-15. For information about adapting stream data to a given format, see NAL Adaptation Flags.

    • The audio track (if present) of each fragment must contain codec private data in the AAC format (AAC specification ISO/IEC 13818-7) or the MS Wave format.

    You can monitor the amount of outgoing data by monitoring the GetClip.OutgoingBytes Amazon CloudWatch metric. For information about using CloudWatch to monitor Kinesis Video Streams, see Monitoring Kinesis Video Streams. For pricing information, see Amazon Kinesis Video Streams Pricing and Amazon Web Services Pricing. Charges for outgoing Amazon Web Services data apply.

    See

    AWSKinesisVideoArchivedMediaGetClipInput

    See

    AWSKinesisVideoArchivedMediaGetClipOutput

    Declaration

    Objective-C

    - (void)getClip:(nonnull AWSKinesisVideoArchivedMediaGetClipInput *)request
    completionHandler:
        (void (^_Nullable)(AWSKinesisVideoArchivedMediaGetClipOutput *_Nullable,
                           NSError *_Nullable))completionHandler;

    Swift

    func clip(_ request: AWSKinesisVideoArchivedMediaGetClipInput) async throws -> AWSKinesisVideoArchivedMediaGetClipOutput

    Parameters

    request

    A container for the necessary parameters to execute the GetClip 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 AWSKinesisVideoArchivedMediaErrorDomain domain and the following error code: AWSKinesisVideoArchivedMediaErrorResourceNotFound, AWSKinesisVideoArchivedMediaErrorInvalidArgument, AWSKinesisVideoArchivedMediaErrorClientLimitExceeded, AWSKinesisVideoArchivedMediaErrorNotAuthorized, AWSKinesisVideoArchivedMediaErrorUnsupportedStreamMediaType, AWSKinesisVideoArchivedMediaErrorMissingCodecPrivateData, AWSKinesisVideoArchivedMediaErrorInvalidCodecPrivateData, AWSKinesisVideoArchivedMediaErrorInvalidMediaFrame, AWSKinesisVideoArchivedMediaErrorNoDataRetention.

  • Retrieves an MPEG Dynamic Adaptive Streaming over HTTP (DASH) URL for the stream. You can then open the URL in a media player to view the stream contents.

    Both the StreamName and the StreamARN parameters are optional, but you must specify either the StreamName or the StreamARN when invoking this API operation.

    An Amazon Kinesis video stream has the following requirements for providing data through MPEG-DASH:

    • The media must contain h.264 or h.265 encoded video and, optionally, AAC or G.711 encoded audio. Specifically, the codec ID of track 1 should be V_MPEG/ISO/AVC (for h.264) or V_MPEGH/ISO/HEVC (for H.265). Optionally, the codec ID of track 2 should be A_AAC (for AAC) or A_MS/ACM (for G.711).

    • Data retention must be greater than 0.

    • The video track of each fragment must contain codec private data in the Advanced Video Coding (AVC) for H.264 format and HEVC for H.265 format. For more information, see MPEG-4 specification ISO/IEC 14496-15. For information about adapting stream data to a given format, see NAL Adaptation Flags.

    • The audio track (if present) of each fragment must contain codec private data in the AAC format (AAC specification ISO/IEC 13818-7) or the MS Wave format.

    The following procedure shows how to use MPEG-DASH with Kinesis Video Streams:

    1. Get an endpoint using GetDataEndpoint, specifying GET_DASH_STREAMING_SESSION_URL for the APIName parameter.

    2. Retrieve the MPEG-DASH URL using GetDASHStreamingSessionURL. Kinesis Video Streams creates an MPEG-DASH streaming session to be used for accessing content in a stream using the MPEG-DASH protocol. GetDASHStreamingSessionURL returns an authenticated URL (that includes an encrypted session token) for the session’s MPEG-DASH manifest (the root resource needed for streaming with MPEG-DASH).

      Don’t share or store this token where an unauthorized entity can access it. The token provides access to the content of the stream. Safeguard the token with the same measures that you use with your Amazon Web Services credentials.

      The media that is made available through the manifest consists only of the requested stream, time range, and format. No other media data (such as frames outside the requested window or alternate bitrates) is made available.

    3. Provide the URL (containing the encrypted session token) for the MPEG-DASH manifest to a media player that supports the MPEG-DASH protocol. Kinesis Video Streams makes the initialization fragment and media fragments available through the manifest URL. The initialization fragment contains the codec private data for the stream, and other data needed to set up the video or audio decoder and renderer. The media fragments contain encoded video frames or encoded audio samples.

    4. The media player receives the authenticated URL and requests stream metadata and media data normally. When the media player requests data, it calls the following actions:

      • GetDASHManifest: Retrieves an MPEG DASH manifest, which contains the metadata for the media that you want to playback.

      • GetMP4InitFragment: Retrieves the MP4 initialization fragment. The media player typically loads the initialization fragment before loading any media fragments. This fragment contains the “fytp” and “moov” MP4 atoms, and the child atoms that are needed to initialize the media player decoder.

        The initialization fragment does not correspond to a fragment in a Kinesis video stream. It contains only the codec private data for the stream and respective track, which the media player needs to decode the media frames.

      • GetMP4MediaFragment: Retrieves MP4 media fragments. These fragments contain the “moof” and “mdat” MP4 atoms and their child atoms, containing the encoded fragment’s media frames and their timestamps.

        After the first media fragment is made available in a streaming session, any fragments that don’t contain the same codec private data cause an error to be returned when those different media fragments are loaded. Therefore, the codec private data should not change between fragments in a session. This also means that the session fails if the fragments in a stream change from having only video to having both audio and video.

        Data retrieved with this action is billable. See Pricing for details.

    For restrictions that apply to MPEG-DASH sessions, see Kinesis Video Streams Limits.

    You can monitor the amount of data that the media player consumes by monitoring the GetMP4MediaFragment.OutgoingBytes Amazon CloudWatch metric. For information about using CloudWatch to monitor Kinesis Video Streams, see Monitoring Kinesis Video Streams. For pricing information, see Amazon Kinesis Video Streams Pricing and Amazon Web Services Pricing. Charges for both HLS sessions and outgoing Amazon Web Services data apply.

    For more information about HLS, see HTTP Live Streaming on the Apple Developer site.

    If an error is thrown after invoking a Kinesis Video Streams archived media API, in addition to the HTTP status code and the response body, it includes the following pieces of information:

    • x-amz-ErrorType HTTP header – contains a more specific error type in addition to what the HTTP status code provides.

    • x-amz-RequestId HTTP header – if you want to report an issue to Amazon Web Services the support team can better diagnose the problem if given the Request Id.

    Both the HTTP status code and the ErrorType header can be utilized to make programmatic decisions about whether errors are retry-able and under what conditions, as well as provide information on what actions the client programmer might need to take in order to successfully try again.

    For more information, see the Errors section at the bottom of this topic, as well as Common Errors.

    See

    AWSKinesisVideoArchivedMediaGetDASHStreamingSessionURLInput

    See

    AWSKinesisVideoArchivedMediaGetDASHStreamingSessionURLOutput

    Declaration

    Objective-C

    - (id)getDASHStreamingSessionURL:
    (nonnull AWSKinesisVideoArchivedMediaGetDASHStreamingSessionURLInput *)
        request;

    Swift

    func getDASHStreamingSessionURL(_ request: AWSKinesisVideoArchivedMediaGetDASHStreamingSessionURLInput) -> Any!

    Parameters

    request

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

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSKinesisVideoArchivedMediaGetDASHStreamingSessionURLOutput. On failed execution, task.error may contain an NSError with AWSKinesisVideoArchivedMediaErrorDomain domain and the following error code: AWSKinesisVideoArchivedMediaErrorResourceNotFound, AWSKinesisVideoArchivedMediaErrorInvalidArgument, AWSKinesisVideoArchivedMediaErrorClientLimitExceeded, AWSKinesisVideoArchivedMediaErrorNotAuthorized, AWSKinesisVideoArchivedMediaErrorUnsupportedStreamMediaType, AWSKinesisVideoArchivedMediaErrorNoDataRetention, AWSKinesisVideoArchivedMediaErrorMissingCodecPrivateData, AWSKinesisVideoArchivedMediaErrorInvalidCodecPrivateData.

  • Retrieves an MPEG Dynamic Adaptive Streaming over HTTP (DASH) URL for the stream. You can then open the URL in a media player to view the stream contents.

    Both the StreamName and the StreamARN parameters are optional, but you must specify either the StreamName or the StreamARN when invoking this API operation.

    An Amazon Kinesis video stream has the following requirements for providing data through MPEG-DASH:

    • The media must contain h.264 or h.265 encoded video and, optionally, AAC or G.711 encoded audio. Specifically, the codec ID of track 1 should be V_MPEG/ISO/AVC (for h.264) or V_MPEGH/ISO/HEVC (for H.265). Optionally, the codec ID of track 2 should be A_AAC (for AAC) or A_MS/ACM (for G.711).

    • Data retention must be greater than 0.

    • The video track of each fragment must contain codec private data in the Advanced Video Coding (AVC) for H.264 format and HEVC for H.265 format. For more information, see MPEG-4 specification ISO/IEC 14496-15. For information about adapting stream data to a given format, see NAL Adaptation Flags.

    • The audio track (if present) of each fragment must contain codec private data in the AAC format (AAC specification ISO/IEC 13818-7) or the MS Wave format.

    The following procedure shows how to use MPEG-DASH with Kinesis Video Streams:

    1. Get an endpoint using GetDataEndpoint, specifying GET_DASH_STREAMING_SESSION_URL for the APIName parameter.

    2. Retrieve the MPEG-DASH URL using GetDASHStreamingSessionURL. Kinesis Video Streams creates an MPEG-DASH streaming session to be used for accessing content in a stream using the MPEG-DASH protocol. GetDASHStreamingSessionURL returns an authenticated URL (that includes an encrypted session token) for the session’s MPEG-DASH manifest (the root resource needed for streaming with MPEG-DASH).

      Don’t share or store this token where an unauthorized entity can access it. The token provides access to the content of the stream. Safeguard the token with the same measures that you use with your Amazon Web Services credentials.

      The media that is made available through the manifest consists only of the requested stream, time range, and format. No other media data (such as frames outside the requested window or alternate bitrates) is made available.

    3. Provide the URL (containing the encrypted session token) for the MPEG-DASH manifest to a media player that supports the MPEG-DASH protocol. Kinesis Video Streams makes the initialization fragment and media fragments available through the manifest URL. The initialization fragment contains the codec private data for the stream, and other data needed to set up the video or audio decoder and renderer. The media fragments contain encoded video frames or encoded audio samples.

    4. The media player receives the authenticated URL and requests stream metadata and media data normally. When the media player requests data, it calls the following actions:

      • GetDASHManifest: Retrieves an MPEG DASH manifest, which contains the metadata for the media that you want to playback.

      • GetMP4InitFragment: Retrieves the MP4 initialization fragment. The media player typically loads the initialization fragment before loading any media fragments. This fragment contains the “fytp” and “moov” MP4 atoms, and the child atoms that are needed to initialize the media player decoder.

        The initialization fragment does not correspond to a fragment in a Kinesis video stream. It contains only the codec private data for the stream and respective track, which the media player needs to decode the media frames.

      • GetMP4MediaFragment: Retrieves MP4 media fragments. These fragments contain the “moof” and “mdat” MP4 atoms and their child atoms, containing the encoded fragment’s media frames and their timestamps.

        After the first media fragment is made available in a streaming session, any fragments that don’t contain the same codec private data cause an error to be returned when those different media fragments are loaded. Therefore, the codec private data should not change between fragments in a session. This also means that the session fails if the fragments in a stream change from having only video to having both audio and video.

        Data retrieved with this action is billable. See Pricing for details.

    For restrictions that apply to MPEG-DASH sessions, see Kinesis Video Streams Limits.

    You can monitor the amount of data that the media player consumes by monitoring the GetMP4MediaFragment.OutgoingBytes Amazon CloudWatch metric. For information about using CloudWatch to monitor Kinesis Video Streams, see Monitoring Kinesis Video Streams. For pricing information, see Amazon Kinesis Video Streams Pricing and Amazon Web Services Pricing. Charges for both HLS sessions and outgoing Amazon Web Services data apply.

    For more information about HLS, see HTTP Live Streaming on the Apple Developer site.

    If an error is thrown after invoking a Kinesis Video Streams archived media API, in addition to the HTTP status code and the response body, it includes the following pieces of information:

    • x-amz-ErrorType HTTP header – contains a more specific error type in addition to what the HTTP status code provides.

    • x-amz-RequestId HTTP header – if you want to report an issue to Amazon Web Services the support team can better diagnose the problem if given the Request Id.

    Both the HTTP status code and the ErrorType header can be utilized to make programmatic decisions about whether errors are retry-able and under what conditions, as well as provide information on what actions the client programmer might need to take in order to successfully try again.

    For more information, see the Errors section at the bottom of this topic, as well as Common Errors.

    See

    AWSKinesisVideoArchivedMediaGetDASHStreamingSessionURLInput

    See

    AWSKinesisVideoArchivedMediaGetDASHStreamingSessionURLOutput

    Declaration

    Objective-C

    - (void)
    getDASHStreamingSessionURL:
        (nonnull AWSKinesisVideoArchivedMediaGetDASHStreamingSessionURLInput *)
            request
             completionHandler:
                 (void (^_Nullable)(
                     AWSKinesisVideoArchivedMediaGetDASHStreamingSessionURLOutput
                         *_Nullable,
                     NSError *_Nullable))completionHandler;

    Swift

    func dashStreamingSessionURL(_ request: AWSKinesisVideoArchivedMediaGetDASHStreamingSessionURLInput) async throws -> AWSKinesisVideoArchivedMediaGetDASHStreamingSessionURLOutput

    Parameters

    request

    A container for the necessary parameters to execute the GetDASHStreamingSessionURL 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 AWSKinesisVideoArchivedMediaErrorDomain domain and the following error code: AWSKinesisVideoArchivedMediaErrorResourceNotFound, AWSKinesisVideoArchivedMediaErrorInvalidArgument, AWSKinesisVideoArchivedMediaErrorClientLimitExceeded, AWSKinesisVideoArchivedMediaErrorNotAuthorized, AWSKinesisVideoArchivedMediaErrorUnsupportedStreamMediaType, AWSKinesisVideoArchivedMediaErrorNoDataRetention, AWSKinesisVideoArchivedMediaErrorMissingCodecPrivateData, AWSKinesisVideoArchivedMediaErrorInvalidCodecPrivateData.

  • Retrieves an HTTP Live Streaming (HLS) URL for the stream. You can then open the URL in a browser or media player to view the stream contents.

    Both the StreamName and the StreamARN parameters are optional, but you must specify either the StreamName or the StreamARN when invoking this API operation.

    An Amazon Kinesis video stream has the following requirements for providing data through HLS:

    • For streaming video, the media must contain H.264 or H.265 encoded video and, optionally, AAC encoded audio. Specifically, the codec ID of track 1 should be V_MPEG/ISO/AVC (for H.264) or V_MPEG/ISO/HEVC (for H.265). Optionally, the codec ID of track 2 should be A_AAC. For audio only streaming, the codec ID of track 1 should be A_AAC.

    • Data retention must be greater than 0.

    • The video track of each fragment must contain codec private data in the Advanced Video Coding (AVC) for H.264 format or HEVC for H.265 format (MPEG-4 specification ISO/IEC 14496-15). For information about adapting stream data to a given format, see NAL Adaptation Flags.

    • The audio track (if present) of each fragment must contain codec private data in the AAC format (AAC specification ISO/IEC 13818-7).

    Kinesis Video Streams HLS sessions contain fragments in the fragmented MPEG-4 form (also called fMP4 or CMAF) or the MPEG-2 form (also called TS chunks, which the HLS specification also supports). For more information about HLS fragment types, see the HLS specification.

    The following procedure shows how to use HLS with Kinesis Video Streams:

    1. Get an endpoint using GetDataEndpoint, specifying GET_HLS_STREAMING_SESSION_URL for the APIName parameter.

    2. Retrieve the HLS URL using GetHLSStreamingSessionURL. Kinesis Video Streams creates an HLS streaming session to be used for accessing content in a stream using the HLS protocol. GetHLSStreamingSessionURL returns an authenticated URL (that includes an encrypted session token) for the session’s HLS master playlist (the root resource needed for streaming with HLS).

      Don’t share or store this token where an unauthorized entity could access it. The token provides access to the content of the stream. Safeguard the token with the same measures that you would use with your Amazon Web Services credentials.

      The media that is made available through the playlist consists only of the requested stream, time range, and format. No other media data (such as frames outside the requested window or alternate bitrates) is made available.

    3. Provide the URL (containing the encrypted session token) for the HLS master playlist to a media player that supports the HLS protocol. Kinesis Video Streams makes the HLS media playlist, initialization fragment, and media fragments available through the master playlist URL. The initialization fragment contains the codec private data for the stream, and other data needed to set up the video or audio decoder and renderer. The media fragments contain H.264-encoded video frames or AAC-encoded audio samples.

    4. The media player receives the authenticated URL and requests stream metadata and media data normally. When the media player requests data, it calls the following actions:

      • GetHLSMasterPlaylist: Retrieves an HLS master playlist, which contains a URL for the GetHLSMediaPlaylist action for each track, and additional metadata for the media player, including estimated bitrate and resolution.

      • GetHLSMediaPlaylist: Retrieves an HLS media playlist, which contains a URL to access the MP4 initialization fragment with the GetMP4InitFragment action, and URLs to access the MP4 media fragments with the GetMP4MediaFragment actions. The HLS media playlist also contains metadata about the stream that the player needs to play it, such as whether the PlaybackMode is LIVE or ON_DEMAND. The HLS media playlist is typically static for sessions with a PlaybackType of ON_DEMAND. The HLS media playlist is continually updated with new fragments for sessions with a PlaybackType of LIVE. There is a distinct HLS media playlist for the video track and the audio track (if applicable) that contains MP4 media URLs for the specific track.

      • GetMP4InitFragment: Retrieves the MP4 initialization fragment. The media player typically loads the initialization fragment before loading any media fragments. This fragment contains the “fytp” and “moov” MP4 atoms, and the child atoms that are needed to initialize the media player decoder.

        The initialization fragment does not correspond to a fragment in a Kinesis video stream. It contains only the codec private data for the stream and respective track, which the media player needs to decode the media frames.

      • GetMP4MediaFragment: Retrieves MP4 media fragments. These fragments contain the “moof” and “mdat” MP4 atoms and their child atoms, containing the encoded fragment’s media frames and their timestamps.

        For the HLS streaming session, in-track codec private data (CPD) changes are supported. After the first media fragment is made available in a streaming session, fragments can contain CPD changes for each track. Therefore, the fragments in a session can have a different resolution, bit rate, or other information in the CPD without interrupting playback. However, any change made in the track number or track codec format can return an error when those different media fragments are loaded. For example, streaming will fail if the fragments in the stream change from having only video to having both audio and video, or if an AAC audio track is changed to an ALAW audio track. For each streaming session, only 500 CPD changes are allowed.

        Data retrieved with this action is billable. For information, see Pricing.

      • GetTSFragment: Retrieves MPEG TS fragments containing both initialization and media data for all tracks in the stream.

        If the ContainerFormat is MPEG_TS, this API is used instead of GetMP4InitFragment and GetMP4MediaFragment to retrieve stream media.

        Data retrieved with this action is billable. For more information, see Kinesis Video Streams pricing.

    A streaming session URL must not be shared between players. The service might throttle a session if multiple media players are sharing it. For connection limits, see Kinesis Video Streams Limits.

    You can monitor the amount of data that the media player consumes by monitoring the GetMP4MediaFragment.OutgoingBytes Amazon CloudWatch metric. For information about using CloudWatch to monitor Kinesis Video Streams, see Monitoring Kinesis Video Streams. For pricing information, see Amazon Kinesis Video Streams Pricing and Amazon Web Services Pricing. Charges for both HLS sessions and outgoing Amazon Web Services data apply.

    For more information about HLS, see HTTP Live Streaming on the Apple Developer site.

    If an error is thrown after invoking a Kinesis Video Streams archived media API, in addition to the HTTP status code and the response body, it includes the following pieces of information:

    • x-amz-ErrorType HTTP header – contains a more specific error type in addition to what the HTTP status code provides.

    • x-amz-RequestId HTTP header – if you want to report an issue to Amazon Web Services, the support team can better diagnose the problem if given the Request Id.

    Both the HTTP status code and the ErrorType header can be utilized to make programmatic decisions about whether errors are retry-able and under what conditions, as well as provide information on what actions the client programmer might need to take in order to successfully try again.

    For more information, see the Errors section at the bottom of this topic, as well as Common Errors.

    See

    AWSKinesisVideoArchivedMediaGetHLSStreamingSessionURLInput

    See

    AWSKinesisVideoArchivedMediaGetHLSStreamingSessionURLOutput

    Declaration

    Objective-C

    - (id)getHLSStreamingSessionURL:
    (nonnull AWSKinesisVideoArchivedMediaGetHLSStreamingSessionURLInput *)
        request;

    Swift

    func getHLSStreamingSessionURL(_ request: AWSKinesisVideoArchivedMediaGetHLSStreamingSessionURLInput) -> Any!

    Parameters

    request

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

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSKinesisVideoArchivedMediaGetHLSStreamingSessionURLOutput. On failed execution, task.error may contain an NSError with AWSKinesisVideoArchivedMediaErrorDomain domain and the following error code: AWSKinesisVideoArchivedMediaErrorResourceNotFound, AWSKinesisVideoArchivedMediaErrorInvalidArgument, AWSKinesisVideoArchivedMediaErrorClientLimitExceeded, AWSKinesisVideoArchivedMediaErrorNotAuthorized, AWSKinesisVideoArchivedMediaErrorUnsupportedStreamMediaType, AWSKinesisVideoArchivedMediaErrorNoDataRetention, AWSKinesisVideoArchivedMediaErrorMissingCodecPrivateData, AWSKinesisVideoArchivedMediaErrorInvalidCodecPrivateData.

  • Retrieves an HTTP Live Streaming (HLS) URL for the stream. You can then open the URL in a browser or media player to view the stream contents.

    Both the StreamName and the StreamARN parameters are optional, but you must specify either the StreamName or the StreamARN when invoking this API operation.

    An Amazon Kinesis video stream has the following requirements for providing data through HLS:

    • For streaming video, the media must contain H.264 or H.265 encoded video and, optionally, AAC encoded audio. Specifically, the codec ID of track 1 should be V_MPEG/ISO/AVC (for H.264) or V_MPEG/ISO/HEVC (for H.265). Optionally, the codec ID of track 2 should be A_AAC. For audio only streaming, the codec ID of track 1 should be A_AAC.

    • Data retention must be greater than 0.

    • The video track of each fragment must contain codec private data in the Advanced Video Coding (AVC) for H.264 format or HEVC for H.265 format (MPEG-4 specification ISO/IEC 14496-15). For information about adapting stream data to a given format, see NAL Adaptation Flags.

    • The audio track (if present) of each fragment must contain codec private data in the AAC format (AAC specification ISO/IEC 13818-7).

    Kinesis Video Streams HLS sessions contain fragments in the fragmented MPEG-4 form (also called fMP4 or CMAF) or the MPEG-2 form (also called TS chunks, which the HLS specification also supports). For more information about HLS fragment types, see the HLS specification.

    The following procedure shows how to use HLS with Kinesis Video Streams:

    1. Get an endpoint using GetDataEndpoint, specifying GET_HLS_STREAMING_SESSION_URL for the APIName parameter.

    2. Retrieve the HLS URL using GetHLSStreamingSessionURL. Kinesis Video Streams creates an HLS streaming session to be used for accessing content in a stream using the HLS protocol. GetHLSStreamingSessionURL returns an authenticated URL (that includes an encrypted session token) for the session’s HLS master playlist (the root resource needed for streaming with HLS).

      Don’t share or store this token where an unauthorized entity could access it. The token provides access to the content of the stream. Safeguard the token with the same measures that you would use with your Amazon Web Services credentials.

      The media that is made available through the playlist consists only of the requested stream, time range, and format. No other media data (such as frames outside the requested window or alternate bitrates) is made available.

    3. Provide the URL (containing the encrypted session token) for the HLS master playlist to a media player that supports the HLS protocol. Kinesis Video Streams makes the HLS media playlist, initialization fragment, and media fragments available through the master playlist URL. The initialization fragment contains the codec private data for the stream, and other data needed to set up the video or audio decoder and renderer. The media fragments contain H.264-encoded video frames or AAC-encoded audio samples.

    4. The media player receives the authenticated URL and requests stream metadata and media data normally. When the media player requests data, it calls the following actions:

      • GetHLSMasterPlaylist: Retrieves an HLS master playlist, which contains a URL for the GetHLSMediaPlaylist action for each track, and additional metadata for the media player, including estimated bitrate and resolution.

      • GetHLSMediaPlaylist: Retrieves an HLS media playlist, which contains a URL to access the MP4 initialization fragment with the GetMP4InitFragment action, and URLs to access the MP4 media fragments with the GetMP4MediaFragment actions. The HLS media playlist also contains metadata about the stream that the player needs to play it, such as whether the PlaybackMode is LIVE or ON_DEMAND. The HLS media playlist is typically static for sessions with a PlaybackType of ON_DEMAND. The HLS media playlist is continually updated with new fragments for sessions with a PlaybackType of LIVE. There is a distinct HLS media playlist for the video track and the audio track (if applicable) that contains MP4 media URLs for the specific track.

      • GetMP4InitFragment: Retrieves the MP4 initialization fragment. The media player typically loads the initialization fragment before loading any media fragments. This fragment contains the “fytp” and “moov” MP4 atoms, and the child atoms that are needed to initialize the media player decoder.

        The initialization fragment does not correspond to a fragment in a Kinesis video stream. It contains only the codec private data for the stream and respective track, which the media player needs to decode the media frames.

      • GetMP4MediaFragment: Retrieves MP4 media fragments. These fragments contain the “moof” and “mdat” MP4 atoms and their child atoms, containing the encoded fragment’s media frames and their timestamps.

        For the HLS streaming session, in-track codec private data (CPD) changes are supported. After the first media fragment is made available in a streaming session, fragments can contain CPD changes for each track. Therefore, the fragments in a session can have a different resolution, bit rate, or other information in the CPD without interrupting playback. However, any change made in the track number or track codec format can return an error when those different media fragments are loaded. For example, streaming will fail if the fragments in the stream change from having only video to having both audio and video, or if an AAC audio track is changed to an ALAW audio track. For each streaming session, only 500 CPD changes are allowed.

        Data retrieved with this action is billable. For information, see Pricing.

      • GetTSFragment: Retrieves MPEG TS fragments containing both initialization and media data for all tracks in the stream.

        If the ContainerFormat is MPEG_TS, this API is used instead of GetMP4InitFragment and GetMP4MediaFragment to retrieve stream media.

        Data retrieved with this action is billable. For more information, see Kinesis Video Streams pricing.

    A streaming session URL must not be shared between players. The service might throttle a session if multiple media players are sharing it. For connection limits, see Kinesis Video Streams Limits.

    You can monitor the amount of data that the media player consumes by monitoring the GetMP4MediaFragment.OutgoingBytes Amazon CloudWatch metric. For information about using CloudWatch to monitor Kinesis Video Streams, see Monitoring Kinesis Video Streams. For pricing information, see Amazon Kinesis Video Streams Pricing and Amazon Web Services Pricing. Charges for both HLS sessions and outgoing Amazon Web Services data apply.

    For more information about HLS, see HTTP Live Streaming on the Apple Developer site.

    If an error is thrown after invoking a Kinesis Video Streams archived media API, in addition to the HTTP status code and the response body, it includes the following pieces of information:

    • x-amz-ErrorType HTTP header – contains a more specific error type in addition to what the HTTP status code provides.

    • x-amz-RequestId HTTP header – if you want to report an issue to Amazon Web Services, the support team can better diagnose the problem if given the Request Id.

    Both the HTTP status code and the ErrorType header can be utilized to make programmatic decisions about whether errors are retry-able and under what conditions, as well as provide information on what actions the client programmer might need to take in order to successfully try again.

    For more information, see the Errors section at the bottom of this topic, as well as Common Errors.

    See

    AWSKinesisVideoArchivedMediaGetHLSStreamingSessionURLInput

    See

    AWSKinesisVideoArchivedMediaGetHLSStreamingSessionURLOutput

    Declaration

    Objective-C

    - (void)
    getHLSStreamingSessionURL:
        (nonnull AWSKinesisVideoArchivedMediaGetHLSStreamingSessionURLInput *)
            request
            completionHandler:
                (void (^_Nullable)(
                    AWSKinesisVideoArchivedMediaGetHLSStreamingSessionURLOutput
                        *_Nullable,
                    NSError *_Nullable))completionHandler;

    Swift

    func hlsStreamingSessionURL(_ request: AWSKinesisVideoArchivedMediaGetHLSStreamingSessionURLInput) async throws -> AWSKinesisVideoArchivedMediaGetHLSStreamingSessionURLOutput

    Parameters

    request

    A container for the necessary parameters to execute the GetHLSStreamingSessionURL 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 AWSKinesisVideoArchivedMediaErrorDomain domain and the following error code: AWSKinesisVideoArchivedMediaErrorResourceNotFound, AWSKinesisVideoArchivedMediaErrorInvalidArgument, AWSKinesisVideoArchivedMediaErrorClientLimitExceeded, AWSKinesisVideoArchivedMediaErrorNotAuthorized, AWSKinesisVideoArchivedMediaErrorUnsupportedStreamMediaType, AWSKinesisVideoArchivedMediaErrorNoDataRetention, AWSKinesisVideoArchivedMediaErrorMissingCodecPrivateData, AWSKinesisVideoArchivedMediaErrorInvalidCodecPrivateData.

  • Retrieves a list of images corresponding to each timestamp for a given time range, sampling interval, and image format configuration.

    See

    AWSKinesisVideoArchivedMediaGetImagesInput

    See

    AWSKinesisVideoArchivedMediaGetImagesOutput

    Declaration

    Objective-C

    - (id)getImages:(nonnull AWSKinesisVideoArchivedMediaGetImagesInput *)request;

    Swift

    func getImages(_ request: AWSKinesisVideoArchivedMediaGetImagesInput) -> Any!

    Parameters

    request

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

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSKinesisVideoArchivedMediaGetImagesOutput. On failed execution, task.error may contain an NSError with AWSKinesisVideoArchivedMediaErrorDomain domain and the following error code: AWSKinesisVideoArchivedMediaErrorResourceNotFound, AWSKinesisVideoArchivedMediaErrorInvalidArgument, AWSKinesisVideoArchivedMediaErrorClientLimitExceeded, AWSKinesisVideoArchivedMediaErrorNotAuthorized, AWSKinesisVideoArchivedMediaErrorNoDataRetention.

  • Retrieves a list of images corresponding to each timestamp for a given time range, sampling interval, and image format configuration.

    See

    AWSKinesisVideoArchivedMediaGetImagesInput

    See

    AWSKinesisVideoArchivedMediaGetImagesOutput

    Declaration

    Objective-C

    - (void)getImages:(nonnull AWSKinesisVideoArchivedMediaGetImagesInput *)request
    completionHandler:
        (void (^_Nullable)(
            AWSKinesisVideoArchivedMediaGetImagesOutput *_Nullable,
            NSError *_Nullable))completionHandler;

    Swift

    func images(_ request: AWSKinesisVideoArchivedMediaGetImagesInput) async throws -> AWSKinesisVideoArchivedMediaGetImagesOutput

    Parameters

    request

    A container for the necessary parameters to execute the GetImages 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 AWSKinesisVideoArchivedMediaErrorDomain domain and the following error code: AWSKinesisVideoArchivedMediaErrorResourceNotFound, AWSKinesisVideoArchivedMediaErrorInvalidArgument, AWSKinesisVideoArchivedMediaErrorClientLimitExceeded, AWSKinesisVideoArchivedMediaErrorNotAuthorized, AWSKinesisVideoArchivedMediaErrorNoDataRetention.

  • Gets media for a list of fragments (specified by fragment number) from the archived data in an Amazon Kinesis video stream.

    You must first call the GetDataEndpoint API to get an endpoint. Then send the GetMediaForFragmentList requests to this endpoint using the –endpoint-url parameter.

    For limits, see Kinesis Video Streams Limits.

    If an error is thrown after invoking a Kinesis Video Streams archived media API, in addition to the HTTP status code and the response body, it includes the following pieces of information:

    • x-amz-ErrorType HTTP header – contains a more specific error type in addition to what the HTTP status code provides.

    • x-amz-RequestId HTTP header – if you want to report an issue to Amazon Web Services, the support team can better diagnose the problem if given the Request Id.

    Both the HTTP status code and the ErrorType header can be utilized to make programmatic decisions about whether errors are retry-able and under what conditions, as well as provide information on what actions the client programmer might need to take in order to successfully try again.

    For more information, see the Errors section at the bottom of this topic, as well as Common Errors.

    See

    AWSKinesisVideoArchivedMediaGetMediaForFragmentListInput

    See

    AWSKinesisVideoArchivedMediaGetMediaForFragmentListOutput

    Declaration

    Objective-C

    - (id)getMediaForFragmentList:
    (nonnull AWSKinesisVideoArchivedMediaGetMediaForFragmentListInput *)request;

    Swift

    func getForFragmentList(_ request: AWSKinesisVideoArchivedMediaGetMediaForFragmentListInput) -> Any!

    Parameters

    request

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

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSKinesisVideoArchivedMediaGetMediaForFragmentListOutput. On failed execution, task.error may contain an NSError with AWSKinesisVideoArchivedMediaErrorDomain domain and the following error code: AWSKinesisVideoArchivedMediaErrorResourceNotFound, AWSKinesisVideoArchivedMediaErrorInvalidArgument, AWSKinesisVideoArchivedMediaErrorClientLimitExceeded, AWSKinesisVideoArchivedMediaErrorNotAuthorized.

  • Gets media for a list of fragments (specified by fragment number) from the archived data in an Amazon Kinesis video stream.

    You must first call the GetDataEndpoint API to get an endpoint. Then send the GetMediaForFragmentList requests to this endpoint using the –endpoint-url parameter.

    For limits, see Kinesis Video Streams Limits.

    If an error is thrown after invoking a Kinesis Video Streams archived media API, in addition to the HTTP status code and the response body, it includes the following pieces of information:

    • x-amz-ErrorType HTTP header – contains a more specific error type in addition to what the HTTP status code provides.

    • x-amz-RequestId HTTP header – if you want to report an issue to Amazon Web Services, the support team can better diagnose the problem if given the Request Id.

    Both the HTTP status code and the ErrorType header can be utilized to make programmatic decisions about whether errors are retry-able and under what conditions, as well as provide information on what actions the client programmer might need to take in order to successfully try again.

    For more information, see the Errors section at the bottom of this topic, as well as Common Errors.

    See

    AWSKinesisVideoArchivedMediaGetMediaForFragmentListInput

    See

    AWSKinesisVideoArchivedMediaGetMediaForFragmentListOutput

    Declaration

    Objective-C

    - (void)getMediaForFragmentList:
            (nonnull AWSKinesisVideoArchivedMediaGetMediaForFragmentListInput *)
                request
              completionHandler:
                  (void (^_Nullable)(
                      AWSKinesisVideoArchivedMediaGetMediaForFragmentListOutput
                          *_Nullable,
                      NSError *_Nullable))completionHandler;

    Swift

    func forFragmentList(_ request: AWSKinesisVideoArchivedMediaGetMediaForFragmentListInput) async throws -> AWSKinesisVideoArchivedMediaGetMediaForFragmentListOutput

    Parameters

    request

    A container for the necessary parameters to execute the GetMediaForFragmentList 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 AWSKinesisVideoArchivedMediaErrorDomain domain and the following error code: AWSKinesisVideoArchivedMediaErrorResourceNotFound, AWSKinesisVideoArchivedMediaErrorInvalidArgument, AWSKinesisVideoArchivedMediaErrorClientLimitExceeded, AWSKinesisVideoArchivedMediaErrorNotAuthorized.

  • Returns a list of Fragment objects from the specified stream and timestamp range within the archived data.

    Listing fragments is eventually consistent. This means that even if the producer receives an acknowledgment that a fragment is persisted, the result might not be returned immediately from a request to ListFragments. However, results are typically available in less than one second.

    You must first call the GetDataEndpoint API to get an endpoint. Then send the ListFragments requests to this endpoint using the –endpoint-url parameter.

    If an error is thrown after invoking a Kinesis Video Streams archived media API, in addition to the HTTP status code and the response body, it includes the following pieces of information:

    • x-amz-ErrorType HTTP header – contains a more specific error type in addition to what the HTTP status code provides.

    • x-amz-RequestId HTTP header – if you want to report an issue to Amazon Web Services, the support team can better diagnose the problem if given the Request Id.

    Both the HTTP status code and the ErrorType header can be utilized to make programmatic decisions about whether errors are retry-able and under what conditions, as well as provide information on what actions the client programmer might need to take in order to successfully try again.

    For more information, see the Errors section at the bottom of this topic, as well as Common Errors.

    See

    AWSKinesisVideoArchivedMediaListFragmentsInput

    See

    AWSKinesisVideoArchivedMediaListFragmentsOutput

    Declaration

    Objective-C

    - (id)listFragments:
    (nonnull AWSKinesisVideoArchivedMediaListFragmentsInput *)request;

    Swift

    func listFragments(_ request: AWSKinesisVideoArchivedMediaListFragmentsInput) -> Any!

    Parameters

    request

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

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSKinesisVideoArchivedMediaListFragmentsOutput. On failed execution, task.error may contain an NSError with AWSKinesisVideoArchivedMediaErrorDomain domain and the following error code: AWSKinesisVideoArchivedMediaErrorResourceNotFound, AWSKinesisVideoArchivedMediaErrorInvalidArgument, AWSKinesisVideoArchivedMediaErrorClientLimitExceeded, AWSKinesisVideoArchivedMediaErrorNotAuthorized.

  • Returns a list of Fragment objects from the specified stream and timestamp range within the archived data.

    Listing fragments is eventually consistent. This means that even if the producer receives an acknowledgment that a fragment is persisted, the result might not be returned immediately from a request to ListFragments. However, results are typically available in less than one second.

    You must first call the GetDataEndpoint API to get an endpoint. Then send the ListFragments requests to this endpoint using the –endpoint-url parameter.

    If an error is thrown after invoking a Kinesis Video Streams archived media API, in addition to the HTTP status code and the response body, it includes the following pieces of information:

    • x-amz-ErrorType HTTP header – contains a more specific error type in addition to what the HTTP status code provides.

    • x-amz-RequestId HTTP header – if you want to report an issue to Amazon Web Services, the support team can better diagnose the problem if given the Request Id.

    Both the HTTP status code and the ErrorType header can be utilized to make programmatic decisions about whether errors are retry-able and under what conditions, as well as provide information on what actions the client programmer might need to take in order to successfully try again.

    For more information, see the Errors section at the bottom of this topic, as well as Common Errors.

    See

    AWSKinesisVideoArchivedMediaListFragmentsInput

    See

    AWSKinesisVideoArchivedMediaListFragmentsOutput

    Declaration

    Objective-C

    - (void)listFragments:
            (nonnull AWSKinesisVideoArchivedMediaListFragmentsInput *)request
    completionHandler:
        (void (^_Nullable)(
            AWSKinesisVideoArchivedMediaListFragmentsOutput *_Nullable,
            NSError *_Nullable))completionHandler;

    Swift

    func listFragments(_ request: AWSKinesisVideoArchivedMediaListFragmentsInput) async throws -> AWSKinesisVideoArchivedMediaListFragmentsOutput

    Parameters

    request

    A container for the necessary parameters to execute the ListFragments 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 AWSKinesisVideoArchivedMediaErrorDomain domain and the following error code: AWSKinesisVideoArchivedMediaErrorResourceNotFound, AWSKinesisVideoArchivedMediaErrorInvalidArgument, AWSKinesisVideoArchivedMediaErrorClientLimitExceeded, AWSKinesisVideoArchivedMediaErrorNotAuthorized.