diff --git a/LICENSE b/LICENSE new file mode 100644 --- /dev/null +++ b/LICENSE @@ -0,0 +1,367 @@ +Mozilla Public License Version 2.0 +================================== + +1. Definitions +-------------- + +1.1. "Contributor" + means each individual or legal entity that creates, contributes to + the creation of, or owns Covered Software. + +1.2. "Contributor Version" + means the combination of the Contributions of others (if any) used + by a Contributor and that particular Contributor's Contribution. + +1.3. "Contribution" + means Covered Software of a particular Contributor. + +1.4. "Covered Software" + means Source Code Form to which the initial Contributor has attached + the notice in Exhibit A, the Executable Form of such Source Code + Form, and Modifications of such Source Code Form, in each case + including portions thereof. + +1.5. "Incompatible With Secondary Licenses" + means + + (a) that the initial Contributor has attached the notice described + in Exhibit B to the Covered Software; or + + (b) that the Covered Software was made available under the terms of + version 1.1 or earlier of the License, but not also under the + terms of a Secondary License. + +1.6. "Executable Form" + means any form of the work other than Source Code Form. + +1.7. "Larger Work" + means a work that combines Covered Software with other material, in + a separate file or files, that is not Covered Software. + +1.8. "License" + means this document. + +1.9. "Licensable" + means having the right to grant, to the maximum extent possible, + whether at the time of the initial grant or subsequently, any and + all of the rights conveyed by this License. + +1.10. "Modifications" + means any of the following: + + (a) any file in Source Code Form that results from an addition to, + deletion from, or modification of the contents of Covered + Software; or + + (b) any new file in Source Code Form that contains any Covered + Software. + +1.11. "Patent Claims" of a Contributor + means any patent claim(s), including without limitation, method, + process, and apparatus claims, in any patent Licensable by such + Contributor that would be infringed, but for the grant of the + License, by the making, using, selling, offering for sale, having + made, import, or transfer of either its Contributions or its + Contributor Version. + +1.12. "Secondary License" + means either the GNU General Public License, Version 2.0, the GNU + Lesser General Public License, Version 2.1, the GNU Affero General + Public License, Version 3.0, or any later versions of those + licenses. + +1.13. "Source Code Form" + means the form of the work preferred for making modifications. + +1.14. "You" (or "Your") + means an individual or a legal entity exercising rights under this + License. For legal entities, "You" includes any entity that + controls, is controlled by, or is under common control with You. For + purposes of this definition, "control" means (a) the power, direct + or indirect, to cause the direction or management of such entity, + whether by contract or otherwise, or (b) ownership of more than + fifty percent (50%) of the outstanding shares or beneficial + ownership of such entity. + +2. License Grants and Conditions +-------------------------------- + +2.1. Grants + +Each Contributor hereby grants You a world-wide, royalty-free, +non-exclusive license: + +(a) under intellectual property rights (other than patent or trademark) + Licensable by such Contributor to use, reproduce, make available, + modify, display, perform, distribute, and otherwise exploit its + Contributions, either on an unmodified basis, with Modifications, or + as part of a Larger Work; and + +(b) under Patent Claims of such Contributor to make, use, sell, offer + for sale, have made, import, and otherwise transfer either its + Contributions or its Contributor Version. + +2.2. Effective Date + +The licenses granted in Section 2.1 with respect to any Contribution +become effective for each Contribution on the date the Contributor first +distributes such Contribution. + +2.3. Limitations on Grant Scope + +The licenses granted in this Section 2 are the only rights granted under +this License. No additional rights or licenses will be implied from the +distribution or licensing of Covered Software under this License. +Notwithstanding Section 2.1(b) above, no patent license is granted by a +Contributor: + +(a) for any code that a Contributor has removed from Covered Software; + or + +(b) for infringements caused by: (i) Your and any other third party's + modifications of Covered Software, or (ii) the combination of its + Contributions with other software (except as part of its Contributor + Version); or + +(c) under Patent Claims infringed by Covered Software in the absence of + its Contributions. + +This License does not grant any rights in the trademarks, service marks, +or logos of any Contributor (except as may be necessary to comply with +the notice requirements in Section 3.4). + +2.4. Subsequent Licenses + +No Contributor makes additional grants as a result of Your choice to +distribute the Covered Software under a subsequent version of this +License (see Section 10.2) or under the terms of a Secondary License (if +permitted under the terms of Section 3.3). + +2.5. Representation + +Each Contributor represents that the Contributor believes its +Contributions are its original creation(s) or it has sufficient rights +to grant the rights to its Contributions conveyed by this License. + +2.6. Fair Use + +This License is not intended to limit any rights You have under +applicable copyright doctrines of fair use, fair dealing, or other +equivalents. + +2.7. Conditions + +Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted +in Section 2.1. + +3. Responsibilities +------------------- + +3.1. Distribution of Source Form + +All distribution of Covered Software in Source Code Form, including any +Modifications that You create or to which You contribute, must be under +the terms of this License. You must inform recipients that the Source +Code Form of the Covered Software is governed by the terms of this +License, and how they can obtain a copy of this License. You may not +attempt to alter or restrict the recipients' rights in the Source Code +Form. + +3.2. Distribution of Executable Form + +If You distribute Covered Software in Executable Form then: + +(a) such Covered Software must also be made available in Source Code + Form, as described in Section 3.1, and You must inform recipients of + the Executable Form how they can obtain a copy of such Source Code + Form by reasonable means in a timely manner, at a charge no more + than the cost of distribution to the recipient; and + +(b) You may distribute such Executable Form under the terms of this + License, or sublicense it under different terms, provided that the + license for the Executable Form does not attempt to limit or alter + the recipients' rights in the Source Code Form under this License. + +3.3. Distribution of a Larger Work + +You may create and distribute a Larger Work under terms of Your choice, +provided that You also comply with the requirements of this License for +the Covered Software. If the Larger Work is a combination of Covered +Software with a work governed by one or more Secondary Licenses, and the +Covered Software is not Incompatible With Secondary Licenses, this +License permits You to additionally distribute such Covered Software +under the terms of such Secondary License(s), so that the recipient of +the Larger Work may, at their option, further distribute the Covered +Software under the terms of either this License or such Secondary +License(s). + +3.4. Notices + +You may not remove or alter the substance of any license notices +(including copyright notices, patent notices, disclaimers of warranty, +or limitations of liability) contained within the Source Code Form of +the Covered Software, except that You may alter any license notices to +the extent required to remedy known factual inaccuracies. + +3.5. Application of Additional Terms + +You may choose to offer, and to charge a fee for, warranty, support, +indemnity or liability obligations to one or more recipients of Covered +Software. However, You may do so only on Your own behalf, and not on +behalf of any Contributor. You must make it absolutely clear that any +such warranty, support, indemnity, or liability obligation is offered by +You alone, and You hereby agree to indemnify every Contributor for any +liability incurred by such Contributor as a result of warranty, support, +indemnity or liability terms You offer. You may include additional +disclaimers of warranty and limitations of liability specific to any +jurisdiction. + +4. Inability to Comply Due to Statute or Regulation +--------------------------------------------------- + +If it is impossible for You to comply with any of the terms of this +License with respect to some or all of the Covered Software due to +statute, judicial order, or regulation then You must: (a) comply with +the terms of this License to the maximum extent possible; and (b) +describe the limitations and the code they affect. Such description must +be placed in a text file included with all distributions of the Covered +Software under this License. Except to the extent prohibited by statute +or regulation, such description must be sufficiently detailed for a +recipient of ordinary skill to be able to understand it. + +5. Termination +-------------- + +5.1. The rights granted under this License will terminate automatically +if You fail to comply with any of its terms. However, if You become +compliant, then the rights granted under this License from a particular +Contributor are reinstated (a) provisionally, unless and until such +Contributor explicitly and finally terminates Your grants, and (b) on an +ongoing basis, if such Contributor fails to notify You of the +non-compliance by some reasonable means prior to 60 days after You have +come back into compliance. Moreover, Your grants from a particular +Contributor are reinstated on an ongoing basis if such Contributor +notifies You of the non-compliance by some reasonable means, this is the +first time You have received notice of non-compliance with this License +from such Contributor, and You become compliant prior to 30 days after +Your receipt of the notice. + +5.2. If You initiate litigation against any entity by asserting a patent +infringement claim (excluding declaratory judgment actions, +counter-claims, and cross-claims) alleging that a Contributor Version +directly or indirectly infringes any patent, then the rights granted to +You by any and all Contributors for the Covered Software under Section +2.1 of this License shall terminate. + +5.3. In the event of termination under Sections 5.1 or 5.2 above, all +end user license agreements (excluding distributors and resellers) which +have been validly granted by You or Your distributors under this License +prior to termination shall survive termination. + +************************************************************************ +* * +* 6. Disclaimer of Warranty * +* ------------------------- * +* * +* Covered Software is provided under this License on an "as is" * +* basis, without warranty of any kind, either expressed, implied, or * +* statutory, including, without limitation, warranties that the * +* Covered Software is free of defects, merchantable, fit for a * +* particular purpose or non-infringing. The entire risk as to the * +* quality and performance of the Covered Software is with You. * +* Should any Covered Software prove defective in any respect, You * +* (not any Contributor) assume the cost of any necessary servicing, * +* repair, or correction. This disclaimer of warranty constitutes an * +* essential part of this License. No use of any Covered Software is * +* authorized under this License except under this disclaimer. * +* * +************************************************************************ + +************************************************************************ +* * +* 7. Limitation of Liability * +* -------------------------- * +* * +* Under no circumstances and under no legal theory, whether tort * +* (including negligence), contract, or otherwise, shall any * +* Contributor, or anyone who distributes Covered Software as * +* permitted above, be liable to You for any direct, indirect, * +* special, incidental, or consequential damages of any character * +* including, without limitation, damages for lost profits, loss of * +* goodwill, work stoppage, computer failure or malfunction, or any * +* and all other commercial damages or losses, even if such party * +* shall have been informed of the possibility of such damages. This * +* limitation of liability shall not apply to liability for death or * +* personal injury resulting from such party's negligence to the * +* extent applicable law prohibits such limitation. Some * +* jurisdictions do not allow the exclusion or limitation of * +* incidental or consequential damages, so this exclusion and * +* limitation may not apply to You. * +* * +************************************************************************ + +8. Litigation +------------- + +Any litigation relating to this License may be brought only in the +courts of a jurisdiction where the defendant maintains its principal +place of business and such litigation shall be governed by laws of that +jurisdiction, without reference to its conflict-of-law provisions. +Nothing in this Section shall prevent a party's ability to bring +cross-claims or counter-claims. + +9. Miscellaneous +---------------- + +This License represents the complete agreement concerning the subject +matter hereof. If any provision of this License is held to be +unenforceable, such provision shall be reformed only to the extent +necessary to make it enforceable. Any law or regulation which provides +that the language of a contract shall be construed against the drafter +shall not be used to construe this License against a Contributor. + +10. Versions of the License +--------------------------- + +10.1. New Versions + +Mozilla Foundation is the license steward. Except as provided in Section +10.3, no one other than the license steward has the right to modify or +publish new versions of this License. Each version will be given a +distinguishing version number. + +10.2. Effect of New Versions + +You may distribute the Covered Software under the terms of the version +of the License under which You originally received the Covered Software, +or under the terms of any subsequent version published by the license +steward. + +10.3. Modified Versions + +If you create software not governed by this License, and you want to +create a new license for such software, you may create and use a +modified version of this License if you rename the license and remove +any references to the name of the license steward (except to note that +such modified license differs from this License). + +10.4. Distributing Source Code Form that is Incompatible With Secondary +Licenses + +If You choose to distribute Source Code Form that is Incompatible With +Secondary Licenses under the terms of this version of the License, the +notice described in Exhibit B of this License must be attached. + +Exhibit A - Source Code Form License Notice +------------------------------------------- + + This Source Code Form is subject to the terms of the Mozilla Public + License, v. 2.0. If a copy of the MPL was not distributed with this + file, You can obtain one at http://mozilla.org/MPL/2.0/. + +If it is not possible or desirable to put the notice in a particular +file, then You may include the notice in a location (such as a LICENSE +file in a relevant directory) where a recipient would be likely to look +for such a notice. + +You may add additional accurate notices of copyright ownership. diff --git a/README.md b/README.md new file mode 100644 --- /dev/null +++ b/README.md @@ -0,0 +1,45 @@ +# Amazon Kinesis Video Streams Media SDK + +* [Version](#version) +* [Description](#description) +* [Contribute](#contribute) +* [Licence](#licence) + + +## Version + +`1.6.0` + + +## Description + +Documentation is available via [Hackage](http://hackage.haskell.org/package/amazonka-kinesis-video-media) +and the [AWS API Reference](https://aws.amazon.com/documentation/). + +The types from this library are intended to be used with [amazonka](http://hackage.haskell.org/package/amazonka), +which provides mechanisms for specifying AuthN/AuthZ information, sending requests, +and receiving responses. + +Lenses are used for constructing and manipulating types, +due to the depth of nesting of AWS types and transparency regarding +de/serialisation into more palatable Haskell values. +The provided lenses should be compatible with any of the major lens libraries +[lens](http://hackage.haskell.org/package/lens) or [lens-family-core](http://hackage.haskell.org/package/lens-family-core). + +See [Network.AWS.KinesisVideoMedia](http://hackage.haskell.org/package/amazonka-kinesis-video-media/docs/Network-AWS-KinesisVideoMedia.html) +or [the AWS documentation](https://aws.amazon.com/documentation/) to get started. + + +## Contribute + +For any problems, comments, or feedback please create an issue [here on GitHub](https://github.com/brendanhay/amazonka/issues). + +> _Note:_ this library is an auto-generated Haskell package. Please see `amazonka-gen` for more information. + + +## Licence + +`amazonka-kinesis-video-media` is released under the [Mozilla Public License Version 2.0](http://www.mozilla.org/MPL/). + +Parts of the code are derived from AWS service descriptions, licensed under Apache 2.0. +Source files subject to this contain an additional licensing clause in their header. diff --git a/Setup.hs b/Setup.hs new file mode 100644 --- /dev/null +++ b/Setup.hs @@ -0,0 +1,2 @@ +import Distribution.Simple +main = defaultMain diff --git a/amazonka-kinesis-video-media.cabal b/amazonka-kinesis-video-media.cabal new file mode 100644 --- /dev/null +++ b/amazonka-kinesis-video-media.cabal @@ -0,0 +1,86 @@ +name: amazonka-kinesis-video-media +version: 1.6.0 +synopsis: Amazon Kinesis Video Streams Media SDK. +homepage: https://github.com/brendanhay/amazonka +bug-reports: https://github.com/brendanhay/amazonka/issues +license: MPL-2.0 +license-file: LICENSE +author: Brendan Hay +maintainer: Brendan Hay +copyright: Copyright (c) 2013-2018 Brendan Hay +category: Network, AWS, Cloud, Distributed Computing +build-type: Simple +cabal-version: >= 1.10 +extra-source-files: README.md fixture/*.yaml fixture/*.proto src/.gitkeep +description: + The types from this library are intended to be used with + , which provides + mechanisms for specifying AuthN/AuthZ information, sending requests, + and receiving responses. + . + Lenses are used for constructing and manipulating types, + due to the depth of nesting of AWS types and transparency regarding + de/serialisation into more palatable Haskell values. + The provided lenses should be compatible with any of the major lens libraries + such as or + . + . + See "Network.AWS.KinesisVideoMedia" or + to get started. + +source-repository head + type: git + location: git://github.com/brendanhay/amazonka.git + subdir: amazonka-kinesis-video-media + +library + default-language: Haskell2010 + hs-source-dirs: src gen + + ghc-options: + -Wall + -fwarn-incomplete-uni-patterns + -fwarn-incomplete-record-updates + -funbox-strict-fields + + exposed-modules: + Network.AWS.KinesisVideoMedia + , Network.AWS.KinesisVideoMedia.GetMedia + , Network.AWS.KinesisVideoMedia.Types + , Network.AWS.KinesisVideoMedia.Waiters + + other-modules: + Network.AWS.KinesisVideoMedia.Types.Product + , Network.AWS.KinesisVideoMedia.Types.Sum + + build-depends: + amazonka-core == 1.6.0.* + , base >= 4.7 && < 5 + +test-suite amazonka-kinesis-video-media-test + type: exitcode-stdio-1.0 + default-language: Haskell2010 + hs-source-dirs: test + main-is: Main.hs + + ghc-options: -Wall -threaded + + -- This section is encoded by the template and any modules added by + -- hand outside these namespaces will not correctly be added to the + -- distribution package. + other-modules: + Test.AWS.KinesisVideoMedia + , Test.AWS.Gen.KinesisVideoMedia + , Test.AWS.KinesisVideoMedia.Internal + + build-depends: + amazonka-core == 1.6.0.* + , amazonka-test == 1.6.0.* + , amazonka-kinesis-video-media + , base + , bytestring + , tasty + , tasty-hunit + , text + , time + , unordered-containers diff --git a/fixture/GetMedia.yaml b/fixture/GetMedia.yaml new file mode 100644 --- /dev/null +++ b/fixture/GetMedia.yaml @@ -0,0 +1,10 @@ +--- +method: POST +headers: + Authorization: AWS4-HMAC-SHA256 Credential=access/20091028/us-east-1/kinesisvideo/aws4_request, SignedHeaders=content-type;host;x-amz-content-sha256;x-amz-date, Signature=? + Host: kinesisvideo.us-east-1.amazonaws.com + Content-Type: application/x-www-form-urlencoded; charset=utf-8 + X-Amz-Content-SHA256: abcdef + X-Amz-Date: 20091028T223200Z +body: + '' diff --git a/fixture/GetMediaResponse.proto b/fixture/GetMediaResponse.proto new file mode 100644 --- /dev/null +++ b/fixture/GetMediaResponse.proto diff --git a/gen/Network/AWS/KinesisVideoMedia.hs b/gen/Network/AWS/KinesisVideoMedia.hs new file mode 100644 --- /dev/null +++ b/gen/Network/AWS/KinesisVideoMedia.hs @@ -0,0 +1,98 @@ +{-# OPTIONS_GHC -fno-warn-unused-imports #-} +{-# OPTIONS_GHC -fno-warn-duplicate-exports #-} + +-- Derived from AWS service descriptions, licensed under Apache 2.0. + +-- | +-- Module : Network.AWS.KinesisVideoMedia +-- Copyright : (c) 2013-2018 Brendan Hay +-- License : Mozilla Public License, v. 2.0. +-- Maintainer : Brendan Hay +-- Stability : auto-generated +-- Portability : non-portable (GHC extensions) +-- +-- +-- +-- +module Network.AWS.KinesisVideoMedia + ( + -- * Service Configuration + kinesisVideoMedia + + -- * Errors + -- $errors + + -- ** ConnectionLimitExceededException + , _ConnectionLimitExceededException + + -- ** InvalidArgumentException + , _InvalidArgumentException + + -- ** NotAuthorizedException + , _NotAuthorizedException + + -- ** ClientLimitExceededException + , _ClientLimitExceededException + + -- ** InvalidEndpointException + , _InvalidEndpointException + + -- ** ResourceNotFoundException + , _ResourceNotFoundException + + -- * Waiters + -- $waiters + + -- * Operations + -- $operations + + -- ** GetMedia + , module Network.AWS.KinesisVideoMedia.GetMedia + + -- * Types + + -- ** StartSelectorType + , StartSelectorType (..) + + -- ** StartSelector + , StartSelector + , startSelector + , ssContinuationToken + , ssAfterFragmentNumber + , ssStartTimestamp + , ssStartSelectorType + ) where + +import Network.AWS.KinesisVideoMedia.GetMedia +import Network.AWS.KinesisVideoMedia.Types +import Network.AWS.KinesisVideoMedia.Waiters + +{- $errors +Error matchers are designed for use with the functions provided by +. +This allows catching (and rethrowing) service specific errors returned +by 'KinesisVideoMedia'. +-} + +{- $operations +Some AWS operations return results that are incomplete and require subsequent +requests in order to obtain the entire result set. The process of sending +subsequent requests to continue where a previous request left off is called +pagination. For example, the 'ListObjects' operation of Amazon S3 returns up to +1000 objects at a time, and you must send subsequent requests with the +appropriate Marker in order to retrieve the next page of results. + +Operations that have an 'AWSPager' instance can transparently perform subsequent +requests, correctly setting Markers and other request facets to iterate through +the entire result set of a truncated API operation. Operations which support +this have an additional note in the documentation. + +Many operations have the ability to filter results on the server side. See the +individual operation parameters for details. +-} + +{- $waiters +Waiters poll by repeatedly sending a request until some remote success condition +configured by the 'Wait' specification is fulfilled. The 'Wait' specification +determines how many attempts should be made, in addition to delay and retry strategies. +-} diff --git a/gen/Network/AWS/KinesisVideoMedia/GetMedia.hs b/gen/Network/AWS/KinesisVideoMedia/GetMedia.hs new file mode 100644 --- /dev/null +++ b/gen/Network/AWS/KinesisVideoMedia/GetMedia.hs @@ -0,0 +1,170 @@ +{-# LANGUAGE DeriveDataTypeable #-} +{-# LANGUAGE DeriveGeneric #-} +{-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE RecordWildCards #-} +{-# LANGUAGE TypeFamilies #-} + +{-# OPTIONS_GHC -fno-warn-unused-imports #-} +{-# OPTIONS_GHC -fno-warn-unused-binds #-} +{-# OPTIONS_GHC -fno-warn-unused-matches #-} + +-- Derived from AWS service descriptions, licensed under Apache 2.0. + +-- | +-- Module : Network.AWS.KinesisVideoMedia.GetMedia +-- Copyright : (c) 2013-2018 Brendan Hay +-- License : Mozilla Public License, v. 2.0. +-- Maintainer : Brendan Hay +-- Stability : auto-generated +-- Portability : non-portable (GHC extensions) +-- +-- Use this API to retrieve media content from a Kinesis video stream. In the request, you identify stream name or stream Amazon Resource Name (ARN), and the starting chunk. Kinesis Video Streams then returns a stream of chunks in order by fragment number. +-- +-- +-- When you put media data (fragments) on a stream, Kinesis Video Streams stores each incoming fragment and related metadata in what is called a "chunk." For more information, see . The @GetMedia@ API returns a stream of these chunks starting from the chunk that you specify in the request. +-- +-- The following limits apply when using the @GetMedia@ API: +-- +-- * A client can call @GetMedia@ up to five times per second per stream. +-- +-- * Kinesis Video Streams sends media data at a rate of up to 25 megabytes per second (or 200 megabits per second) during a @GetMedia@ session. +-- +-- +-- +module Network.AWS.KinesisVideoMedia.GetMedia + ( + -- * Creating a Request + getMedia + , GetMedia + -- * Request Lenses + , gmStreamARN + , gmStreamName + , gmStartSelector + + -- * Destructuring the Response + , getMediaResponse + , GetMediaResponse + -- * Response Lenses + , gmrsContentType + , gmrsResponseStatus + , gmrsPayload + ) where + +import Network.AWS.KinesisVideoMedia.Types +import Network.AWS.KinesisVideoMedia.Types.Product +import Network.AWS.Lens +import Network.AWS.Prelude +import Network.AWS.Request +import Network.AWS.Response + +-- | /See:/ 'getMedia' smart constructor. +data GetMedia = GetMedia' + { _gmStreamARN :: !(Maybe Text) + , _gmStreamName :: !(Maybe Text) + , _gmStartSelector :: !StartSelector + } deriving (Eq, Read, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'GetMedia' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'gmStreamARN' - The ARN of the stream from where you want to get the media content. If you don't specify the @streamARN@ , you must specify the @streamName@ . +-- +-- * 'gmStreamName' - The Kinesis video stream name from where you want to get the media content. If you don't specify the @streamName@ , you must specify the @streamARN@ . +-- +-- * 'gmStartSelector' - Identifies the starting chunk to get from the specified stream. +getMedia + :: StartSelector -- ^ 'gmStartSelector' + -> GetMedia +getMedia pStartSelector_ = + GetMedia' + { _gmStreamARN = Nothing + , _gmStreamName = Nothing + , _gmStartSelector = pStartSelector_ + } + + +-- | The ARN of the stream from where you want to get the media content. If you don't specify the @streamARN@ , you must specify the @streamName@ . +gmStreamARN :: Lens' GetMedia (Maybe Text) +gmStreamARN = lens _gmStreamARN (\ s a -> s{_gmStreamARN = a}) + +-- | The Kinesis video stream name from where you want to get the media content. If you don't specify the @streamName@ , you must specify the @streamARN@ . +gmStreamName :: Lens' GetMedia (Maybe Text) +gmStreamName = lens _gmStreamName (\ s a -> s{_gmStreamName = a}) + +-- | Identifies the starting chunk to get from the specified stream. +gmStartSelector :: Lens' GetMedia StartSelector +gmStartSelector = lens _gmStartSelector (\ s a -> s{_gmStartSelector = a}) + +instance AWSRequest GetMedia where + type Rs GetMedia = GetMediaResponse + request = postJSON kinesisVideoMedia + response + = receiveBody + (\ s h x -> + GetMediaResponse' <$> + (h .#? "Content-Type") <*> (pure (fromEnum s)) <*> + (pure x)) + +instance Hashable GetMedia where + +instance NFData GetMedia where + +instance ToHeaders GetMedia where + toHeaders = const mempty + +instance ToJSON GetMedia where + toJSON GetMedia'{..} + = object + (catMaybes + [("StreamARN" .=) <$> _gmStreamARN, + ("StreamName" .=) <$> _gmStreamName, + Just ("StartSelector" .= _gmStartSelector)]) + +instance ToPath GetMedia where + toPath = const "/getMedia" + +instance ToQuery GetMedia where + toQuery = const mempty + +-- | /See:/ 'getMediaResponse' smart constructor. +data GetMediaResponse = GetMediaResponse' + { _gmrsContentType :: !(Maybe Text) + , _gmrsResponseStatus :: !Int + , _gmrsPayload :: !RsBody + } deriving (Show, Generic) + + +-- | Creates a value of 'GetMediaResponse' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'gmrsContentType' - The content type of the requested media. +-- +-- * 'gmrsResponseStatus' - -- | The response status code. +-- +-- * 'gmrsPayload' - The payload Kinesis Video Streams returns is a sequence of chunks from the specified stream. For information about the chunks, see . The chunks that Kinesis Video Streams returns in the @GetMedia@ call also include the following additional Matroska (MKV) tags: * AWS_KINESISVIDEO_CONTINUATION_TOKEN (UTF-8 string) - In the event your @GetMedia@ call terminates, you can use this continuation token in your next request to get the next chunk where the last request terminated. * AWS_KINESISVIDEO_MILLIS_BEHIND_NOW (UTF-8 string) - Client applications can use this tag value to determine how far behind the chunk returned in the response is from the latest chunk on the stream. * AWS_KINESISVIDEO_FRAGMENT_NUMBER - Fragment number returned in the chunk. * AWS_KINESISVIDEO_SERVER_TIMESTAMP - Server time stamp of the fragment. * AWS_KINESISVIDEO_PRODUCER_TIMESTAMP - Producer time stamp of the fragment. The following tags will be present if an error occurs: * AWS_KINESISVIDEO_ERROR_CODE - String description of an error that caused GetMedia to stop. * AWS_KINESISVIDEO_ERROR_ID: Integer code of the error. The error codes are as follows: * 3002 - Error writing to the stream * 4000 - Requested fragment is not found * 4500 - Access denied for the stream's KMS key * 4501 - Stream's KMS key is disabled * 4502 - Validation error on the Stream's KMS key * 4503 - KMS key specified in the stream is unavailable * 4504 - Invalid usage of the KMS key specified in the stream * 4505 - Invalid state of the KMS key specified in the stream * 4506 - Unable to find the KMS key specified in the stream * 5000 - Internal error +getMediaResponse + :: Int -- ^ 'gmrsResponseStatus' + -> RsBody -- ^ 'gmrsPayload' + -> GetMediaResponse +getMediaResponse pResponseStatus_ pPayload_ = + GetMediaResponse' + { _gmrsContentType = Nothing + , _gmrsResponseStatus = pResponseStatus_ + , _gmrsPayload = pPayload_ + } + + +-- | The content type of the requested media. +gmrsContentType :: Lens' GetMediaResponse (Maybe Text) +gmrsContentType = lens _gmrsContentType (\ s a -> s{_gmrsContentType = a}) + +-- | -- | The response status code. +gmrsResponseStatus :: Lens' GetMediaResponse Int +gmrsResponseStatus = lens _gmrsResponseStatus (\ s a -> s{_gmrsResponseStatus = a}) + +-- | The payload Kinesis Video Streams returns is a sequence of chunks from the specified stream. For information about the chunks, see . The chunks that Kinesis Video Streams returns in the @GetMedia@ call also include the following additional Matroska (MKV) tags: * AWS_KINESISVIDEO_CONTINUATION_TOKEN (UTF-8 string) - In the event your @GetMedia@ call terminates, you can use this continuation token in your next request to get the next chunk where the last request terminated. * AWS_KINESISVIDEO_MILLIS_BEHIND_NOW (UTF-8 string) - Client applications can use this tag value to determine how far behind the chunk returned in the response is from the latest chunk on the stream. * AWS_KINESISVIDEO_FRAGMENT_NUMBER - Fragment number returned in the chunk. * AWS_KINESISVIDEO_SERVER_TIMESTAMP - Server time stamp of the fragment. * AWS_KINESISVIDEO_PRODUCER_TIMESTAMP - Producer time stamp of the fragment. The following tags will be present if an error occurs: * AWS_KINESISVIDEO_ERROR_CODE - String description of an error that caused GetMedia to stop. * AWS_KINESISVIDEO_ERROR_ID: Integer code of the error. The error codes are as follows: * 3002 - Error writing to the stream * 4000 - Requested fragment is not found * 4500 - Access denied for the stream's KMS key * 4501 - Stream's KMS key is disabled * 4502 - Validation error on the Stream's KMS key * 4503 - KMS key specified in the stream is unavailable * 4504 - Invalid usage of the KMS key specified in the stream * 4505 - Invalid state of the KMS key specified in the stream * 4506 - Unable to find the KMS key specified in the stream * 5000 - Internal error +gmrsPayload :: Lens' GetMediaResponse RsBody +gmrsPayload = lens _gmrsPayload (\ s a -> s{_gmrsPayload = a}) diff --git a/gen/Network/AWS/KinesisVideoMedia/Types.hs b/gen/Network/AWS/KinesisVideoMedia/Types.hs new file mode 100644 --- /dev/null +++ b/gen/Network/AWS/KinesisVideoMedia/Types.hs @@ -0,0 +1,134 @@ +{-# LANGUAGE OverloadedStrings #-} + +-- Derived from AWS service descriptions, licensed under Apache 2.0. + +-- | +-- Module : Network.AWS.KinesisVideoMedia.Types +-- Copyright : (c) 2013-2018 Brendan Hay +-- License : Mozilla Public License, v. 2.0. +-- Maintainer : Brendan Hay +-- Stability : auto-generated +-- Portability : non-portable (GHC extensions) +-- +module Network.AWS.KinesisVideoMedia.Types + ( + -- * Service Configuration + kinesisVideoMedia + + -- * Errors + , _ConnectionLimitExceededException + , _InvalidArgumentException + , _NotAuthorizedException + , _ClientLimitExceededException + , _InvalidEndpointException + , _ResourceNotFoundException + + -- * StartSelectorType + , StartSelectorType (..) + + -- * StartSelector + , StartSelector + , startSelector + , ssContinuationToken + , ssAfterFragmentNumber + , ssStartTimestamp + , ssStartSelectorType + ) where + +import Network.AWS.KinesisVideoMedia.Types.Product +import Network.AWS.KinesisVideoMedia.Types.Sum +import Network.AWS.Lens +import Network.AWS.Prelude +import Network.AWS.Sign.V4 + +-- | API version @2017-09-30@ of the Amazon Kinesis Video Streams Media SDK configuration. +kinesisVideoMedia :: Service +kinesisVideoMedia = + Service + { _svcAbbrev = "KinesisVideoMedia" + , _svcSigner = v4 + , _svcPrefix = "kinesisvideo" + , _svcVersion = "2017-09-30" + , _svcEndpoint = defaultEndpoint kinesisVideoMedia + , _svcTimeout = Just 70 + , _svcCheck = statusSuccess + , _svcError = parseJSONError "KinesisVideoMedia" + , _svcRetry = retry + } + where + retry = + Exponential + { _retryBase = 5.0e-2 + , _retryGrowth = 2 + , _retryAttempts = 5 + , _retryCheck = check + } + check e + | has (hasCode "ThrottledException" . hasStatus 400) e = + Just "throttled_exception" + | has (hasStatus 429) e = Just "too_many_requests" + | has (hasCode "ThrottlingException" . hasStatus 400) e = + Just "throttling_exception" + | has (hasCode "Throttling" . hasStatus 400) e = Just "throttling" + | has (hasStatus 504) e = Just "gateway_timeout" + | has (hasCode "RequestThrottledException" . hasStatus 400) e = + Just "request_throttled_exception" + | has (hasStatus 502) e = Just "bad_gateway" + | has (hasStatus 503) e = Just "service_unavailable" + | has (hasStatus 500) e = Just "general_server_error" + | has (hasStatus 509) e = Just "limit_exceeded" + | otherwise = Nothing + + +-- | Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client connections. +-- +-- +_ConnectionLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError +_ConnectionLimitExceededException = + _MatchServiceError kinesisVideoMedia "ConnectionLimitExceededException" . + hasStatus 400 + + +-- | The value for this input parameter is invalid. +-- +-- +_InvalidArgumentException :: AsError a => Getting (First ServiceError) a ServiceError +_InvalidArgumentException = + _MatchServiceError kinesisVideoMedia "InvalidArgumentException" . + hasStatus 400 + + +-- | Status Code: 403, The caller is not authorized to perform an operation on the given stream, or the token has expired. +-- +-- +_NotAuthorizedException :: AsError a => Getting (First ServiceError) a ServiceError +_NotAuthorizedException = + _MatchServiceError kinesisVideoMedia "NotAuthorizedException" . hasStatus 401 + + +-- | Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later. +-- +-- +_ClientLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError +_ClientLimitExceededException = + _MatchServiceError kinesisVideoMedia "ClientLimitExceededException" . + hasStatus 400 + + +-- | Status Code: 400, Caller used wrong endpoint to write data to a stream. On receiving such an exception, the user must call @GetDataEndpoint@ with @AccessMode@ set to "READ" and use the endpoint Kinesis Video returns in the next @GetMedia@ call. +-- +-- +_InvalidEndpointException :: AsError a => Getting (First ServiceError) a ServiceError +_InvalidEndpointException = + _MatchServiceError kinesisVideoMedia "InvalidEndpointException" . + hasStatus 400 + + +-- | Status Code: 404, The stream with the given name does not exist. +-- +-- +_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError +_ResourceNotFoundException = + _MatchServiceError kinesisVideoMedia "ResourceNotFoundException" . + hasStatus 404 + diff --git a/gen/Network/AWS/KinesisVideoMedia/Types/Product.hs b/gen/Network/AWS/KinesisVideoMedia/Types/Product.hs new file mode 100644 --- /dev/null +++ b/gen/Network/AWS/KinesisVideoMedia/Types/Product.hs @@ -0,0 +1,96 @@ +{-# LANGUAGE DeriveDataTypeable #-} +{-# LANGUAGE DeriveGeneric #-} +{-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE RecordWildCards #-} + +{-# OPTIONS_GHC -fno-warn-unused-imports #-} + +-- Derived from AWS service descriptions, licensed under Apache 2.0. + +-- | +-- Module : Network.AWS.KinesisVideoMedia.Types.Product +-- Copyright : (c) 2013-2018 Brendan Hay +-- License : Mozilla Public License, v. 2.0. +-- Maintainer : Brendan Hay +-- Stability : auto-generated +-- Portability : non-portable (GHC extensions) +-- +module Network.AWS.KinesisVideoMedia.Types.Product where + +import Network.AWS.KinesisVideoMedia.Types.Sum +import Network.AWS.Lens +import Network.AWS.Prelude + +-- | Identifies the chunk on the Kinesis video stream where you want the @GetMedia@ API to start returning media data. You have the following options to identify the starting chunk: +-- +-- +-- * Choose the latest (or oldest) chunk. +-- +-- * Identify a specific chunk. You can identify a specific chunk either by providing a fragment number or time stamp (server or producer). +-- +-- * Each chunk's metadata includes a continuation token as a Matroska (MKV) tag (@AWS_KINESISVIDEO_CONTINUATION_TOKEN@ ). If your previous @GetMedia@ request terminated, you can use this tag value in your next @GetMedia@ request. The API then starts returning chunks starting where the last API ended. +-- +-- +-- +-- +-- /See:/ 'startSelector' smart constructor. +data StartSelector = StartSelector' + { _ssContinuationToken :: !(Maybe Text) + , _ssAfterFragmentNumber :: !(Maybe Text) + , _ssStartTimestamp :: !(Maybe POSIX) + , _ssStartSelectorType :: !StartSelectorType + } deriving (Eq, Read, Show, Data, Typeable, Generic) + + +-- | Creates a value of 'StartSelector' with the minimum fields required to make a request. +-- +-- Use one of the following lenses to modify other fields as desired: +-- +-- * 'ssContinuationToken' - Continuation token that Kinesis Video Streams returned in the previous @GetMedia@ response. The @GetMedia@ API then starts with the chunk identified by the continuation token. +-- +-- * 'ssAfterFragmentNumber' - Specifies the fragment number from where you want the @GetMedia@ API to start returning the fragments. +-- +-- * 'ssStartTimestamp' - A time stamp value. This value is required if you choose the PRODUCER_TIMESTAMP or the SERVER_TIMESTAMP as the @startSelectorType@ . The @GetMedia@ API then starts with the chunk containing the fragment that has the specified time stamp. +-- +-- * 'ssStartSelectorType' - Identifies the fragment on the Kinesis video stream where you want to start getting the data from. * NOW - Start with the latest chunk on the stream. * EARLIEST - Start with earliest available chunk on the stream. * FRAGMENT_NUMBER - Start with the chunk containing the specific fragment. You must also specify the @StartFragmentNumber@ . * PRODUCER_TIMESTAMP or SERVER_TIMESTAMP - Start with the chunk containing a fragment with the specified producer or server time stamp. You specify the time stamp by adding @StartTimestamp@ . * CONTINUATION_TOKEN - Read using the specified continuation token. +startSelector + :: StartSelectorType -- ^ 'ssStartSelectorType' + -> StartSelector +startSelector pStartSelectorType_ = + StartSelector' + { _ssContinuationToken = Nothing + , _ssAfterFragmentNumber = Nothing + , _ssStartTimestamp = Nothing + , _ssStartSelectorType = pStartSelectorType_ + } + + +-- | Continuation token that Kinesis Video Streams returned in the previous @GetMedia@ response. The @GetMedia@ API then starts with the chunk identified by the continuation token. +ssContinuationToken :: Lens' StartSelector (Maybe Text) +ssContinuationToken = lens _ssContinuationToken (\ s a -> s{_ssContinuationToken = a}) + +-- | Specifies the fragment number from where you want the @GetMedia@ API to start returning the fragments. +ssAfterFragmentNumber :: Lens' StartSelector (Maybe Text) +ssAfterFragmentNumber = lens _ssAfterFragmentNumber (\ s a -> s{_ssAfterFragmentNumber = a}) + +-- | A time stamp value. This value is required if you choose the PRODUCER_TIMESTAMP or the SERVER_TIMESTAMP as the @startSelectorType@ . The @GetMedia@ API then starts with the chunk containing the fragment that has the specified time stamp. +ssStartTimestamp :: Lens' StartSelector (Maybe UTCTime) +ssStartTimestamp = lens _ssStartTimestamp (\ s a -> s{_ssStartTimestamp = a}) . mapping _Time + +-- | Identifies the fragment on the Kinesis video stream where you want to start getting the data from. * NOW - Start with the latest chunk on the stream. * EARLIEST - Start with earliest available chunk on the stream. * FRAGMENT_NUMBER - Start with the chunk containing the specific fragment. You must also specify the @StartFragmentNumber@ . * PRODUCER_TIMESTAMP or SERVER_TIMESTAMP - Start with the chunk containing a fragment with the specified producer or server time stamp. You specify the time stamp by adding @StartTimestamp@ . * CONTINUATION_TOKEN - Read using the specified continuation token. +ssStartSelectorType :: Lens' StartSelector StartSelectorType +ssStartSelectorType = lens _ssStartSelectorType (\ s a -> s{_ssStartSelectorType = a}) + +instance Hashable StartSelector where + +instance NFData StartSelector where + +instance ToJSON StartSelector where + toJSON StartSelector'{..} + = object + (catMaybes + [("ContinuationToken" .=) <$> _ssContinuationToken, + ("AfterFragmentNumber" .=) <$> + _ssAfterFragmentNumber, + ("StartTimestamp" .=) <$> _ssStartTimestamp, + Just ("StartSelectorType" .= _ssStartSelectorType)]) diff --git a/gen/Network/AWS/KinesisVideoMedia/Types/Sum.hs b/gen/Network/AWS/KinesisVideoMedia/Types/Sum.hs new file mode 100644 --- /dev/null +++ b/gen/Network/AWS/KinesisVideoMedia/Types/Sum.hs @@ -0,0 +1,59 @@ +{-# LANGUAGE DeriveDataTypeable #-} +{-# LANGUAGE DeriveGeneric #-} +{-# LANGUAGE LambdaCase #-} +{-# LANGUAGE OverloadedStrings #-} + +{-# OPTIONS_GHC -fno-warn-unused-imports #-} + +-- Derived from AWS service descriptions, licensed under Apache 2.0. + +-- | +-- Module : Network.AWS.KinesisVideoMedia.Types.Sum +-- Copyright : (c) 2013-2018 Brendan Hay +-- License : Mozilla Public License, v. 2.0. +-- Maintainer : Brendan Hay +-- Stability : auto-generated +-- Portability : non-portable (GHC extensions) +-- +module Network.AWS.KinesisVideoMedia.Types.Sum where + +import Network.AWS.Prelude + +data StartSelectorType + = ContinuationToken + | Earliest + | FragmentNumber + | Now + | ProducerTimestamp + | ServerTimestamp + deriving (Eq, Ord, Read, Show, Enum, Bounded, Data, Typeable, Generic) + + +instance FromText StartSelectorType where + parser = takeLowerText >>= \case + "continuation_token" -> pure ContinuationToken + "earliest" -> pure Earliest + "fragment_number" -> pure FragmentNumber + "now" -> pure Now + "producer_timestamp" -> pure ProducerTimestamp + "server_timestamp" -> pure ServerTimestamp + e -> fromTextError $ "Failure parsing StartSelectorType from value: '" <> e + <> "'. Accepted values: continuation_token, earliest, fragment_number, now, producer_timestamp, server_timestamp" + +instance ToText StartSelectorType where + toText = \case + ContinuationToken -> "CONTINUATION_TOKEN" + Earliest -> "EARLIEST" + FragmentNumber -> "FRAGMENT_NUMBER" + Now -> "NOW" + ProducerTimestamp -> "PRODUCER_TIMESTAMP" + ServerTimestamp -> "SERVER_TIMESTAMP" + +instance Hashable StartSelectorType +instance NFData StartSelectorType +instance ToByteString StartSelectorType +instance ToQuery StartSelectorType +instance ToHeader StartSelectorType + +instance ToJSON StartSelectorType where + toJSON = toJSONText diff --git a/gen/Network/AWS/KinesisVideoMedia/Waiters.hs b/gen/Network/AWS/KinesisVideoMedia/Waiters.hs new file mode 100644 --- /dev/null +++ b/gen/Network/AWS/KinesisVideoMedia/Waiters.hs @@ -0,0 +1,21 @@ +{-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE TypeFamilies #-} + +{-# OPTIONS_GHC -fno-warn-unused-imports #-} + +-- Derived from AWS service descriptions, licensed under Apache 2.0. + +-- | +-- Module : Network.AWS.KinesisVideoMedia.Waiters +-- Copyright : (c) 2013-2018 Brendan Hay +-- License : Mozilla Public License, v. 2.0. +-- Maintainer : Brendan Hay +-- Stability : auto-generated +-- Portability : non-portable (GHC extensions) +-- +module Network.AWS.KinesisVideoMedia.Waiters where + +import Network.AWS.KinesisVideoMedia.Types +import Network.AWS.Lens +import Network.AWS.Prelude +import Network.AWS.Waiter diff --git a/src/.gitkeep b/src/.gitkeep new file mode 100644 --- /dev/null +++ b/src/.gitkeep diff --git a/test/Main.hs b/test/Main.hs new file mode 100644 --- /dev/null +++ b/test/Main.hs @@ -0,0 +1,21 @@ +{-# OPTIONS_GHC -fno-warn-unused-imports #-} + +-- | +-- Module : Main +-- Copyright : (c) 2013-2018 Brendan Hay +-- License : Mozilla Public License, v. 2.0. +-- Maintainer : Brendan Hay +-- Stability : auto-generated +-- Portability : non-portable (GHC extensions) +-- +module Main (main) where + +import Test.Tasty +import Test.AWS.KinesisVideoMedia +import Test.AWS.KinesisVideoMedia.Internal + +main :: IO () +main = defaultMain $ testGroup "KinesisVideoMedia" + [ testGroup "tests" tests + , testGroup "fixtures" fixtures + ] diff --git a/test/Test/AWS/Gen/KinesisVideoMedia.hs b/test/Test/AWS/Gen/KinesisVideoMedia.hs new file mode 100644 --- /dev/null +++ b/test/Test/AWS/Gen/KinesisVideoMedia.hs @@ -0,0 +1,50 @@ +{-# OPTIONS_GHC -fno-warn-unused-imports #-} +{-# OPTIONS_GHC -fno-warn-orphans #-} + +-- Derived from AWS service descriptions, licensed under Apache 2.0. + +-- | +-- Module : Test.AWS.Gen.KinesisVideoMedia +-- Copyright : (c) 2013-2018 Brendan Hay +-- License : Mozilla Public License, v. 2.0. +-- Maintainer : Brendan Hay +-- Stability : auto-generated +-- Portability : non-portable (GHC extensions) +-- +module Test.AWS.Gen.KinesisVideoMedia where + +import Data.Proxy +import Network.AWS.KinesisVideoMedia +import Test.AWS.Fixture +import Test.AWS.KinesisVideoMedia.Internal +import Test.AWS.Prelude +import Test.Tasty + +-- Auto-generated: the actual test selection needs to be manually placed into +-- the top-level so that real test data can be incrementally added. +-- +-- This commented snippet is what the entire set should look like: + +-- fixtures :: TestTree +-- fixtures = +-- [ testGroup "request" +-- [ requestGetMedia $ +-- getMedia +-- +-- ] + +-- , testGroup "response" +-- [ responseGetMedia $ +-- getMediaResponse +-- +-- ] +-- ] + +-- Requests + +requestGetMedia :: GetMedia -> TestTree +requestGetMedia = req + "GetMedia" + "fixture/GetMedia.yaml" + +-- Responses diff --git a/test/Test/AWS/KinesisVideoMedia.hs b/test/Test/AWS/KinesisVideoMedia.hs new file mode 100644 --- /dev/null +++ b/test/Test/AWS/KinesisVideoMedia.hs @@ -0,0 +1,20 @@ +-- | +-- Module : Test.AWS.KinesisVideoMedia +-- Copyright : (c) 2013-2018 Brendan Hay +-- License : Mozilla Public License, v. 2.0. +-- Maintainer : Brendan Hay +-- Stability : auto-generated +-- Portability : non-portable (GHC extensions) +-- +module Test.AWS.KinesisVideoMedia + ( tests + , fixtures + ) where + +import Test.Tasty (TestTree) + +tests :: [TestTree] +tests = [] + +fixtures :: [TestTree] +fixtures = [] diff --git a/test/Test/AWS/KinesisVideoMedia/Internal.hs b/test/Test/AWS/KinesisVideoMedia/Internal.hs new file mode 100644 --- /dev/null +++ b/test/Test/AWS/KinesisVideoMedia/Internal.hs @@ -0,0 +1,9 @@ +-- | +-- Module : Test.AWS.KinesisVideoMedia.Internal +-- Copyright : (c) 2013-2018 Brendan Hay +-- License : Mozilla Public License, v. 2.0. +-- Maintainer : Brendan Hay +-- Stability : auto-generated +-- Portability : non-portable (GHC extensions) +-- +module Test.AWS.KinesisVideoMedia.Internal where