123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405 |
- // THIS FILE IS AUTOMATICALLY GENERATED. DO NOT EDIT.
- // Package kinesis provides a client for Amazon Kinesis.
- package kinesis
- import (
- "fmt"
- "time"
- "github.com/aws/aws-sdk-go/aws/awsutil"
- "github.com/aws/aws-sdk-go/aws/request"
- "github.com/aws/aws-sdk-go/private/protocol"
- "github.com/aws/aws-sdk-go/private/protocol/jsonrpc"
- )
- const opAddTagsToStream = "AddTagsToStream"
- // AddTagsToStreamRequest generates a "aws/request.Request" representing the
- // client's request for the AddTagsToStream operation. The "output" return
- // value can be used to capture response data after the request's "Send" method
- // is called.
- //
- // See AddTagsToStream for usage and error information.
- //
- // Creating a request object using this method should be used when you want to inject
- // custom logic into the request's lifecycle using a custom handler, or if you want to
- // access properties on the request object before or after sending the request. If
- // you just want the service response, call the AddTagsToStream method directly
- // instead.
- //
- // Note: You must call the "Send" method on the returned request object in order
- // to execute the request.
- //
- // // Example sending a request using the AddTagsToStreamRequest method.
- // req, resp := client.AddTagsToStreamRequest(params)
- //
- // err := req.Send()
- // if err == nil { // resp is now filled
- // fmt.Println(resp)
- // }
- //
- func (c *Kinesis) AddTagsToStreamRequest(input *AddTagsToStreamInput) (req *request.Request, output *AddTagsToStreamOutput) {
- op := &request.Operation{
- Name: opAddTagsToStream,
- HTTPMethod: "POST",
- HTTPPath: "/",
- }
- if input == nil {
- input = &AddTagsToStreamInput{}
- }
- req = c.newRequest(op, input, output)
- req.Handlers.Unmarshal.Remove(jsonrpc.UnmarshalHandler)
- req.Handlers.Unmarshal.PushBackNamed(protocol.UnmarshalDiscardBodyHandler)
- output = &AddTagsToStreamOutput{}
- req.Data = output
- return
- }
- // AddTagsToStream API operation for Amazon Kinesis.
- //
- // Adds or updates tags for the specified Amazon Kinesis stream. Each stream
- // can have up to 10 tags.
- //
- // If tags have already been assigned to the stream, AddTagsToStream overwrites
- // any existing tags that correspond to the specified tag keys.
- //
- // Returns awserr.Error for service API and SDK errors. Use runtime type assertions
- // with awserr.Error's Code and Message methods to get detailed information about
- // the error.
- //
- // See the AWS API reference guide for Amazon Kinesis's
- // API operation AddTagsToStream for usage and error information.
- //
- // Returned Error Codes:
- // * ResourceNotFoundException
- // The requested resource could not be found. The stream might not be specified
- // correctly, or it might not be in the ACTIVE state if the operation requires
- // it.
- //
- // * ResourceInUseException
- // The resource is not available for this operation. For successful operation,
- // the resource needs to be in the ACTIVE state.
- //
- // * InvalidArgumentException
- // A specified parameter exceeds its restrictions, is not supported, or can't
- // be used. For more information, see the returned message.
- //
- // * LimitExceededException
- // The requested resource exceeds the maximum number allowed, or the number
- // of concurrent stream requests exceeds the maximum number allowed (5).
- //
- func (c *Kinesis) AddTagsToStream(input *AddTagsToStreamInput) (*AddTagsToStreamOutput, error) {
- req, out := c.AddTagsToStreamRequest(input)
- err := req.Send()
- return out, err
- }
- const opCreateStream = "CreateStream"
- // CreateStreamRequest generates a "aws/request.Request" representing the
- // client's request for the CreateStream operation. The "output" return
- // value can be used to capture response data after the request's "Send" method
- // is called.
- //
- // See CreateStream for usage and error information.
- //
- // Creating a request object using this method should be used when you want to inject
- // custom logic into the request's lifecycle using a custom handler, or if you want to
- // access properties on the request object before or after sending the request. If
- // you just want the service response, call the CreateStream method directly
- // instead.
- //
- // Note: You must call the "Send" method on the returned request object in order
- // to execute the request.
- //
- // // Example sending a request using the CreateStreamRequest method.
- // req, resp := client.CreateStreamRequest(params)
- //
- // err := req.Send()
- // if err == nil { // resp is now filled
- // fmt.Println(resp)
- // }
- //
- func (c *Kinesis) CreateStreamRequest(input *CreateStreamInput) (req *request.Request, output *CreateStreamOutput) {
- op := &request.Operation{
- Name: opCreateStream,
- HTTPMethod: "POST",
- HTTPPath: "/",
- }
- if input == nil {
- input = &CreateStreamInput{}
- }
- req = c.newRequest(op, input, output)
- req.Handlers.Unmarshal.Remove(jsonrpc.UnmarshalHandler)
- req.Handlers.Unmarshal.PushBackNamed(protocol.UnmarshalDiscardBodyHandler)
- output = &CreateStreamOutput{}
- req.Data = output
- return
- }
- // CreateStream API operation for Amazon Kinesis.
- //
- // Creates an Amazon Kinesis stream. A stream captures and transports data records
- // that are continuously emitted from different data sources or producers. Scale-out
- // within a stream is explicitly supported by means of shards, which are uniquely
- // identified groups of data records in a stream.
- //
- // You specify and control the number of shards that a stream is composed of.
- // Each shard can support reads up to 5 transactions per second, up to a maximum
- // data read total of 2 MB per second. Each shard can support writes up to 1,000
- // records per second, up to a maximum data write total of 1 MB per second.
- // You can add shards to a stream if the amount of data input increases and
- // you can remove shards if the amount of data input decreases.
- //
- // The stream name identifies the stream. The name is scoped to the AWS account
- // used by the application. It is also scoped by region. That is, two streams
- // in two different accounts can have the same name, and two streams in the
- // same account, but in two different regions, can have the same name.
- //
- // CreateStream is an asynchronous operation. Upon receiving a CreateStream
- // request, Amazon Kinesis immediately returns and sets the stream status to
- // CREATING. After the stream is created, Amazon Kinesis sets the stream status
- // to ACTIVE. You should perform read and write operations only on an ACTIVE
- // stream.
- //
- // You receive a LimitExceededException when making a CreateStream request if
- // you try to do one of the following:
- //
- // * Have more than five streams in the CREATING state at any point in time.
- //
- // * Create more shards than are authorized for your account.
- // For the default shard limit for an AWS account, see Streams Limits (http://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html)
- // in the Amazon Kinesis Streams Developer Guide. If you need to increase this
- // limit, contact AWS Support (http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html).
- //
- // You can use DescribeStream to check the stream status, which is returned
- // in StreamStatus.
- //
- // CreateStream has a limit of 5 transactions per second per account.
- //
- // Returns awserr.Error for service API and SDK errors. Use runtime type assertions
- // with awserr.Error's Code and Message methods to get detailed information about
- // the error.
- //
- // See the AWS API reference guide for Amazon Kinesis's
- // API operation CreateStream for usage and error information.
- //
- // Returned Error Codes:
- // * ResourceInUseException
- // The resource is not available for this operation. For successful operation,
- // the resource needs to be in the ACTIVE state.
- //
- // * LimitExceededException
- // The requested resource exceeds the maximum number allowed, or the number
- // of concurrent stream requests exceeds the maximum number allowed (5).
- //
- // * InvalidArgumentException
- // A specified parameter exceeds its restrictions, is not supported, or can't
- // be used. For more information, see the returned message.
- //
- func (c *Kinesis) CreateStream(input *CreateStreamInput) (*CreateStreamOutput, error) {
- req, out := c.CreateStreamRequest(input)
- err := req.Send()
- return out, err
- }
- const opDecreaseStreamRetentionPeriod = "DecreaseStreamRetentionPeriod"
- // DecreaseStreamRetentionPeriodRequest generates a "aws/request.Request" representing the
- // client's request for the DecreaseStreamRetentionPeriod operation. The "output" return
- // value can be used to capture response data after the request's "Send" method
- // is called.
- //
- // See DecreaseStreamRetentionPeriod for usage and error information.
- //
- // Creating a request object using this method should be used when you want to inject
- // custom logic into the request's lifecycle using a custom handler, or if you want to
- // access properties on the request object before or after sending the request. If
- // you just want the service response, call the DecreaseStreamRetentionPeriod method directly
- // instead.
- //
- // Note: You must call the "Send" method on the returned request object in order
- // to execute the request.
- //
- // // Example sending a request using the DecreaseStreamRetentionPeriodRequest method.
- // req, resp := client.DecreaseStreamRetentionPeriodRequest(params)
- //
- // err := req.Send()
- // if err == nil { // resp is now filled
- // fmt.Println(resp)
- // }
- //
- func (c *Kinesis) DecreaseStreamRetentionPeriodRequest(input *DecreaseStreamRetentionPeriodInput) (req *request.Request, output *DecreaseStreamRetentionPeriodOutput) {
- op := &request.Operation{
- Name: opDecreaseStreamRetentionPeriod,
- HTTPMethod: "POST",
- HTTPPath: "/",
- }
- if input == nil {
- input = &DecreaseStreamRetentionPeriodInput{}
- }
- req = c.newRequest(op, input, output)
- req.Handlers.Unmarshal.Remove(jsonrpc.UnmarshalHandler)
- req.Handlers.Unmarshal.PushBackNamed(protocol.UnmarshalDiscardBodyHandler)
- output = &DecreaseStreamRetentionPeriodOutput{}
- req.Data = output
- return
- }
- // DecreaseStreamRetentionPeriod API operation for Amazon Kinesis.
- //
- // Decreases the Amazon Kinesis stream's retention period, which is the length
- // of time data records are accessible after they are added to the stream. The
- // minimum value of a stream's retention period is 24 hours.
- //
- // This operation may result in lost data. For example, if the stream's retention
- // period is 48 hours and is decreased to 24 hours, any data already in the
- // stream that is older than 24 hours is inaccessible.
- //
- // Returns awserr.Error for service API and SDK errors. Use runtime type assertions
- // with awserr.Error's Code and Message methods to get detailed information about
- // the error.
- //
- // See the AWS API reference guide for Amazon Kinesis's
- // API operation DecreaseStreamRetentionPeriod for usage and error information.
- //
- // Returned Error Codes:
- // * ResourceInUseException
- // The resource is not available for this operation. For successful operation,
- // the resource needs to be in the ACTIVE state.
- //
- // * ResourceNotFoundException
- // The requested resource could not be found. The stream might not be specified
- // correctly, or it might not be in the ACTIVE state if the operation requires
- // it.
- //
- // * LimitExceededException
- // The requested resource exceeds the maximum number allowed, or the number
- // of concurrent stream requests exceeds the maximum number allowed (5).
- //
- // * InvalidArgumentException
- // A specified parameter exceeds its restrictions, is not supported, or can't
- // be used. For more information, see the returned message.
- //
- func (c *Kinesis) DecreaseStreamRetentionPeriod(input *DecreaseStreamRetentionPeriodInput) (*DecreaseStreamRetentionPeriodOutput, error) {
- req, out := c.DecreaseStreamRetentionPeriodRequest(input)
- err := req.Send()
- return out, err
- }
- const opDeleteStream = "DeleteStream"
- // DeleteStreamRequest generates a "aws/request.Request" representing the
- // client's request for the DeleteStream operation. The "output" return
- // value can be used to capture response data after the request's "Send" method
- // is called.
- //
- // See DeleteStream for usage and error information.
- //
- // Creating a request object using this method should be used when you want to inject
- // custom logic into the request's lifecycle using a custom handler, or if you want to
- // access properties on the request object before or after sending the request. If
- // you just want the service response, call the DeleteStream method directly
- // instead.
- //
- // Note: You must call the "Send" method on the returned request object in order
- // to execute the request.
- //
- // // Example sending a request using the DeleteStreamRequest method.
- // req, resp := client.DeleteStreamRequest(params)
- //
- // err := req.Send()
- // if err == nil { // resp is now filled
- // fmt.Println(resp)
- // }
- //
- func (c *Kinesis) DeleteStreamRequest(input *DeleteStreamInput) (req *request.Request, output *DeleteStreamOutput) {
- op := &request.Operation{
- Name: opDeleteStream,
- HTTPMethod: "POST",
- HTTPPath: "/",
- }
- if input == nil {
- input = &DeleteStreamInput{}
- }
- req = c.newRequest(op, input, output)
- req.Handlers.Unmarshal.Remove(jsonrpc.UnmarshalHandler)
- req.Handlers.Unmarshal.PushBackNamed(protocol.UnmarshalDiscardBodyHandler)
- output = &DeleteStreamOutput{}
- req.Data = output
- return
- }
- // DeleteStream API operation for Amazon Kinesis.
- //
- // Deletes an Amazon Kinesis stream and all its shards and data. You must shut
- // down any applications that are operating on the stream before you delete
- // the stream. If an application attempts to operate on a deleted stream, it
- // will receive the exception ResourceNotFoundException.
- //
- // If the stream is in the ACTIVE state, you can delete it. After a DeleteStream
- // request, the specified stream is in the DELETING state until Amazon Kinesis
- // completes the deletion.
- //
- // Note: Amazon Kinesis might continue to accept data read and write operations,
- // such as PutRecord, PutRecords, and GetRecords, on a stream in the DELETING
- // state until the stream deletion is complete.
- //
- // When you delete a stream, any shards in that stream are also deleted, and
- // any tags are dissociated from the stream.
- //
- // You can use the DescribeStream operation to check the state of the stream,
- // which is returned in StreamStatus.
- //
- // DeleteStream has a limit of 5 transactions per second per account.
- //
- // Returns awserr.Error for service API and SDK errors. Use runtime type assertions
- // with awserr.Error's Code and Message methods to get detailed information about
- // the error.
- //
- // See the AWS API reference guide for Amazon Kinesis's
- // API operation DeleteStream for usage and error information.
- //
- // Returned Error Codes:
- // * ResourceNotFoundException
- // The requested resource could not be found. The stream might not be specified
- // correctly, or it might not be in the ACTIVE state if the operation requires
- // it.
- //
- // * LimitExceededException
- // The requested resource exceeds the maximum number allowed, or the number
- // of concurrent stream requests exceeds the maximum number allowed (5).
- //
- func (c *Kinesis) DeleteStream(input *DeleteStreamInput) (*DeleteStreamOutput, error) {
- req, out := c.DeleteStreamRequest(input)
- err := req.Send()
- return out, err
- }
- const opDescribeStream = "DescribeStream"
- // DescribeStreamRequest generates a "aws/request.Request" representing the
- // client's request for the DescribeStream operation. The "output" return
- // value can be used to capture response data after the request's "Send" method
- // is called.
- //
- // See DescribeStream for usage and error information.
- //
- // Creating a request object using this method should be used when you want to inject
- // custom logic into the request's lifecycle using a custom handler, or if you want to
- // access properties on the request object before or after sending the request. If
- // you just want the service response, call the DescribeStream method directly
- // instead.
- //
- // Note: You must call the "Send" method on the returned request object in order
- // to execute the request.
- //
- // // Example sending a request using the DescribeStreamRequest method.
- // req, resp := client.DescribeStreamRequest(params)
- //
- // err := req.Send()
- // if err == nil { // resp is now filled
- // fmt.Println(resp)
- // }
- //
- func (c *Kinesis) DescribeStreamRequest(input *DescribeStreamInput) (req *request.Request, output *DescribeStreamOutput) {
- op := &request.Operation{
- Name: opDescribeStream,
- HTTPMethod: "POST",
- HTTPPath: "/",
- Paginator: &request.Paginator{
- InputTokens: []string{"ExclusiveStartShardId"},
- OutputTokens: []string{"StreamDescription.Shards[-1].ShardId"},
- LimitToken: "Limit",
- TruncationToken: "StreamDescription.HasMoreShards",
- },
- }
- if input == nil {
- input = &DescribeStreamInput{}
- }
- req = c.newRequest(op, input, output)
- output = &DescribeStreamOutput{}
- req.Data = output
- return
- }
- // DescribeStream API operation for Amazon Kinesis.
- //
- // Describes the specified Amazon Kinesis stream.
- //
- // The information about the stream includes its current status, its Amazon
- // Resource Name (ARN), and an array of shard objects. For each shard object,
- // there is information about the hash key and sequence number ranges that the
- // shard spans, and the IDs of any earlier shards that played in a role in creating
- // the shard. A sequence number is the identifier associated with every record
- // ingested in the stream. The sequence number is assigned when a record is
- // put into the stream.
- //
- // You can limit the number of returned shards using the Limit parameter. The
- // number of shards in a stream may be too large to return from a single call
- // to DescribeStream. You can detect this by using the HasMoreShards flag in
- // the returned output. HasMoreShards is set to true when there is more data
- // available.
- //
- // DescribeStream is a paginated operation. If there are more shards available,
- // you can request them using the shard ID of the last shard returned. Specify
- // this ID in the ExclusiveStartShardId parameter in a subsequent request to
- // DescribeStream.
- //
- // There are no guarantees about the chronological order shards returned in
- // DescribeStream results. If you want to process shards in chronological order,
- // use ParentShardId to track lineage to the oldest shard.
- //
- // DescribeStream has a limit of 10 transactions per second per account.
- //
- // Returns awserr.Error for service API and SDK errors. Use runtime type assertions
- // with awserr.Error's Code and Message methods to get detailed information about
- // the error.
- //
- // See the AWS API reference guide for Amazon Kinesis's
- // API operation DescribeStream for usage and error information.
- //
- // Returned Error Codes:
- // * ResourceNotFoundException
- // The requested resource could not be found. The stream might not be specified
- // correctly, or it might not be in the ACTIVE state if the operation requires
- // it.
- //
- // * LimitExceededException
- // The requested resource exceeds the maximum number allowed, or the number
- // of concurrent stream requests exceeds the maximum number allowed (5).
- //
- func (c *Kinesis) DescribeStream(input *DescribeStreamInput) (*DescribeStreamOutput, error) {
- req, out := c.DescribeStreamRequest(input)
- err := req.Send()
- return out, err
- }
- // DescribeStreamPages iterates over the pages of a DescribeStream operation,
- // calling the "fn" function with the response data for each page. To stop
- // iterating, return false from the fn function.
- //
- // See DescribeStream method for more information on how to use this operation.
- //
- // Note: This operation can generate multiple requests to a service.
- //
- // // Example iterating over at most 3 pages of a DescribeStream operation.
- // pageNum := 0
- // err := client.DescribeStreamPages(params,
- // func(page *DescribeStreamOutput, lastPage bool) bool {
- // pageNum++
- // fmt.Println(page)
- // return pageNum <= 3
- // })
- //
- func (c *Kinesis) DescribeStreamPages(input *DescribeStreamInput, fn func(p *DescribeStreamOutput, lastPage bool) (shouldContinue bool)) error {
- page, _ := c.DescribeStreamRequest(input)
- page.Handlers.Build.PushBack(request.MakeAddToUserAgentFreeFormHandler("Paginator"))
- return page.EachPage(func(p interface{}, lastPage bool) bool {
- return fn(p.(*DescribeStreamOutput), lastPage)
- })
- }
- const opDisableEnhancedMonitoring = "DisableEnhancedMonitoring"
- // DisableEnhancedMonitoringRequest generates a "aws/request.Request" representing the
- // client's request for the DisableEnhancedMonitoring operation. The "output" return
- // value can be used to capture response data after the request's "Send" method
- // is called.
- //
- // See DisableEnhancedMonitoring for usage and error information.
- //
- // Creating a request object using this method should be used when you want to inject
- // custom logic into the request's lifecycle using a custom handler, or if you want to
- // access properties on the request object before or after sending the request. If
- // you just want the service response, call the DisableEnhancedMonitoring method directly
- // instead.
- //
- // Note: You must call the "Send" method on the returned request object in order
- // to execute the request.
- //
- // // Example sending a request using the DisableEnhancedMonitoringRequest method.
- // req, resp := client.DisableEnhancedMonitoringRequest(params)
- //
- // err := req.Send()
- // if err == nil { // resp is now filled
- // fmt.Println(resp)
- // }
- //
- func (c *Kinesis) DisableEnhancedMonitoringRequest(input *DisableEnhancedMonitoringInput) (req *request.Request, output *EnhancedMonitoringOutput) {
- op := &request.Operation{
- Name: opDisableEnhancedMonitoring,
- HTTPMethod: "POST",
- HTTPPath: "/",
- }
- if input == nil {
- input = &DisableEnhancedMonitoringInput{}
- }
- req = c.newRequest(op, input, output)
- output = &EnhancedMonitoringOutput{}
- req.Data = output
- return
- }
- // DisableEnhancedMonitoring API operation for Amazon Kinesis.
- //
- // Disables enhanced monitoring.
- //
- // Returns awserr.Error for service API and SDK errors. Use runtime type assertions
- // with awserr.Error's Code and Message methods to get detailed information about
- // the error.
- //
- // See the AWS API reference guide for Amazon Kinesis's
- // API operation DisableEnhancedMonitoring for usage and error information.
- //
- // Returned Error Codes:
- // * InvalidArgumentException
- // A specified parameter exceeds its restrictions, is not supported, or can't
- // be used. For more information, see the returned message.
- //
- // * LimitExceededException
- // The requested resource exceeds the maximum number allowed, or the number
- // of concurrent stream requests exceeds the maximum number allowed (5).
- //
- // * ResourceInUseException
- // The resource is not available for this operation. For successful operation,
- // the resource needs to be in the ACTIVE state.
- //
- // * ResourceNotFoundException
- // The requested resource could not be found. The stream might not be specified
- // correctly, or it might not be in the ACTIVE state if the operation requires
- // it.
- //
- func (c *Kinesis) DisableEnhancedMonitoring(input *DisableEnhancedMonitoringInput) (*EnhancedMonitoringOutput, error) {
- req, out := c.DisableEnhancedMonitoringRequest(input)
- err := req.Send()
- return out, err
- }
- const opEnableEnhancedMonitoring = "EnableEnhancedMonitoring"
- // EnableEnhancedMonitoringRequest generates a "aws/request.Request" representing the
- // client's request for the EnableEnhancedMonitoring operation. The "output" return
- // value can be used to capture response data after the request's "Send" method
- // is called.
- //
- // See EnableEnhancedMonitoring for usage and error information.
- //
- // Creating a request object using this method should be used when you want to inject
- // custom logic into the request's lifecycle using a custom handler, or if you want to
- // access properties on the request object before or after sending the request. If
- // you just want the service response, call the EnableEnhancedMonitoring method directly
- // instead.
- //
- // Note: You must call the "Send" method on the returned request object in order
- // to execute the request.
- //
- // // Example sending a request using the EnableEnhancedMonitoringRequest method.
- // req, resp := client.EnableEnhancedMonitoringRequest(params)
- //
- // err := req.Send()
- // if err == nil { // resp is now filled
- // fmt.Println(resp)
- // }
- //
- func (c *Kinesis) EnableEnhancedMonitoringRequest(input *EnableEnhancedMonitoringInput) (req *request.Request, output *EnhancedMonitoringOutput) {
- op := &request.Operation{
- Name: opEnableEnhancedMonitoring,
- HTTPMethod: "POST",
- HTTPPath: "/",
- }
- if input == nil {
- input = &EnableEnhancedMonitoringInput{}
- }
- req = c.newRequest(op, input, output)
- output = &EnhancedMonitoringOutput{}
- req.Data = output
- return
- }
- // EnableEnhancedMonitoring API operation for Amazon Kinesis.
- //
- // Enables enhanced Amazon Kinesis stream monitoring for shard-level metrics.
- //
- // Returns awserr.Error for service API and SDK errors. Use runtime type assertions
- // with awserr.Error's Code and Message methods to get detailed information about
- // the error.
- //
- // See the AWS API reference guide for Amazon Kinesis's
- // API operation EnableEnhancedMonitoring for usage and error information.
- //
- // Returned Error Codes:
- // * InvalidArgumentException
- // A specified parameter exceeds its restrictions, is not supported, or can't
- // be used. For more information, see the returned message.
- //
- // * LimitExceededException
- // The requested resource exceeds the maximum number allowed, or the number
- // of concurrent stream requests exceeds the maximum number allowed (5).
- //
- // * ResourceInUseException
- // The resource is not available for this operation. For successful operation,
- // the resource needs to be in the ACTIVE state.
- //
- // * ResourceNotFoundException
- // The requested resource could not be found. The stream might not be specified
- // correctly, or it might not be in the ACTIVE state if the operation requires
- // it.
- //
- func (c *Kinesis) EnableEnhancedMonitoring(input *EnableEnhancedMonitoringInput) (*EnhancedMonitoringOutput, error) {
- req, out := c.EnableEnhancedMonitoringRequest(input)
- err := req.Send()
- return out, err
- }
- const opGetRecords = "GetRecords"
- // GetRecordsRequest generates a "aws/request.Request" representing the
- // client's request for the GetRecords operation. The "output" return
- // value can be used to capture response data after the request's "Send" method
- // is called.
- //
- // See GetRecords for usage and error information.
- //
- // Creating a request object using this method should be used when you want to inject
- // custom logic into the request's lifecycle using a custom handler, or if you want to
- // access properties on the request object before or after sending the request. If
- // you just want the service response, call the GetRecords method directly
- // instead.
- //
- // Note: You must call the "Send" method on the returned request object in order
- // to execute the request.
- //
- // // Example sending a request using the GetRecordsRequest method.
- // req, resp := client.GetRecordsRequest(params)
- //
- // err := req.Send()
- // if err == nil { // resp is now filled
- // fmt.Println(resp)
- // }
- //
- func (c *Kinesis) GetRecordsRequest(input *GetRecordsInput) (req *request.Request, output *GetRecordsOutput) {
- op := &request.Operation{
- Name: opGetRecords,
- HTTPMethod: "POST",
- HTTPPath: "/",
- }
- if input == nil {
- input = &GetRecordsInput{}
- }
- req = c.newRequest(op, input, output)
- output = &GetRecordsOutput{}
- req.Data = output
- return
- }
- // GetRecords API operation for Amazon Kinesis.
- //
- // Gets data records from an Amazon Kinesis stream's shard.
- //
- // Specify a shard iterator using the ShardIterator parameter. The shard iterator
- // specifies the position in the shard from which you want to start reading
- // data records sequentially. If there are no records available in the portion
- // of the shard that the iterator points to, GetRecords returns an empty list.
- // Note that it might take multiple calls to get to a portion of the shard that
- // contains records.
- //
- // You can scale by provisioning multiple shards per stream while considering
- // service limits (for more information, see Streams Limits (http://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html)
- // in the Amazon Kinesis Streams Developer Guide). Your application should have
- // one thread per shard, each reading continuously from its stream. To read
- // from a stream continually, call GetRecords in a loop. Use GetShardIterator
- // to get the shard iterator to specify in the first GetRecords call. GetRecords
- // returns a new shard iterator in NextShardIterator. Specify the shard iterator
- // returned in NextShardIterator in subsequent calls to GetRecords. Note that
- // if the shard has been closed, the shard iterator can't return more data and
- // GetRecords returns null in NextShardIterator. You can terminate the loop
- // when the shard is closed, or when the shard iterator reaches the record with
- // the sequence number or other attribute that marks it as the last record to
- // process.
- //
- // Each data record can be up to 1 MB in size, and each shard can read up to
- // 2 MB per second. You can ensure that your calls don't exceed the maximum
- // supported size or throughput by using the Limit parameter to specify the
- // maximum number of records that GetRecords can return. Consider your average
- // record size when determining this limit.
- //
- // The size of the data returned by GetRecords varies depending on the utilization
- // of the shard. The maximum size of data that GetRecords can return is 10 MB.
- // If a call returns this amount of data, subsequent calls made within the next
- // 5 seconds throw ProvisionedThroughputExceededException. If there is insufficient
- // provisioned throughput on the shard, subsequent calls made within the next
- // 1 second throw ProvisionedThroughputExceededException. Note that GetRecords
- // won't return any data when it throws an exception. For this reason, we recommend
- // that you wait one second between calls to GetRecords; however, it's possible
- // that the application will get exceptions for longer than 1 second.
- //
- // To detect whether the application is falling behind in processing, you can
- // use the MillisBehindLatest response attribute. You can also monitor the stream
- // using CloudWatch metrics and other mechanisms (see Monitoring (http://docs.aws.amazon.com/kinesis/latest/dev/monitoring.html)
- // in the Amazon Kinesis Streams Developer Guide).
- //
- // Each Amazon Kinesis record includes a value, ApproximateArrivalTimestamp,
- // that is set when a stream successfully receives and stores a record. This
- // is commonly referred to as a server-side timestamp, whereas a client-side
- // timestamp is set when a data producer creates or sends the record to a stream
- // (a data producer is any data source putting data records into a stream, for
- // example with PutRecords). The timestamp has millisecond precision. There
- // are no guarantees about the timestamp accuracy, or that the timestamp is
- // always increasing. For example, records in a shard or across a stream might
- // have timestamps that are out of order.
- //
- // Returns awserr.Error for service API and SDK errors. Use runtime type assertions
- // with awserr.Error's Code and Message methods to get detailed information about
- // the error.
- //
- // See the AWS API reference guide for Amazon Kinesis's
- // API operation GetRecords for usage and error information.
- //
- // Returned Error Codes:
- // * ResourceNotFoundException
- // The requested resource could not be found. The stream might not be specified
- // correctly, or it might not be in the ACTIVE state if the operation requires
- // it.
- //
- // * InvalidArgumentException
- // A specified parameter exceeds its restrictions, is not supported, or can't
- // be used. For more information, see the returned message.
- //
- // * ProvisionedThroughputExceededException
- // The request rate for the stream is too high, or the requested data is too
- // large for the available throughput. Reduce the frequency or size of your
- // requests. For more information, see Streams Limits (http://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html)
- // in the Amazon Kinesis Streams Developer Guide, and Error Retries and Exponential
- // Backoff in AWS (http://docs.aws.amazon.com/general/latest/gr/api-retries.html)
- // in the AWS General Reference.
- //
- // * ExpiredIteratorException
- // The provided iterator exceeds the maximum age allowed.
- //
- func (c *Kinesis) GetRecords(input *GetRecordsInput) (*GetRecordsOutput, error) {
- req, out := c.GetRecordsRequest(input)
- err := req.Send()
- return out, err
- }
- const opGetShardIterator = "GetShardIterator"
- // GetShardIteratorRequest generates a "aws/request.Request" representing the
- // client's request for the GetShardIterator operation. The "output" return
- // value can be used to capture response data after the request's "Send" method
- // is called.
- //
- // See GetShardIterator for usage and error information.
- //
- // Creating a request object using this method should be used when you want to inject
- // custom logic into the request's lifecycle using a custom handler, or if you want to
- // access properties on the request object before or after sending the request. If
- // you just want the service response, call the GetShardIterator method directly
- // instead.
- //
- // Note: You must call the "Send" method on the returned request object in order
- // to execute the request.
- //
- // // Example sending a request using the GetShardIteratorRequest method.
- // req, resp := client.GetShardIteratorRequest(params)
- //
- // err := req.Send()
- // if err == nil { // resp is now filled
- // fmt.Println(resp)
- // }
- //
- func (c *Kinesis) GetShardIteratorRequest(input *GetShardIteratorInput) (req *request.Request, output *GetShardIteratorOutput) {
- op := &request.Operation{
- Name: opGetShardIterator,
- HTTPMethod: "POST",
- HTTPPath: "/",
- }
- if input == nil {
- input = &GetShardIteratorInput{}
- }
- req = c.newRequest(op, input, output)
- output = &GetShardIteratorOutput{}
- req.Data = output
- return
- }
- // GetShardIterator API operation for Amazon Kinesis.
- //
- // Gets an Amazon Kinesis shard iterator. A shard iterator expires five minutes
- // after it is returned to the requester.
- //
- // A shard iterator specifies the shard position from which to start reading
- // data records sequentially. The position is specified using the sequence number
- // of a data record in a shard. A sequence number is the identifier associated
- // with every record ingested in the stream, and is assigned when a record is
- // put into the stream. Each stream has one or more shards.
- //
- // You must specify the shard iterator type. For example, you can set the ShardIteratorType
- // parameter to read exactly from the position denoted by a specific sequence
- // number by using the AT_SEQUENCE_NUMBER shard iterator type, or right after
- // the sequence number by using the AFTER_SEQUENCE_NUMBER shard iterator type,
- // using sequence numbers returned by earlier calls to PutRecord, PutRecords,
- // GetRecords, or DescribeStream. In the request, you can specify the shard
- // iterator type AT_TIMESTAMP to read records from an arbitrary point in time,
- // TRIM_HORIZON to cause ShardIterator to point to the last untrimmed record
- // in the shard in the system (the oldest data record in the shard), or LATEST
- // so that you always read the most recent data in the shard.
- //
- // When you read repeatedly from a stream, use a GetShardIterator request to
- // get the first shard iterator for use in your first GetRecords request and
- // for subsequent reads use the shard iterator returned by the GetRecords request
- // in NextShardIterator. A new shard iterator is returned by every GetRecords
- // request in NextShardIterator, which you use in the ShardIterator parameter
- // of the next GetRecords request.
- //
- // If a GetShardIterator request is made too often, you receive a ProvisionedThroughputExceededException.
- // For more information about throughput limits, see GetRecords, and Streams
- // Limits (http://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html)
- // in the Amazon Kinesis Streams Developer Guide.
- //
- // If the shard is closed, GetShardIterator returns a valid iterator for the
- // last sequence number of the shard. Note that a shard can be closed as a result
- // of using SplitShard or MergeShards.
- //
- // GetShardIterator has a limit of 5 transactions per second per account per
- // open shard.
- //
- // Returns awserr.Error for service API and SDK errors. Use runtime type assertions
- // with awserr.Error's Code and Message methods to get detailed information about
- // the error.
- //
- // See the AWS API reference guide for Amazon Kinesis's
- // API operation GetShardIterator for usage and error information.
- //
- // Returned Error Codes:
- // * ResourceNotFoundException
- // The requested resource could not be found. The stream might not be specified
- // correctly, or it might not be in the ACTIVE state if the operation requires
- // it.
- //
- // * InvalidArgumentException
- // A specified parameter exceeds its restrictions, is not supported, or can't
- // be used. For more information, see the returned message.
- //
- // * ProvisionedThroughputExceededException
- // The request rate for the stream is too high, or the requested data is too
- // large for the available throughput. Reduce the frequency or size of your
- // requests. For more information, see Streams Limits (http://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html)
- // in the Amazon Kinesis Streams Developer Guide, and Error Retries and Exponential
- // Backoff in AWS (http://docs.aws.amazon.com/general/latest/gr/api-retries.html)
- // in the AWS General Reference.
- //
- func (c *Kinesis) GetShardIterator(input *GetShardIteratorInput) (*GetShardIteratorOutput, error) {
- req, out := c.GetShardIteratorRequest(input)
- err := req.Send()
- return out, err
- }
- const opIncreaseStreamRetentionPeriod = "IncreaseStreamRetentionPeriod"
- // IncreaseStreamRetentionPeriodRequest generates a "aws/request.Request" representing the
- // client's request for the IncreaseStreamRetentionPeriod operation. The "output" return
- // value can be used to capture response data after the request's "Send" method
- // is called.
- //
- // See IncreaseStreamRetentionPeriod for usage and error information.
- //
- // Creating a request object using this method should be used when you want to inject
- // custom logic into the request's lifecycle using a custom handler, or if you want to
- // access properties on the request object before or after sending the request. If
- // you just want the service response, call the IncreaseStreamRetentionPeriod method directly
- // instead.
- //
- // Note: You must call the "Send" method on the returned request object in order
- // to execute the request.
- //
- // // Example sending a request using the IncreaseStreamRetentionPeriodRequest method.
- // req, resp := client.IncreaseStreamRetentionPeriodRequest(params)
- //
- // err := req.Send()
- // if err == nil { // resp is now filled
- // fmt.Println(resp)
- // }
- //
- func (c *Kinesis) IncreaseStreamRetentionPeriodRequest(input *IncreaseStreamRetentionPeriodInput) (req *request.Request, output *IncreaseStreamRetentionPeriodOutput) {
- op := &request.Operation{
- Name: opIncreaseStreamRetentionPeriod,
- HTTPMethod: "POST",
- HTTPPath: "/",
- }
- if input == nil {
- input = &IncreaseStreamRetentionPeriodInput{}
- }
- req = c.newRequest(op, input, output)
- req.Handlers.Unmarshal.Remove(jsonrpc.UnmarshalHandler)
- req.Handlers.Unmarshal.PushBackNamed(protocol.UnmarshalDiscardBodyHandler)
- output = &IncreaseStreamRetentionPeriodOutput{}
- req.Data = output
- return
- }
- // IncreaseStreamRetentionPeriod API operation for Amazon Kinesis.
- //
- // Increases the Amazon Kinesis stream's retention period, which is the length
- // of time data records are accessible after they are added to the stream. The
- // maximum value of a stream's retention period is 168 hours (7 days).
- //
- // Upon choosing a longer stream retention period, this operation will increase
- // the time period records are accessible that have not yet expired. However,
- // it will not make previous data that has expired (older than the stream's
- // previous retention period) accessible after the operation has been called.
- // For example, if a stream's retention period is set to 24 hours and is increased
- // to 168 hours, any data that is older than 24 hours will remain inaccessible
- // to consumer applications.
- //
- // Returns awserr.Error for service API and SDK errors. Use runtime type assertions
- // with awserr.Error's Code and Message methods to get detailed information about
- // the error.
- //
- // See the AWS API reference guide for Amazon Kinesis's
- // API operation IncreaseStreamRetentionPeriod for usage and error information.
- //
- // Returned Error Codes:
- // * ResourceInUseException
- // The resource is not available for this operation. For successful operation,
- // the resource needs to be in the ACTIVE state.
- //
- // * ResourceNotFoundException
- // The requested resource could not be found. The stream might not be specified
- // correctly, or it might not be in the ACTIVE state if the operation requires
- // it.
- //
- // * LimitExceededException
- // The requested resource exceeds the maximum number allowed, or the number
- // of concurrent stream requests exceeds the maximum number allowed (5).
- //
- // * InvalidArgumentException
- // A specified parameter exceeds its restrictions, is not supported, or can't
- // be used. For more information, see the returned message.
- //
- func (c *Kinesis) IncreaseStreamRetentionPeriod(input *IncreaseStreamRetentionPeriodInput) (*IncreaseStreamRetentionPeriodOutput, error) {
- req, out := c.IncreaseStreamRetentionPeriodRequest(input)
- err := req.Send()
- return out, err
- }
- const opListStreams = "ListStreams"
- // ListStreamsRequest generates a "aws/request.Request" representing the
- // client's request for the ListStreams operation. The "output" return
- // value can be used to capture response data after the request's "Send" method
- // is called.
- //
- // See ListStreams for usage and error information.
- //
- // Creating a request object using this method should be used when you want to inject
- // custom logic into the request's lifecycle using a custom handler, or if you want to
- // access properties on the request object before or after sending the request. If
- // you just want the service response, call the ListStreams method directly
- // instead.
- //
- // Note: You must call the "Send" method on the returned request object in order
- // to execute the request.
- //
- // // Example sending a request using the ListStreamsRequest method.
- // req, resp := client.ListStreamsRequest(params)
- //
- // err := req.Send()
- // if err == nil { // resp is now filled
- // fmt.Println(resp)
- // }
- //
- func (c *Kinesis) ListStreamsRequest(input *ListStreamsInput) (req *request.Request, output *ListStreamsOutput) {
- op := &request.Operation{
- Name: opListStreams,
- HTTPMethod: "POST",
- HTTPPath: "/",
- Paginator: &request.Paginator{
- InputTokens: []string{"ExclusiveStartStreamName"},
- OutputTokens: []string{"StreamNames[-1]"},
- LimitToken: "Limit",
- TruncationToken: "HasMoreStreams",
- },
- }
- if input == nil {
- input = &ListStreamsInput{}
- }
- req = c.newRequest(op, input, output)
- output = &ListStreamsOutput{}
- req.Data = output
- return
- }
- // ListStreams API operation for Amazon Kinesis.
- //
- // Lists your Amazon Kinesis streams.
- //
- // The number of streams may be too large to return from a single call to ListStreams.
- // You can limit the number of returned streams using the Limit parameter. If
- // you do not specify a value for the Limit parameter, Amazon Kinesis uses the
- // default limit, which is currently 10.
- //
- // You can detect if there are more streams available to list by using the HasMoreStreams
- // flag from the returned output. If there are more streams available, you can
- // request more streams by using the name of the last stream returned by the
- // ListStreams request in the ExclusiveStartStreamName parameter in a subsequent
- // request to ListStreams. The group of stream names returned by the subsequent
- // request is then added to the list. You can continue this process until all
- // the stream names have been collected in the list.
- //
- // ListStreams has a limit of 5 transactions per second per account.
- //
- // Returns awserr.Error for service API and SDK errors. Use runtime type assertions
- // with awserr.Error's Code and Message methods to get detailed information about
- // the error.
- //
- // See the AWS API reference guide for Amazon Kinesis's
- // API operation ListStreams for usage and error information.
- //
- // Returned Error Codes:
- // * LimitExceededException
- // The requested resource exceeds the maximum number allowed, or the number
- // of concurrent stream requests exceeds the maximum number allowed (5).
- //
- func (c *Kinesis) ListStreams(input *ListStreamsInput) (*ListStreamsOutput, error) {
- req, out := c.ListStreamsRequest(input)
- err := req.Send()
- return out, err
- }
- // ListStreamsPages iterates over the pages of a ListStreams operation,
- // calling the "fn" function with the response data for each page. To stop
- // iterating, return false from the fn function.
- //
- // See ListStreams method for more information on how to use this operation.
- //
- // Note: This operation can generate multiple requests to a service.
- //
- // // Example iterating over at most 3 pages of a ListStreams operation.
- // pageNum := 0
- // err := client.ListStreamsPages(params,
- // func(page *ListStreamsOutput, lastPage bool) bool {
- // pageNum++
- // fmt.Println(page)
- // return pageNum <= 3
- // })
- //
- func (c *Kinesis) ListStreamsPages(input *ListStreamsInput, fn func(p *ListStreamsOutput, lastPage bool) (shouldContinue bool)) error {
- page, _ := c.ListStreamsRequest(input)
- page.Handlers.Build.PushBack(request.MakeAddToUserAgentFreeFormHandler("Paginator"))
- return page.EachPage(func(p interface{}, lastPage bool) bool {
- return fn(p.(*ListStreamsOutput), lastPage)
- })
- }
- const opListTagsForStream = "ListTagsForStream"
- // ListTagsForStreamRequest generates a "aws/request.Request" representing the
- // client's request for the ListTagsForStream operation. The "output" return
- // value can be used to capture response data after the request's "Send" method
- // is called.
- //
- // See ListTagsForStream for usage and error information.
- //
- // Creating a request object using this method should be used when you want to inject
- // custom logic into the request's lifecycle using a custom handler, or if you want to
- // access properties on the request object before or after sending the request. If
- // you just want the service response, call the ListTagsForStream method directly
- // instead.
- //
- // Note: You must call the "Send" method on the returned request object in order
- // to execute the request.
- //
- // // Example sending a request using the ListTagsForStreamRequest method.
- // req, resp := client.ListTagsForStreamRequest(params)
- //
- // err := req.Send()
- // if err == nil { // resp is now filled
- // fmt.Println(resp)
- // }
- //
- func (c *Kinesis) ListTagsForStreamRequest(input *ListTagsForStreamInput) (req *request.Request, output *ListTagsForStreamOutput) {
- op := &request.Operation{
- Name: opListTagsForStream,
- HTTPMethod: "POST",
- HTTPPath: "/",
- }
- if input == nil {
- input = &ListTagsForStreamInput{}
- }
- req = c.newRequest(op, input, output)
- output = &ListTagsForStreamOutput{}
- req.Data = output
- return
- }
- // ListTagsForStream API operation for Amazon Kinesis.
- //
- // Lists the tags for the specified Amazon Kinesis stream.
- //
- // Returns awserr.Error for service API and SDK errors. Use runtime type assertions
- // with awserr.Error's Code and Message methods to get detailed information about
- // the error.
- //
- // See the AWS API reference guide for Amazon Kinesis's
- // API operation ListTagsForStream for usage and error information.
- //
- // Returned Error Codes:
- // * ResourceNotFoundException
- // The requested resource could not be found. The stream might not be specified
- // correctly, or it might not be in the ACTIVE state if the operation requires
- // it.
- //
- // * InvalidArgumentException
- // A specified parameter exceeds its restrictions, is not supported, or can't
- // be used. For more information, see the returned message.
- //
- // * LimitExceededException
- // The requested resource exceeds the maximum number allowed, or the number
- // of concurrent stream requests exceeds the maximum number allowed (5).
- //
- func (c *Kinesis) ListTagsForStream(input *ListTagsForStreamInput) (*ListTagsForStreamOutput, error) {
- req, out := c.ListTagsForStreamRequest(input)
- err := req.Send()
- return out, err
- }
- const opMergeShards = "MergeShards"
- // MergeShardsRequest generates a "aws/request.Request" representing the
- // client's request for the MergeShards operation. The "output" return
- // value can be used to capture response data after the request's "Send" method
- // is called.
- //
- // See MergeShards for usage and error information.
- //
- // Creating a request object using this method should be used when you want to inject
- // custom logic into the request's lifecycle using a custom handler, or if you want to
- // access properties on the request object before or after sending the request. If
- // you just want the service response, call the MergeShards method directly
- // instead.
- //
- // Note: You must call the "Send" method on the returned request object in order
- // to execute the request.
- //
- // // Example sending a request using the MergeShardsRequest method.
- // req, resp := client.MergeShardsRequest(params)
- //
- // err := req.Send()
- // if err == nil { // resp is now filled
- // fmt.Println(resp)
- // }
- //
- func (c *Kinesis) MergeShardsRequest(input *MergeShardsInput) (req *request.Request, output *MergeShardsOutput) {
- op := &request.Operation{
- Name: opMergeShards,
- HTTPMethod: "POST",
- HTTPPath: "/",
- }
- if input == nil {
- input = &MergeShardsInput{}
- }
- req = c.newRequest(op, input, output)
- req.Handlers.Unmarshal.Remove(jsonrpc.UnmarshalHandler)
- req.Handlers.Unmarshal.PushBackNamed(protocol.UnmarshalDiscardBodyHandler)
- output = &MergeShardsOutput{}
- req.Data = output
- return
- }
- // MergeShards API operation for Amazon Kinesis.
- //
- // Merges two adjacent shards in an Amazon Kinesis stream and combines them
- // into a single shard to reduce the stream's capacity to ingest and transport
- // data. Two shards are considered adjacent if the union of the hash key ranges
- // for the two shards form a contiguous set with no gaps. For example, if you
- // have two shards, one with a hash key range of 276...381 and the other with
- // a hash key range of 382...454, then you could merge these two shards into
- // a single shard that would have a hash key range of 276...454. After the merge,
- // the single child shard receives data for all hash key values covered by the
- // two parent shards.
- //
- // MergeShards is called when there is a need to reduce the overall capacity
- // of a stream because of excess capacity that is not being used. You must specify
- // the shard to be merged and the adjacent shard for a stream. For more information
- // about merging shards, see Merge Two Shards (http://docs.aws.amazon.com/kinesis/latest/dev/kinesis-using-sdk-java-resharding-merge.html)
- // in the Amazon Kinesis Streams Developer Guide.
- //
- // If the stream is in the ACTIVE state, you can call MergeShards. If a stream
- // is in the CREATING, UPDATING, or DELETING state, MergeShards returns a ResourceInUseException.
- // If the specified stream does not exist, MergeShards returns a ResourceNotFoundException.
- //
- // You can use DescribeStream to check the state of the stream, which is returned
- // in StreamStatus.
- //
- // MergeShards is an asynchronous operation. Upon receiving a MergeShards request,
- // Amazon Kinesis immediately returns a response and sets the StreamStatus to
- // UPDATING. After the operation is completed, Amazon Kinesis sets the StreamStatus
- // to ACTIVE. Read and write operations continue to work while the stream is
- // in the UPDATING state.
- //
- // You use DescribeStream to determine the shard IDs that are specified in the
- // MergeShards request.
- //
- // If you try to operate on too many streams in parallel using CreateStream,
- // DeleteStream, MergeShards or SplitShard, you will receive a LimitExceededException.
- //
- // MergeShards has limit of 5 transactions per second per account.
- //
- // Returns awserr.Error for service API and SDK errors. Use runtime type assertions
- // with awserr.Error's Code and Message methods to get detailed information about
- // the error.
- //
- // See the AWS API reference guide for Amazon Kinesis's
- // API operation MergeShards for usage and error information.
- //
- // Returned Error Codes:
- // * ResourceNotFoundException
- // The requested resource could not be found. The stream might not be specified
- // correctly, or it might not be in the ACTIVE state if the operation requires
- // it.
- //
- // * ResourceInUseException
- // The resource is not available for this operation. For successful operation,
- // the resource needs to be in the ACTIVE state.
- //
- // * InvalidArgumentException
- // A specified parameter exceeds its restrictions, is not supported, or can't
- // be used. For more information, see the returned message.
- //
- // * LimitExceededException
- // The requested resource exceeds the maximum number allowed, or the number
- // of concurrent stream requests exceeds the maximum number allowed (5).
- //
- func (c *Kinesis) MergeShards(input *MergeShardsInput) (*MergeShardsOutput, error) {
- req, out := c.MergeShardsRequest(input)
- err := req.Send()
- return out, err
- }
- const opPutRecord = "PutRecord"
- // PutRecordRequest generates a "aws/request.Request" representing the
- // client's request for the PutRecord operation. The "output" return
- // value can be used to capture response data after the request's "Send" method
- // is called.
- //
- // See PutRecord for usage and error information.
- //
- // Creating a request object using this method should be used when you want to inject
- // custom logic into the request's lifecycle using a custom handler, or if you want to
- // access properties on the request object before or after sending the request. If
- // you just want the service response, call the PutRecord method directly
- // instead.
- //
- // Note: You must call the "Send" method on the returned request object in order
- // to execute the request.
- //
- // // Example sending a request using the PutRecordRequest method.
- // req, resp := client.PutRecordRequest(params)
- //
- // err := req.Send()
- // if err == nil { // resp is now filled
- // fmt.Println(resp)
- // }
- //
- func (c *Kinesis) PutRecordRequest(input *PutRecordInput) (req *request.Request, output *PutRecordOutput) {
- op := &request.Operation{
- Name: opPutRecord,
- HTTPMethod: "POST",
- HTTPPath: "/",
- }
- if input == nil {
- input = &PutRecordInput{}
- }
- req = c.newRequest(op, input, output)
- output = &PutRecordOutput{}
- req.Data = output
- return
- }
- // PutRecord API operation for Amazon Kinesis.
- //
- // Writes a single data record into an Amazon Kinesis stream. Call PutRecord
- // to send data into the stream for real-time ingestion and subsequent processing,
- // one record at a time. Each shard can support writes up to 1,000 records per
- // second, up to a maximum data write total of 1 MB per second.
- //
- // You must specify the name of the stream that captures, stores, and transports
- // the data; a partition key; and the data blob itself.
- //
- // The data blob can be any type of data; for example, a segment from a log
- // file, geographic/location data, website clickstream data, and so on.
- //
- // The partition key is used by Amazon Kinesis to distribute data across shards.
- // Amazon Kinesis segregates the data records that belong to a stream into multiple
- // shards, using the partition key associated with each data record to determine
- // which shard a given data record belongs to.
- //
- // Partition keys are Unicode strings, with a maximum length limit of 256 characters
- // for each key. An MD5 hash function is used to map partition keys to 128-bit
- // integer values and to map associated data records to shards using the hash
- // key ranges of the shards. You can override hashing the partition key to determine
- // the shard by explicitly specifying a hash value using the ExplicitHashKey
- // parameter. For more information, see Adding Data to a Stream (http://docs.aws.amazon.com/kinesis/latest/dev/developing-producers-with-sdk.html#kinesis-using-sdk-java-add-data-to-stream)
- // in the Amazon Kinesis Streams Developer Guide.
- //
- // PutRecord returns the shard ID of where the data record was placed and the
- // sequence number that was assigned to the data record.
- //
- // Sequence numbers increase over time and are specific to a shard within a
- // stream, not across all shards within a stream. To guarantee strictly increasing
- // ordering, write serially to a shard and use the SequenceNumberForOrdering
- // parameter. For more information, see Adding Data to a Stream (http://docs.aws.amazon.com/kinesis/latest/dev/developing-producers-with-sdk.html#kinesis-using-sdk-java-add-data-to-stream)
- // in the Amazon Kinesis Streams Developer Guide.
- //
- // If a PutRecord request cannot be processed because of insufficient provisioned
- // throughput on the shard involved in the request, PutRecord throws ProvisionedThroughputExceededException.
- //
- // Data records are accessible for only 24 hours from the time that they are
- // added to a stream.
- //
- // Returns awserr.Error for service API and SDK errors. Use runtime type assertions
- // with awserr.Error's Code and Message methods to get detailed information about
- // the error.
- //
- // See the AWS API reference guide for Amazon Kinesis's
- // API operation PutRecord for usage and error information.
- //
- // Returned Error Codes:
- // * ResourceNotFoundException
- // The requested resource could not be found. The stream might not be specified
- // correctly, or it might not be in the ACTIVE state if the operation requires
- // it.
- //
- // * InvalidArgumentException
- // A specified parameter exceeds its restrictions, is not supported, or can't
- // be used. For more information, see the returned message.
- //
- // * ProvisionedThroughputExceededException
- // The request rate for the stream is too high, or the requested data is too
- // large for the available throughput. Reduce the frequency or size of your
- // requests. For more information, see Streams Limits (http://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html)
- // in the Amazon Kinesis Streams Developer Guide, and Error Retries and Exponential
- // Backoff in AWS (http://docs.aws.amazon.com/general/latest/gr/api-retries.html)
- // in the AWS General Reference.
- //
- func (c *Kinesis) PutRecord(input *PutRecordInput) (*PutRecordOutput, error) {
- req, out := c.PutRecordRequest(input)
- err := req.Send()
- return out, err
- }
- const opPutRecords = "PutRecords"
- // PutRecordsRequest generates a "aws/request.Request" representing the
- // client's request for the PutRecords operation. The "output" return
- // value can be used to capture response data after the request's "Send" method
- // is called.
- //
- // See PutRecords for usage and error information.
- //
- // Creating a request object using this method should be used when you want to inject
- // custom logic into the request's lifecycle using a custom handler, or if you want to
- // access properties on the request object before or after sending the request. If
- // you just want the service response, call the PutRecords method directly
- // instead.
- //
- // Note: You must call the "Send" method on the returned request object in order
- // to execute the request.
- //
- // // Example sending a request using the PutRecordsRequest method.
- // req, resp := client.PutRecordsRequest(params)
- //
- // err := req.Send()
- // if err == nil { // resp is now filled
- // fmt.Println(resp)
- // }
- //
- func (c *Kinesis) PutRecordsRequest(input *PutRecordsInput) (req *request.Request, output *PutRecordsOutput) {
- op := &request.Operation{
- Name: opPutRecords,
- HTTPMethod: "POST",
- HTTPPath: "/",
- }
- if input == nil {
- input = &PutRecordsInput{}
- }
- req = c.newRequest(op, input, output)
- output = &PutRecordsOutput{}
- req.Data = output
- return
- }
- // PutRecords API operation for Amazon Kinesis.
- //
- // Writes multiple data records into an Amazon Kinesis stream in a single call
- // (also referred to as a PutRecords request). Use this operation to send data
- // into the stream for data ingestion and processing.
- //
- // Each PutRecords request can support up to 500 records. Each record in the
- // request can be as large as 1 MB, up to a limit of 5 MB for the entire request,
- // including partition keys. Each shard can support writes up to 1,000 records
- // per second, up to a maximum data write total of 1 MB per second.
- //
- // You must specify the name of the stream that captures, stores, and transports
- // the data; and an array of request Records, with each record in the array
- // requiring a partition key and data blob. The record size limit applies to
- // the total size of the partition key and data blob.
- //
- // The data blob can be any type of data; for example, a segment from a log
- // file, geographic/location data, website clickstream data, and so on.
- //
- // The partition key is used by Amazon Kinesis as input to a hash function that
- // maps the partition key and associated data to a specific shard. An MD5 hash
- // function is used to map partition keys to 128-bit integer values and to map
- // associated data records to shards. As a result of this hashing mechanism,
- // all data records with the same partition key map to the same shard within
- // the stream. For more information, see Adding Data to a Stream (http://docs.aws.amazon.com/kinesis/latest/dev/developing-producers-with-sdk.html#kinesis-using-sdk-java-add-data-to-stream)
- // in the Amazon Kinesis Streams Developer Guide.
- //
- // Each record in the Records array may include an optional parameter, ExplicitHashKey,
- // which overrides the partition key to shard mapping. This parameter allows
- // a data producer to determine explicitly the shard where the record is stored.
- // For more information, see Adding Multiple Records with PutRecords (http://docs.aws.amazon.com/kinesis/latest/dev/developing-producers-with-sdk.html#kinesis-using-sdk-java-putrecords)
- // in the Amazon Kinesis Streams Developer Guide.
- //
- // The PutRecords response includes an array of response Records. Each record
- // in the response array directly correlates with a record in the request array
- // using natural ordering, from the top to the bottom of the request and response.
- // The response Records array always includes the same number of records as
- // the request array.
- //
- // The response Records array includes both successfully and unsuccessfully
- // processed records. Amazon Kinesis attempts to process all records in each
- // PutRecords request. A single record failure does not stop the processing
- // of subsequent records.
- //
- // A successfully-processed record includes ShardId and SequenceNumber values.
- // The ShardId parameter identifies the shard in the stream where the record
- // is stored. The SequenceNumber parameter is an identifier assigned to the
- // put record, unique to all records in the stream.
- //
- // An unsuccessfully-processed record includes ErrorCode and ErrorMessage values.
- // ErrorCode reflects the type of error and can be one of the following values:
- // ProvisionedThroughputExceededException or InternalFailure. ErrorMessage provides
- // more detailed information about the ProvisionedThroughputExceededException
- // exception including the account ID, stream name, and shard ID of the record
- // that was throttled. For more information about partially successful responses,
- // see Adding Multiple Records with PutRecords (http://docs.aws.amazon.com/kinesis/latest/dev/kinesis-using-sdk-java-add-data-to-stream.html#kinesis-using-sdk-java-putrecords)
- // in the Amazon Kinesis Streams Developer Guide.
- //
- // By default, data records are accessible for only 24 hours from the time that
- // they are added to an Amazon Kinesis stream. This retention period can be
- // modified using the DecreaseStreamRetentionPeriod and IncreaseStreamRetentionPeriod
- // operations.
- //
- // Returns awserr.Error for service API and SDK errors. Use runtime type assertions
- // with awserr.Error's Code and Message methods to get detailed information about
- // the error.
- //
- // See the AWS API reference guide for Amazon Kinesis's
- // API operation PutRecords for usage and error information.
- //
- // Returned Error Codes:
- // * ResourceNotFoundException
- // The requested resource could not be found. The stream might not be specified
- // correctly, or it might not be in the ACTIVE state if the operation requires
- // it.
- //
- // * InvalidArgumentException
- // A specified parameter exceeds its restrictions, is not supported, or can't
- // be used. For more information, see the returned message.
- //
- // * ProvisionedThroughputExceededException
- // The request rate for the stream is too high, or the requested data is too
- // large for the available throughput. Reduce the frequency or size of your
- // requests. For more information, see Streams Limits (http://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html)
- // in the Amazon Kinesis Streams Developer Guide, and Error Retries and Exponential
- // Backoff in AWS (http://docs.aws.amazon.com/general/latest/gr/api-retries.html)
- // in the AWS General Reference.
- //
- func (c *Kinesis) PutRecords(input *PutRecordsInput) (*PutRecordsOutput, error) {
- req, out := c.PutRecordsRequest(input)
- err := req.Send()
- return out, err
- }
- const opRemoveTagsFromStream = "RemoveTagsFromStream"
- // RemoveTagsFromStreamRequest generates a "aws/request.Request" representing the
- // client's request for the RemoveTagsFromStream operation. The "output" return
- // value can be used to capture response data after the request's "Send" method
- // is called.
- //
- // See RemoveTagsFromStream for usage and error information.
- //
- // Creating a request object using this method should be used when you want to inject
- // custom logic into the request's lifecycle using a custom handler, or if you want to
- // access properties on the request object before or after sending the request. If
- // you just want the service response, call the RemoveTagsFromStream method directly
- // instead.
- //
- // Note: You must call the "Send" method on the returned request object in order
- // to execute the request.
- //
- // // Example sending a request using the RemoveTagsFromStreamRequest method.
- // req, resp := client.RemoveTagsFromStreamRequest(params)
- //
- // err := req.Send()
- // if err == nil { // resp is now filled
- // fmt.Println(resp)
- // }
- //
- func (c *Kinesis) RemoveTagsFromStreamRequest(input *RemoveTagsFromStreamInput) (req *request.Request, output *RemoveTagsFromStreamOutput) {
- op := &request.Operation{
- Name: opRemoveTagsFromStream,
- HTTPMethod: "POST",
- HTTPPath: "/",
- }
- if input == nil {
- input = &RemoveTagsFromStreamInput{}
- }
- req = c.newRequest(op, input, output)
- req.Handlers.Unmarshal.Remove(jsonrpc.UnmarshalHandler)
- req.Handlers.Unmarshal.PushBackNamed(protocol.UnmarshalDiscardBodyHandler)
- output = &RemoveTagsFromStreamOutput{}
- req.Data = output
- return
- }
- // RemoveTagsFromStream API operation for Amazon Kinesis.
- //
- // Removes tags from the specified Amazon Kinesis stream. Removed tags are deleted
- // and cannot be recovered after this operation successfully completes.
- //
- // If you specify a tag that does not exist, it is ignored.
- //
- // Returns awserr.Error for service API and SDK errors. Use runtime type assertions
- // with awserr.Error's Code and Message methods to get detailed information about
- // the error.
- //
- // See the AWS API reference guide for Amazon Kinesis's
- // API operation RemoveTagsFromStream for usage and error information.
- //
- // Returned Error Codes:
- // * ResourceNotFoundException
- // The requested resource could not be found. The stream might not be specified
- // correctly, or it might not be in the ACTIVE state if the operation requires
- // it.
- //
- // * ResourceInUseException
- // The resource is not available for this operation. For successful operation,
- // the resource needs to be in the ACTIVE state.
- //
- // * InvalidArgumentException
- // A specified parameter exceeds its restrictions, is not supported, or can't
- // be used. For more information, see the returned message.
- //
- // * LimitExceededException
- // The requested resource exceeds the maximum number allowed, or the number
- // of concurrent stream requests exceeds the maximum number allowed (5).
- //
- func (c *Kinesis) RemoveTagsFromStream(input *RemoveTagsFromStreamInput) (*RemoveTagsFromStreamOutput, error) {
- req, out := c.RemoveTagsFromStreamRequest(input)
- err := req.Send()
- return out, err
- }
- const opSplitShard = "SplitShard"
- // SplitShardRequest generates a "aws/request.Request" representing the
- // client's request for the SplitShard operation. The "output" return
- // value can be used to capture response data after the request's "Send" method
- // is called.
- //
- // See SplitShard for usage and error information.
- //
- // Creating a request object using this method should be used when you want to inject
- // custom logic into the request's lifecycle using a custom handler, or if you want to
- // access properties on the request object before or after sending the request. If
- // you just want the service response, call the SplitShard method directly
- // instead.
- //
- // Note: You must call the "Send" method on the returned request object in order
- // to execute the request.
- //
- // // Example sending a request using the SplitShardRequest method.
- // req, resp := client.SplitShardRequest(params)
- //
- // err := req.Send()
- // if err == nil { // resp is now filled
- // fmt.Println(resp)
- // }
- //
- func (c *Kinesis) SplitShardRequest(input *SplitShardInput) (req *request.Request, output *SplitShardOutput) {
- op := &request.Operation{
- Name: opSplitShard,
- HTTPMethod: "POST",
- HTTPPath: "/",
- }
- if input == nil {
- input = &SplitShardInput{}
- }
- req = c.newRequest(op, input, output)
- req.Handlers.Unmarshal.Remove(jsonrpc.UnmarshalHandler)
- req.Handlers.Unmarshal.PushBackNamed(protocol.UnmarshalDiscardBodyHandler)
- output = &SplitShardOutput{}
- req.Data = output
- return
- }
- // SplitShard API operation for Amazon Kinesis.
- //
- // Splits a shard into two new shards in the Amazon Kinesis stream to increase
- // the stream's capacity to ingest and transport data. SplitShard is called
- // when there is a need to increase the overall capacity of a stream because
- // of an expected increase in the volume of data records being ingested.
- //
- // You can also use SplitShard when a shard appears to be approaching its maximum
- // utilization; for example, the producers sending data into the specific shard
- // are suddenly sending more than previously anticipated. You can also call
- // SplitShard to increase stream capacity, so that more Amazon Kinesis applications
- // can simultaneously read data from the stream for real-time processing.
- //
- // You must specify the shard to be split and the new hash key, which is the
- // position in the shard where the shard gets split in two. In many cases, the
- // new hash key might simply be the average of the beginning and ending hash
- // key, but it can be any hash key value in the range being mapped into the
- // shard. For more information about splitting shards, see Split a Shard (http://docs.aws.amazon.com/kinesis/latest/dev/kinesis-using-sdk-java-resharding-split.html)
- // in the Amazon Kinesis Streams Developer Guide.
- //
- // You can use DescribeStream to determine the shard ID and hash key values
- // for the ShardToSplit and NewStartingHashKey parameters that are specified
- // in the SplitShard request.
- //
- // SplitShard is an asynchronous operation. Upon receiving a SplitShard request,
- // Amazon Kinesis immediately returns a response and sets the stream status
- // to UPDATING. After the operation is completed, Amazon Kinesis sets the stream
- // status to ACTIVE. Read and write operations continue to work while the stream
- // is in the UPDATING state.
- //
- // You can use DescribeStream to check the status of the stream, which is returned
- // in StreamStatus. If the stream is in the ACTIVE state, you can call SplitShard.
- // If a stream is in CREATING or UPDATING or DELETING states, DescribeStream
- // returns a ResourceInUseException.
- //
- // If the specified stream does not exist, DescribeStream returns a ResourceNotFoundException.
- // If you try to create more shards than are authorized for your account, you
- // receive a LimitExceededException.
- //
- // For the default shard limit for an AWS account, see Streams Limits (http://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html)
- // in the Amazon Kinesis Streams Developer Guide. If you need to increase this
- // limit, contact AWS Support (http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html).
- //
- // If you try to operate on too many streams simultaneously using CreateStream,
- // DeleteStream, MergeShards, and/or SplitShard, you receive a LimitExceededException.
- //
- // SplitShard has limit of 5 transactions per second per account.
- //
- // Returns awserr.Error for service API and SDK errors. Use runtime type assertions
- // with awserr.Error's Code and Message methods to get detailed information about
- // the error.
- //
- // See the AWS API reference guide for Amazon Kinesis's
- // API operation SplitShard for usage and error information.
- //
- // Returned Error Codes:
- // * ResourceNotFoundException
- // The requested resource could not be found. The stream might not be specified
- // correctly, or it might not be in the ACTIVE state if the operation requires
- // it.
- //
- // * ResourceInUseException
- // The resource is not available for this operation. For successful operation,
- // the resource needs to be in the ACTIVE state.
- //
- // * InvalidArgumentException
- // A specified parameter exceeds its restrictions, is not supported, or can't
- // be used. For more information, see the returned message.
- //
- // * LimitExceededException
- // The requested resource exceeds the maximum number allowed, or the number
- // of concurrent stream requests exceeds the maximum number allowed (5).
- //
- func (c *Kinesis) SplitShard(input *SplitShardInput) (*SplitShardOutput, error) {
- req, out := c.SplitShardRequest(input)
- err := req.Send()
- return out, err
- }
- // Represents the input for AddTagsToStream.
- type AddTagsToStreamInput struct {
- _ struct{} `type:"structure"`
- // The name of the stream.
- //
- // StreamName is a required field
- StreamName *string `min:"1" type:"string" required:"true"`
- // The set of key-value pairs to use to create the tags.
- //
- // Tags is a required field
- Tags map[string]*string `min:"1" type:"map" required:"true"`
- }
- // String returns the string representation
- func (s AddTagsToStreamInput) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s AddTagsToStreamInput) GoString() string {
- return s.String()
- }
- // Validate inspects the fields of the type to determine if they are valid.
- func (s *AddTagsToStreamInput) Validate() error {
- invalidParams := request.ErrInvalidParams{Context: "AddTagsToStreamInput"}
- if s.StreamName == nil {
- invalidParams.Add(request.NewErrParamRequired("StreamName"))
- }
- if s.StreamName != nil && len(*s.StreamName) < 1 {
- invalidParams.Add(request.NewErrParamMinLen("StreamName", 1))
- }
- if s.Tags == nil {
- invalidParams.Add(request.NewErrParamRequired("Tags"))
- }
- if s.Tags != nil && len(s.Tags) < 1 {
- invalidParams.Add(request.NewErrParamMinLen("Tags", 1))
- }
- if invalidParams.Len() > 0 {
- return invalidParams
- }
- return nil
- }
- type AddTagsToStreamOutput struct {
- _ struct{} `type:"structure"`
- }
- // String returns the string representation
- func (s AddTagsToStreamOutput) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s AddTagsToStreamOutput) GoString() string {
- return s.String()
- }
- // Represents the input for CreateStream.
- type CreateStreamInput struct {
- _ struct{} `type:"structure"`
- // The number of shards that the stream will use. The throughput of the stream
- // is a function of the number of shards; more shards are required for greater
- // provisioned throughput.
- //
- // DefaultShardLimit;
- //
- // ShardCount is a required field
- ShardCount *int64 `min:"1" type:"integer" required:"true"`
- // A name to identify the stream. The stream name is scoped to the AWS account
- // used by the application that creates the stream. It is also scoped by region.
- // That is, two streams in two different AWS accounts can have the same name,
- // and two streams in the same AWS account but in two different regions can
- // have the same name.
- //
- // StreamName is a required field
- StreamName *string `min:"1" type:"string" required:"true"`
- }
- // String returns the string representation
- func (s CreateStreamInput) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s CreateStreamInput) GoString() string {
- return s.String()
- }
- // Validate inspects the fields of the type to determine if they are valid.
- func (s *CreateStreamInput) Validate() error {
- invalidParams := request.ErrInvalidParams{Context: "CreateStreamInput"}
- if s.ShardCount == nil {
- invalidParams.Add(request.NewErrParamRequired("ShardCount"))
- }
- if s.ShardCount != nil && *s.ShardCount < 1 {
- invalidParams.Add(request.NewErrParamMinValue("ShardCount", 1))
- }
- if s.StreamName == nil {
- invalidParams.Add(request.NewErrParamRequired("StreamName"))
- }
- if s.StreamName != nil && len(*s.StreamName) < 1 {
- invalidParams.Add(request.NewErrParamMinLen("StreamName", 1))
- }
- if invalidParams.Len() > 0 {
- return invalidParams
- }
- return nil
- }
- type CreateStreamOutput struct {
- _ struct{} `type:"structure"`
- }
- // String returns the string representation
- func (s CreateStreamOutput) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s CreateStreamOutput) GoString() string {
- return s.String()
- }
- // Represents the input for DecreaseStreamRetentionPeriod.
- type DecreaseStreamRetentionPeriodInput struct {
- _ struct{} `type:"structure"`
- // The new retention period of the stream, in hours. Must be less than the current
- // retention period.
- //
- // RetentionPeriodHours is a required field
- RetentionPeriodHours *int64 `min:"24" type:"integer" required:"true"`
- // The name of the stream to modify.
- //
- // StreamName is a required field
- StreamName *string `min:"1" type:"string" required:"true"`
- }
- // String returns the string representation
- func (s DecreaseStreamRetentionPeriodInput) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s DecreaseStreamRetentionPeriodInput) GoString() string {
- return s.String()
- }
- // Validate inspects the fields of the type to determine if they are valid.
- func (s *DecreaseStreamRetentionPeriodInput) Validate() error {
- invalidParams := request.ErrInvalidParams{Context: "DecreaseStreamRetentionPeriodInput"}
- if s.RetentionPeriodHours == nil {
- invalidParams.Add(request.NewErrParamRequired("RetentionPeriodHours"))
- }
- if s.RetentionPeriodHours != nil && *s.RetentionPeriodHours < 24 {
- invalidParams.Add(request.NewErrParamMinValue("RetentionPeriodHours", 24))
- }
- if s.StreamName == nil {
- invalidParams.Add(request.NewErrParamRequired("StreamName"))
- }
- if s.StreamName != nil && len(*s.StreamName) < 1 {
- invalidParams.Add(request.NewErrParamMinLen("StreamName", 1))
- }
- if invalidParams.Len() > 0 {
- return invalidParams
- }
- return nil
- }
- type DecreaseStreamRetentionPeriodOutput struct {
- _ struct{} `type:"structure"`
- }
- // String returns the string representation
- func (s DecreaseStreamRetentionPeriodOutput) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s DecreaseStreamRetentionPeriodOutput) GoString() string {
- return s.String()
- }
- // Represents the input for DeleteStream.
- type DeleteStreamInput struct {
- _ struct{} `type:"structure"`
- // The name of the stream to delete.
- //
- // StreamName is a required field
- StreamName *string `min:"1" type:"string" required:"true"`
- }
- // String returns the string representation
- func (s DeleteStreamInput) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s DeleteStreamInput) GoString() string {
- return s.String()
- }
- // Validate inspects the fields of the type to determine if they are valid.
- func (s *DeleteStreamInput) Validate() error {
- invalidParams := request.ErrInvalidParams{Context: "DeleteStreamInput"}
- if s.StreamName == nil {
- invalidParams.Add(request.NewErrParamRequired("StreamName"))
- }
- if s.StreamName != nil && len(*s.StreamName) < 1 {
- invalidParams.Add(request.NewErrParamMinLen("StreamName", 1))
- }
- if invalidParams.Len() > 0 {
- return invalidParams
- }
- return nil
- }
- type DeleteStreamOutput struct {
- _ struct{} `type:"structure"`
- }
- // String returns the string representation
- func (s DeleteStreamOutput) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s DeleteStreamOutput) GoString() string {
- return s.String()
- }
- // Represents the input for DescribeStream.
- type DescribeStreamInput struct {
- _ struct{} `type:"structure"`
- // The shard ID of the shard to start with.
- ExclusiveStartShardId *string `min:"1" type:"string"`
- // The maximum number of shards to return.
- Limit *int64 `min:"1" type:"integer"`
- // The name of the stream to describe.
- //
- // StreamName is a required field
- StreamName *string `min:"1" type:"string" required:"true"`
- }
- // String returns the string representation
- func (s DescribeStreamInput) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s DescribeStreamInput) GoString() string {
- return s.String()
- }
- // Validate inspects the fields of the type to determine if they are valid.
- func (s *DescribeStreamInput) Validate() error {
- invalidParams := request.ErrInvalidParams{Context: "DescribeStreamInput"}
- if s.ExclusiveStartShardId != nil && len(*s.ExclusiveStartShardId) < 1 {
- invalidParams.Add(request.NewErrParamMinLen("ExclusiveStartShardId", 1))
- }
- if s.Limit != nil && *s.Limit < 1 {
- invalidParams.Add(request.NewErrParamMinValue("Limit", 1))
- }
- if s.StreamName == nil {
- invalidParams.Add(request.NewErrParamRequired("StreamName"))
- }
- if s.StreamName != nil && len(*s.StreamName) < 1 {
- invalidParams.Add(request.NewErrParamMinLen("StreamName", 1))
- }
- if invalidParams.Len() > 0 {
- return invalidParams
- }
- return nil
- }
- // Represents the output for DescribeStream.
- type DescribeStreamOutput struct {
- _ struct{} `type:"structure"`
- // The current status of the stream, the stream ARN, an array of shard objects
- // that comprise the stream, and states whether there are more shards available.
- //
- // StreamDescription is a required field
- StreamDescription *StreamDescription `type:"structure" required:"true"`
- }
- // String returns the string representation
- func (s DescribeStreamOutput) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s DescribeStreamOutput) GoString() string {
- return s.String()
- }
- // Represents the input for DisableEnhancedMonitoring.
- type DisableEnhancedMonitoringInput struct {
- _ struct{} `type:"structure"`
- // List of shard-level metrics to disable.
- //
- // The following are the valid shard-level metrics. The value "ALL" disables
- // every metric.
- //
- // * IncomingBytes
- // * IncomingRecords
- // * OutgoingBytes
- // * OutgoingRecords
- // * WriteProvisionedThroughputExceeded
- // * ReadProvisionedThroughputExceeded
- // * IteratorAgeMilliseconds
- // * ALL
- // For more information, see Monitoring the Amazon Kinesis Streams Service with
- // Amazon CloudWatch (http://docs.aws.amazon.com/kinesis/latest/dev/monitoring-with-cloudwatch.html)
- // in the Amazon Kinesis Streams Developer Guide.
- //
- // ShardLevelMetrics is a required field
- ShardLevelMetrics []*string `min:"1" type:"list" required:"true"`
- // The name of the Amazon Kinesis stream for which to disable enhanced monitoring.
- //
- // StreamName is a required field
- StreamName *string `min:"1" type:"string" required:"true"`
- }
- // String returns the string representation
- func (s DisableEnhancedMonitoringInput) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s DisableEnhancedMonitoringInput) GoString() string {
- return s.String()
- }
- // Validate inspects the fields of the type to determine if they are valid.
- func (s *DisableEnhancedMonitoringInput) Validate() error {
- invalidParams := request.ErrInvalidParams{Context: "DisableEnhancedMonitoringInput"}
- if s.ShardLevelMetrics == nil {
- invalidParams.Add(request.NewErrParamRequired("ShardLevelMetrics"))
- }
- if s.ShardLevelMetrics != nil && len(s.ShardLevelMetrics) < 1 {
- invalidParams.Add(request.NewErrParamMinLen("ShardLevelMetrics", 1))
- }
- if s.StreamName == nil {
- invalidParams.Add(request.NewErrParamRequired("StreamName"))
- }
- if s.StreamName != nil && len(*s.StreamName) < 1 {
- invalidParams.Add(request.NewErrParamMinLen("StreamName", 1))
- }
- if invalidParams.Len() > 0 {
- return invalidParams
- }
- return nil
- }
- // Represents the input for EnableEnhancedMonitoring.
- type EnableEnhancedMonitoringInput struct {
- _ struct{} `type:"structure"`
- // List of shard-level metrics to enable.
- //
- // The following are the valid shard-level metrics. The value "ALL" enables
- // every metric.
- //
- // * IncomingBytes
- // * IncomingRecords
- // * OutgoingBytes
- // * OutgoingRecords
- // * WriteProvisionedThroughputExceeded
- // * ReadProvisionedThroughputExceeded
- // * IteratorAgeMilliseconds
- // * ALL
- // For more information, see Monitoring the Amazon Kinesis Streams Service with
- // Amazon CloudWatch (http://docs.aws.amazon.com/kinesis/latest/dev/monitoring-with-cloudwatch.html)
- // in the Amazon Kinesis Streams Developer Guide.
- //
- // ShardLevelMetrics is a required field
- ShardLevelMetrics []*string `min:"1" type:"list" required:"true"`
- // The name of the stream for which to enable enhanced monitoring.
- //
- // StreamName is a required field
- StreamName *string `min:"1" type:"string" required:"true"`
- }
- // String returns the string representation
- func (s EnableEnhancedMonitoringInput) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s EnableEnhancedMonitoringInput) GoString() string {
- return s.String()
- }
- // Validate inspects the fields of the type to determine if they are valid.
- func (s *EnableEnhancedMonitoringInput) Validate() error {
- invalidParams := request.ErrInvalidParams{Context: "EnableEnhancedMonitoringInput"}
- if s.ShardLevelMetrics == nil {
- invalidParams.Add(request.NewErrParamRequired("ShardLevelMetrics"))
- }
- if s.ShardLevelMetrics != nil && len(s.ShardLevelMetrics) < 1 {
- invalidParams.Add(request.NewErrParamMinLen("ShardLevelMetrics", 1))
- }
- if s.StreamName == nil {
- invalidParams.Add(request.NewErrParamRequired("StreamName"))
- }
- if s.StreamName != nil && len(*s.StreamName) < 1 {
- invalidParams.Add(request.NewErrParamMinLen("StreamName", 1))
- }
- if invalidParams.Len() > 0 {
- return invalidParams
- }
- return nil
- }
- // Represents enhanced metrics types.
- type EnhancedMetrics struct {
- _ struct{} `type:"structure"`
- // List of shard-level metrics.
- //
- // The following are the valid shard-level metrics. The value "ALL" enhances
- // every metric.
- //
- // * IncomingBytes
- // * IncomingRecords
- // * OutgoingBytes
- // * OutgoingRecords
- // * WriteProvisionedThroughputExceeded
- // * ReadProvisionedThroughputExceeded
- // * IteratorAgeMilliseconds
- // * ALL
- // For more information, see Monitoring the Amazon Kinesis Streams Service with
- // Amazon CloudWatch (http://docs.aws.amazon.com/kinesis/latest/dev/monitoring-with-cloudwatch.html)
- // in the Amazon Kinesis Streams Developer Guide.
- ShardLevelMetrics []*string `min:"1" type:"list"`
- }
- // String returns the string representation
- func (s EnhancedMetrics) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s EnhancedMetrics) GoString() string {
- return s.String()
- }
- // Represents the output for EnableEnhancedMonitoring and DisableEnhancedMonitoring.
- type EnhancedMonitoringOutput struct {
- _ struct{} `type:"structure"`
- // Represents the current state of the metrics that are in the enhanced state
- // before the operation.
- CurrentShardLevelMetrics []*string `min:"1" type:"list"`
- // Represents the list of all the metrics that would be in the enhanced state
- // after the operation.
- DesiredShardLevelMetrics []*string `min:"1" type:"list"`
- // The name of the Amazon Kinesis stream.
- StreamName *string `min:"1" type:"string"`
- }
- // String returns the string representation
- func (s EnhancedMonitoringOutput) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s EnhancedMonitoringOutput) GoString() string {
- return s.String()
- }
- // Represents the input for GetRecords.
- type GetRecordsInput struct {
- _ struct{} `type:"structure"`
- // The maximum number of records to return. Specify a value of up to 10,000.
- // If you specify a value that is greater than 10,000, GetRecords throws InvalidArgumentException.
- Limit *int64 `min:"1" type:"integer"`
- // The position in the shard from which you want to start sequentially reading
- // data records. A shard iterator specifies this position using the sequence
- // number of a data record in the shard.
- //
- // ShardIterator is a required field
- ShardIterator *string `min:"1" type:"string" required:"true"`
- }
- // String returns the string representation
- func (s GetRecordsInput) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s GetRecordsInput) GoString() string {
- return s.String()
- }
- // Validate inspects the fields of the type to determine if they are valid.
- func (s *GetRecordsInput) Validate() error {
- invalidParams := request.ErrInvalidParams{Context: "GetRecordsInput"}
- if s.Limit != nil && *s.Limit < 1 {
- invalidParams.Add(request.NewErrParamMinValue("Limit", 1))
- }
- if s.ShardIterator == nil {
- invalidParams.Add(request.NewErrParamRequired("ShardIterator"))
- }
- if s.ShardIterator != nil && len(*s.ShardIterator) < 1 {
- invalidParams.Add(request.NewErrParamMinLen("ShardIterator", 1))
- }
- if invalidParams.Len() > 0 {
- return invalidParams
- }
- return nil
- }
- // Represents the output for GetRecords.
- type GetRecordsOutput struct {
- _ struct{} `type:"structure"`
- // The number of milliseconds the GetRecords response is from the tip of the
- // stream, indicating how far behind current time the consumer is. A value of
- // zero indicates record processing is caught up, and there are no new records
- // to process at this moment.
- MillisBehindLatest *int64 `type:"long"`
- // The next position in the shard from which to start sequentially reading data
- // records. If set to null, the shard has been closed and the requested iterator
- // will not return any more data.
- NextShardIterator *string `min:"1" type:"string"`
- // The data records retrieved from the shard.
- //
- // Records is a required field
- Records []*Record `type:"list" required:"true"`
- }
- // String returns the string representation
- func (s GetRecordsOutput) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s GetRecordsOutput) GoString() string {
- return s.String()
- }
- // Represents the input for GetShardIterator.
- type GetShardIteratorInput struct {
- _ struct{} `type:"structure"`
- // The shard ID of the Amazon Kinesis shard to get the iterator for.
- //
- // ShardId is a required field
- ShardId *string `min:"1" type:"string" required:"true"`
- // Determines how the shard iterator is used to start reading data records from
- // the shard.
- //
- // The following are the valid Amazon Kinesis shard iterator types:
- //
- // * AT_SEQUENCE_NUMBER - Start reading from the position denoted by a specific
- // sequence number, provided in the value StartingSequenceNumber.
- // * AFTER_SEQUENCE_NUMBER - Start reading right after the position denoted
- // by a specific sequence number, provided in the value StartingSequenceNumber.
- //
- // * AT_TIMESTAMP - Start reading from the position denoted by a specific
- // timestamp, provided in the value Timestamp.
- // * TRIM_HORIZON - Start reading at the last untrimmed record in the shard
- // in the system, which is the oldest data record in the shard.
- // * LATEST - Start reading just after the most recent record in the shard,
- // so that you always read the most recent data in the shard.
- //
- // ShardIteratorType is a required field
- ShardIteratorType *string `type:"string" required:"true" enum:"ShardIteratorType"`
- // The sequence number of the data record in the shard from which to start reading.
- // Used with shard iterator type AT_SEQUENCE_NUMBER and AFTER_SEQUENCE_NUMBER.
- StartingSequenceNumber *string `type:"string"`
- // The name of the Amazon Kinesis stream.
- //
- // StreamName is a required field
- StreamName *string `min:"1" type:"string" required:"true"`
- // The timestamp of the data record from which to start reading. Used with shard
- // iterator type AT_TIMESTAMP. A timestamp is the Unix epoch date with precision
- // in milliseconds. For example, 2016-04-04T19:58:46.480-00:00 or 1459799926.480.
- // If a record with this exact timestamp does not exist, the iterator returned
- // is for the next (later) record. If the timestamp is older than the current
- // trim horizon, the iterator returned is for the oldest untrimmed data record
- // (TRIM_HORIZON).
- Timestamp *time.Time `type:"timestamp" timestampFormat:"unix"`
- }
- // String returns the string representation
- func (s GetShardIteratorInput) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s GetShardIteratorInput) GoString() string {
- return s.String()
- }
- // Validate inspects the fields of the type to determine if they are valid.
- func (s *GetShardIteratorInput) Validate() error {
- invalidParams := request.ErrInvalidParams{Context: "GetShardIteratorInput"}
- if s.ShardId == nil {
- invalidParams.Add(request.NewErrParamRequired("ShardId"))
- }
- if s.ShardId != nil && len(*s.ShardId) < 1 {
- invalidParams.Add(request.NewErrParamMinLen("ShardId", 1))
- }
- if s.ShardIteratorType == nil {
- invalidParams.Add(request.NewErrParamRequired("ShardIteratorType"))
- }
- if s.StreamName == nil {
- invalidParams.Add(request.NewErrParamRequired("StreamName"))
- }
- if s.StreamName != nil && len(*s.StreamName) < 1 {
- invalidParams.Add(request.NewErrParamMinLen("StreamName", 1))
- }
- if invalidParams.Len() > 0 {
- return invalidParams
- }
- return nil
- }
- // Represents the output for GetShardIterator.
- type GetShardIteratorOutput struct {
- _ struct{} `type:"structure"`
- // The position in the shard from which to start reading data records sequentially.
- // A shard iterator specifies this position using the sequence number of a data
- // record in a shard.
- ShardIterator *string `min:"1" type:"string"`
- }
- // String returns the string representation
- func (s GetShardIteratorOutput) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s GetShardIteratorOutput) GoString() string {
- return s.String()
- }
- // The range of possible hash key values for the shard, which is a set of ordered
- // contiguous positive integers.
- type HashKeyRange struct {
- _ struct{} `type:"structure"`
- // The ending hash key of the hash key range.
- //
- // EndingHashKey is a required field
- EndingHashKey *string `type:"string" required:"true"`
- // The starting hash key of the hash key range.
- //
- // StartingHashKey is a required field
- StartingHashKey *string `type:"string" required:"true"`
- }
- // String returns the string representation
- func (s HashKeyRange) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s HashKeyRange) GoString() string {
- return s.String()
- }
- // Represents the input for IncreaseStreamRetentionPeriod.
- type IncreaseStreamRetentionPeriodInput struct {
- _ struct{} `type:"structure"`
- // The new retention period of the stream, in hours. Must be more than the current
- // retention period.
- //
- // RetentionPeriodHours is a required field
- RetentionPeriodHours *int64 `min:"24" type:"integer" required:"true"`
- // The name of the stream to modify.
- //
- // StreamName is a required field
- StreamName *string `min:"1" type:"string" required:"true"`
- }
- // String returns the string representation
- func (s IncreaseStreamRetentionPeriodInput) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s IncreaseStreamRetentionPeriodInput) GoString() string {
- return s.String()
- }
- // Validate inspects the fields of the type to determine if they are valid.
- func (s *IncreaseStreamRetentionPeriodInput) Validate() error {
- invalidParams := request.ErrInvalidParams{Context: "IncreaseStreamRetentionPeriodInput"}
- if s.RetentionPeriodHours == nil {
- invalidParams.Add(request.NewErrParamRequired("RetentionPeriodHours"))
- }
- if s.RetentionPeriodHours != nil && *s.RetentionPeriodHours < 24 {
- invalidParams.Add(request.NewErrParamMinValue("RetentionPeriodHours", 24))
- }
- if s.StreamName == nil {
- invalidParams.Add(request.NewErrParamRequired("StreamName"))
- }
- if s.StreamName != nil && len(*s.StreamName) < 1 {
- invalidParams.Add(request.NewErrParamMinLen("StreamName", 1))
- }
- if invalidParams.Len() > 0 {
- return invalidParams
- }
- return nil
- }
- type IncreaseStreamRetentionPeriodOutput struct {
- _ struct{} `type:"structure"`
- }
- // String returns the string representation
- func (s IncreaseStreamRetentionPeriodOutput) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s IncreaseStreamRetentionPeriodOutput) GoString() string {
- return s.String()
- }
- // Represents the input for ListStreams.
- type ListStreamsInput struct {
- _ struct{} `type:"structure"`
- // The name of the stream to start the list with.
- ExclusiveStartStreamName *string `min:"1" type:"string"`
- // The maximum number of streams to list.
- Limit *int64 `min:"1" type:"integer"`
- }
- // String returns the string representation
- func (s ListStreamsInput) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s ListStreamsInput) GoString() string {
- return s.String()
- }
- // Validate inspects the fields of the type to determine if they are valid.
- func (s *ListStreamsInput) Validate() error {
- invalidParams := request.ErrInvalidParams{Context: "ListStreamsInput"}
- if s.ExclusiveStartStreamName != nil && len(*s.ExclusiveStartStreamName) < 1 {
- invalidParams.Add(request.NewErrParamMinLen("ExclusiveStartStreamName", 1))
- }
- if s.Limit != nil && *s.Limit < 1 {
- invalidParams.Add(request.NewErrParamMinValue("Limit", 1))
- }
- if invalidParams.Len() > 0 {
- return invalidParams
- }
- return nil
- }
- // Represents the output for ListStreams.
- type ListStreamsOutput struct {
- _ struct{} `type:"structure"`
- // If set to true, there are more streams available to list.
- //
- // HasMoreStreams is a required field
- HasMoreStreams *bool `type:"boolean" required:"true"`
- // The names of the streams that are associated with the AWS account making
- // the ListStreams request.
- //
- // StreamNames is a required field
- StreamNames []*string `type:"list" required:"true"`
- }
- // String returns the string representation
- func (s ListStreamsOutput) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s ListStreamsOutput) GoString() string {
- return s.String()
- }
- // Represents the input for ListTagsForStream.
- type ListTagsForStreamInput struct {
- _ struct{} `type:"structure"`
- // The key to use as the starting point for the list of tags. If this parameter
- // is set, ListTagsForStream gets all tags that occur after ExclusiveStartTagKey.
- ExclusiveStartTagKey *string `min:"1" type:"string"`
- // The number of tags to return. If this number is less than the total number
- // of tags associated with the stream, HasMoreTags is set to true. To list additional
- // tags, set ExclusiveStartTagKey to the last key in the response.
- Limit *int64 `min:"1" type:"integer"`
- // The name of the stream.
- //
- // StreamName is a required field
- StreamName *string `min:"1" type:"string" required:"true"`
- }
- // String returns the string representation
- func (s ListTagsForStreamInput) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s ListTagsForStreamInput) GoString() string {
- return s.String()
- }
- // Validate inspects the fields of the type to determine if they are valid.
- func (s *ListTagsForStreamInput) Validate() error {
- invalidParams := request.ErrInvalidParams{Context: "ListTagsForStreamInput"}
- if s.ExclusiveStartTagKey != nil && len(*s.ExclusiveStartTagKey) < 1 {
- invalidParams.Add(request.NewErrParamMinLen("ExclusiveStartTagKey", 1))
- }
- if s.Limit != nil && *s.Limit < 1 {
- invalidParams.Add(request.NewErrParamMinValue("Limit", 1))
- }
- if s.StreamName == nil {
- invalidParams.Add(request.NewErrParamRequired("StreamName"))
- }
- if s.StreamName != nil && len(*s.StreamName) < 1 {
- invalidParams.Add(request.NewErrParamMinLen("StreamName", 1))
- }
- if invalidParams.Len() > 0 {
- return invalidParams
- }
- return nil
- }
- // Represents the output for ListTagsForStream.
- type ListTagsForStreamOutput struct {
- _ struct{} `type:"structure"`
- // If set to true, more tags are available. To request additional tags, set
- // ExclusiveStartTagKey to the key of the last tag returned.
- //
- // HasMoreTags is a required field
- HasMoreTags *bool `type:"boolean" required:"true"`
- // A list of tags associated with StreamName, starting with the first tag after
- // ExclusiveStartTagKey and up to the specified Limit.
- //
- // Tags is a required field
- Tags []*Tag `type:"list" required:"true"`
- }
- // String returns the string representation
- func (s ListTagsForStreamOutput) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s ListTagsForStreamOutput) GoString() string {
- return s.String()
- }
- // Represents the input for MergeShards.
- type MergeShardsInput struct {
- _ struct{} `type:"structure"`
- // The shard ID of the adjacent shard for the merge.
- //
- // AdjacentShardToMerge is a required field
- AdjacentShardToMerge *string `min:"1" type:"string" required:"true"`
- // The shard ID of the shard to combine with the adjacent shard for the merge.
- //
- // ShardToMerge is a required field
- ShardToMerge *string `min:"1" type:"string" required:"true"`
- // The name of the stream for the merge.
- //
- // StreamName is a required field
- StreamName *string `min:"1" type:"string" required:"true"`
- }
- // String returns the string representation
- func (s MergeShardsInput) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s MergeShardsInput) GoString() string {
- return s.String()
- }
- // Validate inspects the fields of the type to determine if they are valid.
- func (s *MergeShardsInput) Validate() error {
- invalidParams := request.ErrInvalidParams{Context: "MergeShardsInput"}
- if s.AdjacentShardToMerge == nil {
- invalidParams.Add(request.NewErrParamRequired("AdjacentShardToMerge"))
- }
- if s.AdjacentShardToMerge != nil && len(*s.AdjacentShardToMerge) < 1 {
- invalidParams.Add(request.NewErrParamMinLen("AdjacentShardToMerge", 1))
- }
- if s.ShardToMerge == nil {
- invalidParams.Add(request.NewErrParamRequired("ShardToMerge"))
- }
- if s.ShardToMerge != nil && len(*s.ShardToMerge) < 1 {
- invalidParams.Add(request.NewErrParamMinLen("ShardToMerge", 1))
- }
- if s.StreamName == nil {
- invalidParams.Add(request.NewErrParamRequired("StreamName"))
- }
- if s.StreamName != nil && len(*s.StreamName) < 1 {
- invalidParams.Add(request.NewErrParamMinLen("StreamName", 1))
- }
- if invalidParams.Len() > 0 {
- return invalidParams
- }
- return nil
- }
- type MergeShardsOutput struct {
- _ struct{} `type:"structure"`
- }
- // String returns the string representation
- func (s MergeShardsOutput) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s MergeShardsOutput) GoString() string {
- return s.String()
- }
- // Represents the input for PutRecord.
- type PutRecordInput struct {
- _ struct{} `type:"structure"`
- // The data blob to put into the record, which is base64-encoded when the blob
- // is serialized. When the data blob (the payload before base64-encoding) is
- // added to the partition key size, the total size must not exceed the maximum
- // record size (1 MB).
- //
- // Data is automatically base64 encoded/decoded by the SDK.
- //
- // Data is a required field
- Data []byte `type:"blob" required:"true"`
- // The hash value used to explicitly determine the shard the data record is
- // assigned to by overriding the partition key hash.
- ExplicitHashKey *string `type:"string"`
- // Determines which shard in the stream the data record is assigned to. Partition
- // keys are Unicode strings with a maximum length limit of 256 characters for
- // each key. Amazon Kinesis uses the partition key as input to a hash function
- // that maps the partition key and associated data to a specific shard. Specifically,
- // an MD5 hash function is used to map partition keys to 128-bit integer values
- // and to map associated data records to shards. As a result of this hashing
- // mechanism, all data records with the same partition key map to the same shard
- // within the stream.
- //
- // PartitionKey is a required field
- PartitionKey *string `min:"1" type:"string" required:"true"`
- // Guarantees strictly increasing sequence numbers, for puts from the same client
- // and to the same partition key. Usage: set the SequenceNumberForOrdering of
- // record n to the sequence number of record n-1 (as returned in the result
- // when putting record n-1). If this parameter is not set, records will be coarsely
- // ordered based on arrival time.
- SequenceNumberForOrdering *string `type:"string"`
- // The name of the stream to put the data record into.
- //
- // StreamName is a required field
- StreamName *string `min:"1" type:"string" required:"true"`
- }
- // String returns the string representation
- func (s PutRecordInput) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s PutRecordInput) GoString() string {
- return s.String()
- }
- // Validate inspects the fields of the type to determine if they are valid.
- func (s *PutRecordInput) Validate() error {
- invalidParams := request.ErrInvalidParams{Context: "PutRecordInput"}
- if s.Data == nil {
- invalidParams.Add(request.NewErrParamRequired("Data"))
- }
- if s.PartitionKey == nil {
- invalidParams.Add(request.NewErrParamRequired("PartitionKey"))
- }
- if s.PartitionKey != nil && len(*s.PartitionKey) < 1 {
- invalidParams.Add(request.NewErrParamMinLen("PartitionKey", 1))
- }
- if s.StreamName == nil {
- invalidParams.Add(request.NewErrParamRequired("StreamName"))
- }
- if s.StreamName != nil && len(*s.StreamName) < 1 {
- invalidParams.Add(request.NewErrParamMinLen("StreamName", 1))
- }
- if invalidParams.Len() > 0 {
- return invalidParams
- }
- return nil
- }
- // Represents the output for PutRecord.
- type PutRecordOutput struct {
- _ struct{} `type:"structure"`
- // The sequence number identifier that was assigned to the put data record.
- // The sequence number for the record is unique across all records in the stream.
- // A sequence number is the identifier associated with every record put into
- // the stream.
- //
- // SequenceNumber is a required field
- SequenceNumber *string `type:"string" required:"true"`
- // The shard ID of the shard where the data record was placed.
- //
- // ShardId is a required field
- ShardId *string `min:"1" type:"string" required:"true"`
- }
- // String returns the string representation
- func (s PutRecordOutput) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s PutRecordOutput) GoString() string {
- return s.String()
- }
- // A PutRecords request.
- type PutRecordsInput struct {
- _ struct{} `type:"structure"`
- // The records associated with the request.
- //
- // Records is a required field
- Records []*PutRecordsRequestEntry `min:"1" type:"list" required:"true"`
- // The stream name associated with the request.
- //
- // StreamName is a required field
- StreamName *string `min:"1" type:"string" required:"true"`
- }
- // String returns the string representation
- func (s PutRecordsInput) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s PutRecordsInput) GoString() string {
- return s.String()
- }
- // Validate inspects the fields of the type to determine if they are valid.
- func (s *PutRecordsInput) Validate() error {
- invalidParams := request.ErrInvalidParams{Context: "PutRecordsInput"}
- if s.Records == nil {
- invalidParams.Add(request.NewErrParamRequired("Records"))
- }
- if s.Records != nil && len(s.Records) < 1 {
- invalidParams.Add(request.NewErrParamMinLen("Records", 1))
- }
- if s.StreamName == nil {
- invalidParams.Add(request.NewErrParamRequired("StreamName"))
- }
- if s.StreamName != nil && len(*s.StreamName) < 1 {
- invalidParams.Add(request.NewErrParamMinLen("StreamName", 1))
- }
- if s.Records != nil {
- for i, v := range s.Records {
- if v == nil {
- continue
- }
- if err := v.Validate(); err != nil {
- invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Records", i), err.(request.ErrInvalidParams))
- }
- }
- }
- if invalidParams.Len() > 0 {
- return invalidParams
- }
- return nil
- }
- // PutRecords results.
- type PutRecordsOutput struct {
- _ struct{} `type:"structure"`
- // The number of unsuccessfully processed records in a PutRecords request.
- FailedRecordCount *int64 `min:"1" type:"integer"`
- // An array of successfully and unsuccessfully processed record results, correlated
- // with the request by natural ordering. A record that is successfully added
- // to a stream includes SequenceNumber and ShardId in the result. A record that
- // fails to be added to a stream includes ErrorCode and ErrorMessage in the
- // result.
- //
- // Records is a required field
- Records []*PutRecordsResultEntry `min:"1" type:"list" required:"true"`
- }
- // String returns the string representation
- func (s PutRecordsOutput) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s PutRecordsOutput) GoString() string {
- return s.String()
- }
- // Represents the output for PutRecords.
- type PutRecordsRequestEntry struct {
- _ struct{} `type:"structure"`
- // The data blob to put into the record, which is base64-encoded when the blob
- // is serialized. When the data blob (the payload before base64-encoding) is
- // added to the partition key size, the total size must not exceed the maximum
- // record size (1 MB).
- //
- // Data is automatically base64 encoded/decoded by the SDK.
- //
- // Data is a required field
- Data []byte `type:"blob" required:"true"`
- // The hash value used to determine explicitly the shard that the data record
- // is assigned to by overriding the partition key hash.
- ExplicitHashKey *string `type:"string"`
- // Determines which shard in the stream the data record is assigned to. Partition
- // keys are Unicode strings with a maximum length limit of 256 characters for
- // each key. Amazon Kinesis uses the partition key as input to a hash function
- // that maps the partition key and associated data to a specific shard. Specifically,
- // an MD5 hash function is used to map partition keys to 128-bit integer values
- // and to map associated data records to shards. As a result of this hashing
- // mechanism, all data records with the same partition key map to the same shard
- // within the stream.
- //
- // PartitionKey is a required field
- PartitionKey *string `min:"1" type:"string" required:"true"`
- }
- // String returns the string representation
- func (s PutRecordsRequestEntry) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s PutRecordsRequestEntry) GoString() string {
- return s.String()
- }
- // Validate inspects the fields of the type to determine if they are valid.
- func (s *PutRecordsRequestEntry) Validate() error {
- invalidParams := request.ErrInvalidParams{Context: "PutRecordsRequestEntry"}
- if s.Data == nil {
- invalidParams.Add(request.NewErrParamRequired("Data"))
- }
- if s.PartitionKey == nil {
- invalidParams.Add(request.NewErrParamRequired("PartitionKey"))
- }
- if s.PartitionKey != nil && len(*s.PartitionKey) < 1 {
- invalidParams.Add(request.NewErrParamMinLen("PartitionKey", 1))
- }
- if invalidParams.Len() > 0 {
- return invalidParams
- }
- return nil
- }
- // Represents the result of an individual record from a PutRecords request.
- // A record that is successfully added to a stream includes SequenceNumber and
- // ShardId in the result. A record that fails to be added to the stream includes
- // ErrorCode and ErrorMessage in the result.
- type PutRecordsResultEntry struct {
- _ struct{} `type:"structure"`
- // The error code for an individual record result. ErrorCodes can be either
- // ProvisionedThroughputExceededException or InternalFailure.
- ErrorCode *string `type:"string"`
- // The error message for an individual record result. An ErrorCode value of
- // ProvisionedThroughputExceededException has an error message that includes
- // the account ID, stream name, and shard ID. An ErrorCode value of InternalFailure
- // has the error message "Internal Service Failure".
- ErrorMessage *string `type:"string"`
- // The sequence number for an individual record result.
- SequenceNumber *string `type:"string"`
- // The shard ID for an individual record result.
- ShardId *string `min:"1" type:"string"`
- }
- // String returns the string representation
- func (s PutRecordsResultEntry) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s PutRecordsResultEntry) GoString() string {
- return s.String()
- }
- // The unit of data of the Amazon Kinesis stream, which is composed of a sequence
- // number, a partition key, and a data blob.
- type Record struct {
- _ struct{} `type:"structure"`
- // The approximate time that the record was inserted into the stream.
- ApproximateArrivalTimestamp *time.Time `type:"timestamp" timestampFormat:"unix"`
- // The data blob. The data in the blob is both opaque and immutable to the Amazon
- // Kinesis service, which does not inspect, interpret, or change the data in
- // the blob in any way. When the data blob (the payload before base64-encoding)
- // is added to the partition key size, the total size must not exceed the maximum
- // record size (1 MB).
- //
- // Data is automatically base64 encoded/decoded by the SDK.
- //
- // Data is a required field
- Data []byte `type:"blob" required:"true"`
- // Identifies which shard in the stream the data record is assigned to.
- //
- // PartitionKey is a required field
- PartitionKey *string `min:"1" type:"string" required:"true"`
- // The unique identifier of the record in the stream.
- //
- // SequenceNumber is a required field
- SequenceNumber *string `type:"string" required:"true"`
- }
- // String returns the string representation
- func (s Record) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s Record) GoString() string {
- return s.String()
- }
- // Represents the input for RemoveTagsFromStream.
- type RemoveTagsFromStreamInput struct {
- _ struct{} `type:"structure"`
- // The name of the stream.
- //
- // StreamName is a required field
- StreamName *string `min:"1" type:"string" required:"true"`
- // A list of tag keys. Each corresponding tag is removed from the stream.
- //
- // TagKeys is a required field
- TagKeys []*string `min:"1" type:"list" required:"true"`
- }
- // String returns the string representation
- func (s RemoveTagsFromStreamInput) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s RemoveTagsFromStreamInput) GoString() string {
- return s.String()
- }
- // Validate inspects the fields of the type to determine if they are valid.
- func (s *RemoveTagsFromStreamInput) Validate() error {
- invalidParams := request.ErrInvalidParams{Context: "RemoveTagsFromStreamInput"}
- if s.StreamName == nil {
- invalidParams.Add(request.NewErrParamRequired("StreamName"))
- }
- if s.StreamName != nil && len(*s.StreamName) < 1 {
- invalidParams.Add(request.NewErrParamMinLen("StreamName", 1))
- }
- if s.TagKeys == nil {
- invalidParams.Add(request.NewErrParamRequired("TagKeys"))
- }
- if s.TagKeys != nil && len(s.TagKeys) < 1 {
- invalidParams.Add(request.NewErrParamMinLen("TagKeys", 1))
- }
- if invalidParams.Len() > 0 {
- return invalidParams
- }
- return nil
- }
- type RemoveTagsFromStreamOutput struct {
- _ struct{} `type:"structure"`
- }
- // String returns the string representation
- func (s RemoveTagsFromStreamOutput) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s RemoveTagsFromStreamOutput) GoString() string {
- return s.String()
- }
- // The range of possible sequence numbers for the shard.
- type SequenceNumberRange struct {
- _ struct{} `type:"structure"`
- // The ending sequence number for the range. Shards that are in the OPEN state
- // have an ending sequence number of null.
- EndingSequenceNumber *string `type:"string"`
- // The starting sequence number for the range.
- //
- // StartingSequenceNumber is a required field
- StartingSequenceNumber *string `type:"string" required:"true"`
- }
- // String returns the string representation
- func (s SequenceNumberRange) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s SequenceNumberRange) GoString() string {
- return s.String()
- }
- // A uniquely identified group of data records in an Amazon Kinesis stream.
- type Shard struct {
- _ struct{} `type:"structure"`
- // The shard ID of the shard adjacent to the shard's parent.
- AdjacentParentShardId *string `min:"1" type:"string"`
- // The range of possible hash key values for the shard, which is a set of ordered
- // contiguous positive integers.
- //
- // HashKeyRange is a required field
- HashKeyRange *HashKeyRange `type:"structure" required:"true"`
- // The shard ID of the shard's parent.
- ParentShardId *string `min:"1" type:"string"`
- // The range of possible sequence numbers for the shard.
- //
- // SequenceNumberRange is a required field
- SequenceNumberRange *SequenceNumberRange `type:"structure" required:"true"`
- // The unique identifier of the shard within the stream.
- //
- // ShardId is a required field
- ShardId *string `min:"1" type:"string" required:"true"`
- }
- // String returns the string representation
- func (s Shard) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s Shard) GoString() string {
- return s.String()
- }
- // Represents the input for SplitShard.
- type SplitShardInput struct {
- _ struct{} `type:"structure"`
- // A hash key value for the starting hash key of one of the child shards created
- // by the split. The hash key range for a given shard constitutes a set of ordered
- // contiguous positive integers. The value for NewStartingHashKey must be in
- // the range of hash keys being mapped into the shard. The NewStartingHashKey
- // hash key value and all higher hash key values in hash key range are distributed
- // to one of the child shards. All the lower hash key values in the range are
- // distributed to the other child shard.
- //
- // NewStartingHashKey is a required field
- NewStartingHashKey *string `type:"string" required:"true"`
- // The shard ID of the shard to split.
- //
- // ShardToSplit is a required field
- ShardToSplit *string `min:"1" type:"string" required:"true"`
- // The name of the stream for the shard split.
- //
- // StreamName is a required field
- StreamName *string `min:"1" type:"string" required:"true"`
- }
- // String returns the string representation
- func (s SplitShardInput) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s SplitShardInput) GoString() string {
- return s.String()
- }
- // Validate inspects the fields of the type to determine if they are valid.
- func (s *SplitShardInput) Validate() error {
- invalidParams := request.ErrInvalidParams{Context: "SplitShardInput"}
- if s.NewStartingHashKey == nil {
- invalidParams.Add(request.NewErrParamRequired("NewStartingHashKey"))
- }
- if s.ShardToSplit == nil {
- invalidParams.Add(request.NewErrParamRequired("ShardToSplit"))
- }
- if s.ShardToSplit != nil && len(*s.ShardToSplit) < 1 {
- invalidParams.Add(request.NewErrParamMinLen("ShardToSplit", 1))
- }
- if s.StreamName == nil {
- invalidParams.Add(request.NewErrParamRequired("StreamName"))
- }
- if s.StreamName != nil && len(*s.StreamName) < 1 {
- invalidParams.Add(request.NewErrParamMinLen("StreamName", 1))
- }
- if invalidParams.Len() > 0 {
- return invalidParams
- }
- return nil
- }
- type SplitShardOutput struct {
- _ struct{} `type:"structure"`
- }
- // String returns the string representation
- func (s SplitShardOutput) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s SplitShardOutput) GoString() string {
- return s.String()
- }
- // Represents the output for DescribeStream.
- type StreamDescription struct {
- _ struct{} `type:"structure"`
- // Represents the current enhanced monitoring settings of the stream.
- //
- // EnhancedMonitoring is a required field
- EnhancedMonitoring []*EnhancedMetrics `type:"list" required:"true"`
- // If set to true, more shards in the stream are available to describe.
- //
- // HasMoreShards is a required field
- HasMoreShards *bool `type:"boolean" required:"true"`
- // The current retention period, in hours.
- //
- // RetentionPeriodHours is a required field
- RetentionPeriodHours *int64 `min:"24" type:"integer" required:"true"`
- // The shards that comprise the stream.
- //
- // Shards is a required field
- Shards []*Shard `type:"list" required:"true"`
- // The Amazon Resource Name (ARN) for the stream being described.
- //
- // StreamARN is a required field
- StreamARN *string `type:"string" required:"true"`
- // The name of the stream being described.
- //
- // StreamName is a required field
- StreamName *string `min:"1" type:"string" required:"true"`
- // The current status of the stream being described. The stream status is one
- // of the following states:
- //
- // * CREATING - The stream is being created. Amazon Kinesis immediately returns
- // and sets StreamStatus to CREATING.
- // * DELETING - The stream is being deleted. The specified stream is in the
- // DELETING state until Amazon Kinesis completes the deletion.
- // * ACTIVE - The stream exists and is ready for read and write operations
- // or deletion. You should perform read and write operations only on an ACTIVE
- // stream.
- // * UPDATING - Shards in the stream are being merged or split. Read and
- // write operations continue to work while the stream is in the UPDATING
- // state.
- //
- // StreamStatus is a required field
- StreamStatus *string `type:"string" required:"true" enum:"StreamStatus"`
- }
- // String returns the string representation
- func (s StreamDescription) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s StreamDescription) GoString() string {
- return s.String()
- }
- // Metadata assigned to the stream, consisting of a key-value pair.
- type Tag struct {
- _ struct{} `type:"structure"`
- // A unique identifier for the tag. Maximum length: 128 characters. Valid characters:
- // Unicode letters, digits, white space, _ . / = + - % @
- //
- // Key is a required field
- Key *string `min:"1" type:"string" required:"true"`
- // An optional string, typically used to describe or define the tag. Maximum
- // length: 256 characters. Valid characters: Unicode letters, digits, white
- // space, _ . / = + - % @
- Value *string `type:"string"`
- }
- // String returns the string representation
- func (s Tag) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s Tag) GoString() string {
- return s.String()
- }
- const (
- // MetricsNameIncomingBytes is a MetricsName enum value
- MetricsNameIncomingBytes = "IncomingBytes"
- // MetricsNameIncomingRecords is a MetricsName enum value
- MetricsNameIncomingRecords = "IncomingRecords"
- // MetricsNameOutgoingBytes is a MetricsName enum value
- MetricsNameOutgoingBytes = "OutgoingBytes"
- // MetricsNameOutgoingRecords is a MetricsName enum value
- MetricsNameOutgoingRecords = "OutgoingRecords"
- // MetricsNameWriteProvisionedThroughputExceeded is a MetricsName enum value
- MetricsNameWriteProvisionedThroughputExceeded = "WriteProvisionedThroughputExceeded"
- // MetricsNameReadProvisionedThroughputExceeded is a MetricsName enum value
- MetricsNameReadProvisionedThroughputExceeded = "ReadProvisionedThroughputExceeded"
- // MetricsNameIteratorAgeMilliseconds is a MetricsName enum value
- MetricsNameIteratorAgeMilliseconds = "IteratorAgeMilliseconds"
- // MetricsNameAll is a MetricsName enum value
- MetricsNameAll = "ALL"
- )
- const (
- // ShardIteratorTypeAtSequenceNumber is a ShardIteratorType enum value
- ShardIteratorTypeAtSequenceNumber = "AT_SEQUENCE_NUMBER"
- // ShardIteratorTypeAfterSequenceNumber is a ShardIteratorType enum value
- ShardIteratorTypeAfterSequenceNumber = "AFTER_SEQUENCE_NUMBER"
- // ShardIteratorTypeTrimHorizon is a ShardIteratorType enum value
- ShardIteratorTypeTrimHorizon = "TRIM_HORIZON"
- // ShardIteratorTypeLatest is a ShardIteratorType enum value
- ShardIteratorTypeLatest = "LATEST"
- // ShardIteratorTypeAtTimestamp is a ShardIteratorType enum value
- ShardIteratorTypeAtTimestamp = "AT_TIMESTAMP"
- )
- const (
- // StreamStatusCreating is a StreamStatus enum value
- StreamStatusCreating = "CREATING"
- // StreamStatusDeleting is a StreamStatus enum value
- StreamStatusDeleting = "DELETING"
- // StreamStatusActive is a StreamStatus enum value
- StreamStatusActive = "ACTIVE"
- // StreamStatusUpdating is a StreamStatus enum value
- StreamStatusUpdating = "UPDATING"
- )
|