| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888 |
- // Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.
- package transfer
- import (
- "fmt"
- "time"
- "github.com/aws/aws-sdk-go/aws"
- "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 opCreateServer = "CreateServer"
- // CreateServerRequest generates a "aws/request.Request" representing the
- // client's request for the CreateServer operation. The "output" return
- // value will be populated with the request's response once the request completes
- // successfully.
- //
- // Use "Send" method on the returned Request to send the API call to the service.
- // the "output" return value is not valid until after Send returns without error.
- //
- // See CreateServer for more information on using the CreateServer
- // API call, and error handling.
- //
- // This method is useful when you want to inject custom logic or configuration
- // into the SDK's request lifecycle. Such as custom headers, or retry logic.
- //
- //
- // // Example sending a request using the CreateServerRequest method.
- // req, resp := client.CreateServerRequest(params)
- //
- // err := req.Send()
- // if err == nil { // resp is now filled
- // fmt.Println(resp)
- // }
- //
- // See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/CreateServer
- func (c *Transfer) CreateServerRequest(input *CreateServerInput) (req *request.Request, output *CreateServerOutput) {
- op := &request.Operation{
- Name: opCreateServer,
- HTTPMethod: "POST",
- HTTPPath: "/",
- }
- if input == nil {
- input = &CreateServerInput{}
- }
- output = &CreateServerOutput{}
- req = c.newRequest(op, input, output)
- return
- }
- // CreateServer API operation for AWS Transfer for SFTP.
- //
- // Instantiates an autoscaling virtual server based on Secure File Transfer
- // Protocol (SFTP) in AWS. The call returns the ServerId property assigned by
- // the service to the newly created server. Reference this ServerId property
- // when you make updates to your server, or work with users.
- //
- // The response returns the ServerId value for the newly created server.
- //
- // 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 AWS Transfer for SFTP's
- // API operation CreateServer for usage and error information.
- //
- // Returned Error Codes:
- // * ErrCodeServiceUnavailableException "ServiceUnavailableException"
- // The request has failed because the AWS Transfer for SFTP service is not available.
- //
- // * ErrCodeInternalServiceError "InternalServiceError"
- // This exception is thrown when an error occurs in the AWS Transfer for SFTP
- // service.
- //
- // * ErrCodeInvalidRequestException "InvalidRequestException"
- // This exception is thrown when the client submits a malformed request.
- //
- // See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/CreateServer
- func (c *Transfer) CreateServer(input *CreateServerInput) (*CreateServerOutput, error) {
- req, out := c.CreateServerRequest(input)
- return out, req.Send()
- }
- // CreateServerWithContext is the same as CreateServer with the addition of
- // the ability to pass a context and additional request options.
- //
- // See CreateServer for details on how to use this API operation.
- //
- // The context must be non-nil and will be used for request cancellation. If
- // the context is nil a panic will occur. In the future the SDK may create
- // sub-contexts for http.Requests. See https://golang.org/pkg/context/
- // for more information on using Contexts.
- func (c *Transfer) CreateServerWithContext(ctx aws.Context, input *CreateServerInput, opts ...request.Option) (*CreateServerOutput, error) {
- req, out := c.CreateServerRequest(input)
- req.SetContext(ctx)
- req.ApplyOptions(opts...)
- return out, req.Send()
- }
- const opCreateUser = "CreateUser"
- // CreateUserRequest generates a "aws/request.Request" representing the
- // client's request for the CreateUser operation. The "output" return
- // value will be populated with the request's response once the request completes
- // successfully.
- //
- // Use "Send" method on the returned Request to send the API call to the service.
- // the "output" return value is not valid until after Send returns without error.
- //
- // See CreateUser for more information on using the CreateUser
- // API call, and error handling.
- //
- // This method is useful when you want to inject custom logic or configuration
- // into the SDK's request lifecycle. Such as custom headers, or retry logic.
- //
- //
- // // Example sending a request using the CreateUserRequest method.
- // req, resp := client.CreateUserRequest(params)
- //
- // err := req.Send()
- // if err == nil { // resp is now filled
- // fmt.Println(resp)
- // }
- //
- // See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/CreateUser
- func (c *Transfer) CreateUserRequest(input *CreateUserInput) (req *request.Request, output *CreateUserOutput) {
- op := &request.Operation{
- Name: opCreateUser,
- HTTPMethod: "POST",
- HTTPPath: "/",
- }
- if input == nil {
- input = &CreateUserInput{}
- }
- output = &CreateUserOutput{}
- req = c.newRequest(op, input, output)
- return
- }
- // CreateUser API operation for AWS Transfer for SFTP.
- //
- // Adds a user and associate them with an existing Secure File Transfer Protocol
- // (SFTP) server. Using parameters for CreateUser, you can specify the user
- // name, set the home directory, store the user's public key, and assign the
- // user's AWS Identity and Access Management (IAM) role. You can also optionally
- // add a scope-down policy, and assign metadata with tags that can be used to
- // group and search for users.
- //
- // The response returns the UserName and ServerId values of the new user for
- // that server.
- //
- // 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 AWS Transfer for SFTP's
- // API operation CreateUser for usage and error information.
- //
- // Returned Error Codes:
- // * ErrCodeServiceUnavailableException "ServiceUnavailableException"
- // The request has failed because the AWS Transfer for SFTP service is not available.
- //
- // * ErrCodeInternalServiceError "InternalServiceError"
- // This exception is thrown when an error occurs in the AWS Transfer for SFTP
- // service.
- //
- // * ErrCodeInvalidRequestException "InvalidRequestException"
- // This exception is thrown when the client submits a malformed request.
- //
- // * ErrCodeResourceExistsException "ResourceExistsException"
- // The requested resource does not exist.
- //
- // * ErrCodeResourceNotFoundException "ResourceNotFoundException"
- // This exception is thrown when a resource is not found by the AWS Transfer
- // for SFTP service.
- //
- // See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/CreateUser
- func (c *Transfer) CreateUser(input *CreateUserInput) (*CreateUserOutput, error) {
- req, out := c.CreateUserRequest(input)
- return out, req.Send()
- }
- // CreateUserWithContext is the same as CreateUser with the addition of
- // the ability to pass a context and additional request options.
- //
- // See CreateUser for details on how to use this API operation.
- //
- // The context must be non-nil and will be used for request cancellation. If
- // the context is nil a panic will occur. In the future the SDK may create
- // sub-contexts for http.Requests. See https://golang.org/pkg/context/
- // for more information on using Contexts.
- func (c *Transfer) CreateUserWithContext(ctx aws.Context, input *CreateUserInput, opts ...request.Option) (*CreateUserOutput, error) {
- req, out := c.CreateUserRequest(input)
- req.SetContext(ctx)
- req.ApplyOptions(opts...)
- return out, req.Send()
- }
- const opDeleteServer = "DeleteServer"
- // DeleteServerRequest generates a "aws/request.Request" representing the
- // client's request for the DeleteServer operation. The "output" return
- // value will be populated with the request's response once the request completes
- // successfully.
- //
- // Use "Send" method on the returned Request to send the API call to the service.
- // the "output" return value is not valid until after Send returns without error.
- //
- // See DeleteServer for more information on using the DeleteServer
- // API call, and error handling.
- //
- // This method is useful when you want to inject custom logic or configuration
- // into the SDK's request lifecycle. Such as custom headers, or retry logic.
- //
- //
- // // Example sending a request using the DeleteServerRequest method.
- // req, resp := client.DeleteServerRequest(params)
- //
- // err := req.Send()
- // if err == nil { // resp is now filled
- // fmt.Println(resp)
- // }
- //
- // See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DeleteServer
- func (c *Transfer) DeleteServerRequest(input *DeleteServerInput) (req *request.Request, output *DeleteServerOutput) {
- op := &request.Operation{
- Name: opDeleteServer,
- HTTPMethod: "POST",
- HTTPPath: "/",
- }
- if input == nil {
- input = &DeleteServerInput{}
- }
- output = &DeleteServerOutput{}
- req = c.newRequest(op, input, output)
- req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler)
- return
- }
- // DeleteServer API operation for AWS Transfer for SFTP.
- //
- // Deletes the Secure File Transfer Protocol (SFTP) server that you specify.
- // If you used SERVICE_MANAGED as your IdentityProviderType, you need to delete
- // all users associated with this server before deleting the server itself
- //
- // No response returns from this call.
- //
- // 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 AWS Transfer for SFTP's
- // API operation DeleteServer for usage and error information.
- //
- // Returned Error Codes:
- // * ErrCodeServiceUnavailableException "ServiceUnavailableException"
- // The request has failed because the AWS Transfer for SFTP service is not available.
- //
- // * ErrCodeInternalServiceError "InternalServiceError"
- // This exception is thrown when an error occurs in the AWS Transfer for SFTP
- // service.
- //
- // * ErrCodeInvalidRequestException "InvalidRequestException"
- // This exception is thrown when the client submits a malformed request.
- //
- // * ErrCodeResourceNotFoundException "ResourceNotFoundException"
- // This exception is thrown when a resource is not found by the AWS Transfer
- // for SFTP service.
- //
- // See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DeleteServer
- func (c *Transfer) DeleteServer(input *DeleteServerInput) (*DeleteServerOutput, error) {
- req, out := c.DeleteServerRequest(input)
- return out, req.Send()
- }
- // DeleteServerWithContext is the same as DeleteServer with the addition of
- // the ability to pass a context and additional request options.
- //
- // See DeleteServer for details on how to use this API operation.
- //
- // The context must be non-nil and will be used for request cancellation. If
- // the context is nil a panic will occur. In the future the SDK may create
- // sub-contexts for http.Requests. See https://golang.org/pkg/context/
- // for more information on using Contexts.
- func (c *Transfer) DeleteServerWithContext(ctx aws.Context, input *DeleteServerInput, opts ...request.Option) (*DeleteServerOutput, error) {
- req, out := c.DeleteServerRequest(input)
- req.SetContext(ctx)
- req.ApplyOptions(opts...)
- return out, req.Send()
- }
- const opDeleteSshPublicKey = "DeleteSshPublicKey"
- // DeleteSshPublicKeyRequest generates a "aws/request.Request" representing the
- // client's request for the DeleteSshPublicKey operation. The "output" return
- // value will be populated with the request's response once the request completes
- // successfully.
- //
- // Use "Send" method on the returned Request to send the API call to the service.
- // the "output" return value is not valid until after Send returns without error.
- //
- // See DeleteSshPublicKey for more information on using the DeleteSshPublicKey
- // API call, and error handling.
- //
- // This method is useful when you want to inject custom logic or configuration
- // into the SDK's request lifecycle. Such as custom headers, or retry logic.
- //
- //
- // // Example sending a request using the DeleteSshPublicKeyRequest method.
- // req, resp := client.DeleteSshPublicKeyRequest(params)
- //
- // err := req.Send()
- // if err == nil { // resp is now filled
- // fmt.Println(resp)
- // }
- //
- // See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DeleteSshPublicKey
- func (c *Transfer) DeleteSshPublicKeyRequest(input *DeleteSshPublicKeyInput) (req *request.Request, output *DeleteSshPublicKeyOutput) {
- op := &request.Operation{
- Name: opDeleteSshPublicKey,
- HTTPMethod: "POST",
- HTTPPath: "/",
- }
- if input == nil {
- input = &DeleteSshPublicKeyInput{}
- }
- output = &DeleteSshPublicKeyOutput{}
- req = c.newRequest(op, input, output)
- req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler)
- return
- }
- // DeleteSshPublicKey API operation for AWS Transfer for SFTP.
- //
- // Deletes a user's Secure Shell (SSH) public key.
- //
- // No response is returned from this call.
- //
- // 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 AWS Transfer for SFTP's
- // API operation DeleteSshPublicKey for usage and error information.
- //
- // Returned Error Codes:
- // * ErrCodeServiceUnavailableException "ServiceUnavailableException"
- // The request has failed because the AWS Transfer for SFTP service is not available.
- //
- // * ErrCodeInternalServiceError "InternalServiceError"
- // This exception is thrown when an error occurs in the AWS Transfer for SFTP
- // service.
- //
- // * ErrCodeInvalidRequestException "InvalidRequestException"
- // This exception is thrown when the client submits a malformed request.
- //
- // * ErrCodeResourceNotFoundException "ResourceNotFoundException"
- // This exception is thrown when a resource is not found by the AWS Transfer
- // for SFTP service.
- //
- // See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DeleteSshPublicKey
- func (c *Transfer) DeleteSshPublicKey(input *DeleteSshPublicKeyInput) (*DeleteSshPublicKeyOutput, error) {
- req, out := c.DeleteSshPublicKeyRequest(input)
- return out, req.Send()
- }
- // DeleteSshPublicKeyWithContext is the same as DeleteSshPublicKey with the addition of
- // the ability to pass a context and additional request options.
- //
- // See DeleteSshPublicKey for details on how to use this API operation.
- //
- // The context must be non-nil and will be used for request cancellation. If
- // the context is nil a panic will occur. In the future the SDK may create
- // sub-contexts for http.Requests. See https://golang.org/pkg/context/
- // for more information on using Contexts.
- func (c *Transfer) DeleteSshPublicKeyWithContext(ctx aws.Context, input *DeleteSshPublicKeyInput, opts ...request.Option) (*DeleteSshPublicKeyOutput, error) {
- req, out := c.DeleteSshPublicKeyRequest(input)
- req.SetContext(ctx)
- req.ApplyOptions(opts...)
- return out, req.Send()
- }
- const opDeleteUser = "DeleteUser"
- // DeleteUserRequest generates a "aws/request.Request" representing the
- // client's request for the DeleteUser operation. The "output" return
- // value will be populated with the request's response once the request completes
- // successfully.
- //
- // Use "Send" method on the returned Request to send the API call to the service.
- // the "output" return value is not valid until after Send returns without error.
- //
- // See DeleteUser for more information on using the DeleteUser
- // API call, and error handling.
- //
- // This method is useful when you want to inject custom logic or configuration
- // into the SDK's request lifecycle. Such as custom headers, or retry logic.
- //
- //
- // // Example sending a request using the DeleteUserRequest method.
- // req, resp := client.DeleteUserRequest(params)
- //
- // err := req.Send()
- // if err == nil { // resp is now filled
- // fmt.Println(resp)
- // }
- //
- // See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DeleteUser
- func (c *Transfer) DeleteUserRequest(input *DeleteUserInput) (req *request.Request, output *DeleteUserOutput) {
- op := &request.Operation{
- Name: opDeleteUser,
- HTTPMethod: "POST",
- HTTPPath: "/",
- }
- if input == nil {
- input = &DeleteUserInput{}
- }
- output = &DeleteUserOutput{}
- req = c.newRequest(op, input, output)
- req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler)
- return
- }
- // DeleteUser API operation for AWS Transfer for SFTP.
- //
- // Deletes the user belonging to the server you specify.
- //
- // No response returns from this call.
- //
- // When you delete a user from a server, the user's information is lost.
- //
- // 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 AWS Transfer for SFTP's
- // API operation DeleteUser for usage and error information.
- //
- // Returned Error Codes:
- // * ErrCodeServiceUnavailableException "ServiceUnavailableException"
- // The request has failed because the AWS Transfer for SFTP service is not available.
- //
- // * ErrCodeInternalServiceError "InternalServiceError"
- // This exception is thrown when an error occurs in the AWS Transfer for SFTP
- // service.
- //
- // * ErrCodeInvalidRequestException "InvalidRequestException"
- // This exception is thrown when the client submits a malformed request.
- //
- // * ErrCodeResourceNotFoundException "ResourceNotFoundException"
- // This exception is thrown when a resource is not found by the AWS Transfer
- // for SFTP service.
- //
- // See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DeleteUser
- func (c *Transfer) DeleteUser(input *DeleteUserInput) (*DeleteUserOutput, error) {
- req, out := c.DeleteUserRequest(input)
- return out, req.Send()
- }
- // DeleteUserWithContext is the same as DeleteUser with the addition of
- // the ability to pass a context and additional request options.
- //
- // See DeleteUser for details on how to use this API operation.
- //
- // The context must be non-nil and will be used for request cancellation. If
- // the context is nil a panic will occur. In the future the SDK may create
- // sub-contexts for http.Requests. See https://golang.org/pkg/context/
- // for more information on using Contexts.
- func (c *Transfer) DeleteUserWithContext(ctx aws.Context, input *DeleteUserInput, opts ...request.Option) (*DeleteUserOutput, error) {
- req, out := c.DeleteUserRequest(input)
- req.SetContext(ctx)
- req.ApplyOptions(opts...)
- return out, req.Send()
- }
- const opDescribeServer = "DescribeServer"
- // DescribeServerRequest generates a "aws/request.Request" representing the
- // client's request for the DescribeServer operation. The "output" return
- // value will be populated with the request's response once the request completes
- // successfully.
- //
- // Use "Send" method on the returned Request to send the API call to the service.
- // the "output" return value is not valid until after Send returns without error.
- //
- // See DescribeServer for more information on using the DescribeServer
- // API call, and error handling.
- //
- // This method is useful when you want to inject custom logic or configuration
- // into the SDK's request lifecycle. Such as custom headers, or retry logic.
- //
- //
- // // Example sending a request using the DescribeServerRequest method.
- // req, resp := client.DescribeServerRequest(params)
- //
- // err := req.Send()
- // if err == nil { // resp is now filled
- // fmt.Println(resp)
- // }
- //
- // See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DescribeServer
- func (c *Transfer) DescribeServerRequest(input *DescribeServerInput) (req *request.Request, output *DescribeServerOutput) {
- op := &request.Operation{
- Name: opDescribeServer,
- HTTPMethod: "POST",
- HTTPPath: "/",
- }
- if input == nil {
- input = &DescribeServerInput{}
- }
- output = &DescribeServerOutput{}
- req = c.newRequest(op, input, output)
- return
- }
- // DescribeServer API operation for AWS Transfer for SFTP.
- //
- // Describes the server that you specify by passing the ServerId parameter.
- //
- // The response contains a description of the server's properties.
- //
- // 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 AWS Transfer for SFTP's
- // API operation DescribeServer for usage and error information.
- //
- // Returned Error Codes:
- // * ErrCodeServiceUnavailableException "ServiceUnavailableException"
- // The request has failed because the AWS Transfer for SFTP service is not available.
- //
- // * ErrCodeInternalServiceError "InternalServiceError"
- // This exception is thrown when an error occurs in the AWS Transfer for SFTP
- // service.
- //
- // * ErrCodeInvalidRequestException "InvalidRequestException"
- // This exception is thrown when the client submits a malformed request.
- //
- // * ErrCodeResourceNotFoundException "ResourceNotFoundException"
- // This exception is thrown when a resource is not found by the AWS Transfer
- // for SFTP service.
- //
- // See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DescribeServer
- func (c *Transfer) DescribeServer(input *DescribeServerInput) (*DescribeServerOutput, error) {
- req, out := c.DescribeServerRequest(input)
- return out, req.Send()
- }
- // DescribeServerWithContext is the same as DescribeServer with the addition of
- // the ability to pass a context and additional request options.
- //
- // See DescribeServer for details on how to use this API operation.
- //
- // The context must be non-nil and will be used for request cancellation. If
- // the context is nil a panic will occur. In the future the SDK may create
- // sub-contexts for http.Requests. See https://golang.org/pkg/context/
- // for more information on using Contexts.
- func (c *Transfer) DescribeServerWithContext(ctx aws.Context, input *DescribeServerInput, opts ...request.Option) (*DescribeServerOutput, error) {
- req, out := c.DescribeServerRequest(input)
- req.SetContext(ctx)
- req.ApplyOptions(opts...)
- return out, req.Send()
- }
- const opDescribeUser = "DescribeUser"
- // DescribeUserRequest generates a "aws/request.Request" representing the
- // client's request for the DescribeUser operation. The "output" return
- // value will be populated with the request's response once the request completes
- // successfully.
- //
- // Use "Send" method on the returned Request to send the API call to the service.
- // the "output" return value is not valid until after Send returns without error.
- //
- // See DescribeUser for more information on using the DescribeUser
- // API call, and error handling.
- //
- // This method is useful when you want to inject custom logic or configuration
- // into the SDK's request lifecycle. Such as custom headers, or retry logic.
- //
- //
- // // Example sending a request using the DescribeUserRequest method.
- // req, resp := client.DescribeUserRequest(params)
- //
- // err := req.Send()
- // if err == nil { // resp is now filled
- // fmt.Println(resp)
- // }
- //
- // See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DescribeUser
- func (c *Transfer) DescribeUserRequest(input *DescribeUserInput) (req *request.Request, output *DescribeUserOutput) {
- op := &request.Operation{
- Name: opDescribeUser,
- HTTPMethod: "POST",
- HTTPPath: "/",
- }
- if input == nil {
- input = &DescribeUserInput{}
- }
- output = &DescribeUserOutput{}
- req = c.newRequest(op, input, output)
- return
- }
- // DescribeUser API operation for AWS Transfer for SFTP.
- //
- // Describes the user assigned to a specific server, as identified by its ServerId
- // property.
- //
- // The response from this call returns the properties of the user associated
- // with the ServerId value that was specified.
- //
- // 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 AWS Transfer for SFTP's
- // API operation DescribeUser for usage and error information.
- //
- // Returned Error Codes:
- // * ErrCodeServiceUnavailableException "ServiceUnavailableException"
- // The request has failed because the AWS Transfer for SFTP service is not available.
- //
- // * ErrCodeInternalServiceError "InternalServiceError"
- // This exception is thrown when an error occurs in the AWS Transfer for SFTP
- // service.
- //
- // * ErrCodeInvalidRequestException "InvalidRequestException"
- // This exception is thrown when the client submits a malformed request.
- //
- // * ErrCodeResourceNotFoundException "ResourceNotFoundException"
- // This exception is thrown when a resource is not found by the AWS Transfer
- // for SFTP service.
- //
- // See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/DescribeUser
- func (c *Transfer) DescribeUser(input *DescribeUserInput) (*DescribeUserOutput, error) {
- req, out := c.DescribeUserRequest(input)
- return out, req.Send()
- }
- // DescribeUserWithContext is the same as DescribeUser with the addition of
- // the ability to pass a context and additional request options.
- //
- // See DescribeUser for details on how to use this API operation.
- //
- // The context must be non-nil and will be used for request cancellation. If
- // the context is nil a panic will occur. In the future the SDK may create
- // sub-contexts for http.Requests. See https://golang.org/pkg/context/
- // for more information on using Contexts.
- func (c *Transfer) DescribeUserWithContext(ctx aws.Context, input *DescribeUserInput, opts ...request.Option) (*DescribeUserOutput, error) {
- req, out := c.DescribeUserRequest(input)
- req.SetContext(ctx)
- req.ApplyOptions(opts...)
- return out, req.Send()
- }
- const opImportSshPublicKey = "ImportSshPublicKey"
- // ImportSshPublicKeyRequest generates a "aws/request.Request" representing the
- // client's request for the ImportSshPublicKey operation. The "output" return
- // value will be populated with the request's response once the request completes
- // successfully.
- //
- // Use "Send" method on the returned Request to send the API call to the service.
- // the "output" return value is not valid until after Send returns without error.
- //
- // See ImportSshPublicKey for more information on using the ImportSshPublicKey
- // API call, and error handling.
- //
- // This method is useful when you want to inject custom logic or configuration
- // into the SDK's request lifecycle. Such as custom headers, or retry logic.
- //
- //
- // // Example sending a request using the ImportSshPublicKeyRequest method.
- // req, resp := client.ImportSshPublicKeyRequest(params)
- //
- // err := req.Send()
- // if err == nil { // resp is now filled
- // fmt.Println(resp)
- // }
- //
- // See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/ImportSshPublicKey
- func (c *Transfer) ImportSshPublicKeyRequest(input *ImportSshPublicKeyInput) (req *request.Request, output *ImportSshPublicKeyOutput) {
- op := &request.Operation{
- Name: opImportSshPublicKey,
- HTTPMethod: "POST",
- HTTPPath: "/",
- }
- if input == nil {
- input = &ImportSshPublicKeyInput{}
- }
- output = &ImportSshPublicKeyOutput{}
- req = c.newRequest(op, input, output)
- return
- }
- // ImportSshPublicKey API operation for AWS Transfer for SFTP.
- //
- // Adds a Secure Shell (SSH) public key to a user account identified by a UserName
- // value assigned to a specific server, identified by ServerId.
- //
- // The response returns the UserName value, the ServerId value, and the name
- // of the SshPublicKeyId.
- //
- // 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 AWS Transfer for SFTP's
- // API operation ImportSshPublicKey for usage and error information.
- //
- // Returned Error Codes:
- // * ErrCodeServiceUnavailableException "ServiceUnavailableException"
- // The request has failed because the AWS Transfer for SFTP service is not available.
- //
- // * ErrCodeInternalServiceError "InternalServiceError"
- // This exception is thrown when an error occurs in the AWS Transfer for SFTP
- // service.
- //
- // * ErrCodeInvalidRequestException "InvalidRequestException"
- // This exception is thrown when the client submits a malformed request.
- //
- // * ErrCodeResourceExistsException "ResourceExistsException"
- // The requested resource does not exist.
- //
- // * ErrCodeResourceNotFoundException "ResourceNotFoundException"
- // This exception is thrown when a resource is not found by the AWS Transfer
- // for SFTP service.
- //
- // See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/ImportSshPublicKey
- func (c *Transfer) ImportSshPublicKey(input *ImportSshPublicKeyInput) (*ImportSshPublicKeyOutput, error) {
- req, out := c.ImportSshPublicKeyRequest(input)
- return out, req.Send()
- }
- // ImportSshPublicKeyWithContext is the same as ImportSshPublicKey with the addition of
- // the ability to pass a context and additional request options.
- //
- // See ImportSshPublicKey for details on how to use this API operation.
- //
- // The context must be non-nil and will be used for request cancellation. If
- // the context is nil a panic will occur. In the future the SDK may create
- // sub-contexts for http.Requests. See https://golang.org/pkg/context/
- // for more information on using Contexts.
- func (c *Transfer) ImportSshPublicKeyWithContext(ctx aws.Context, input *ImportSshPublicKeyInput, opts ...request.Option) (*ImportSshPublicKeyOutput, error) {
- req, out := c.ImportSshPublicKeyRequest(input)
- req.SetContext(ctx)
- req.ApplyOptions(opts...)
- return out, req.Send()
- }
- const opListServers = "ListServers"
- // ListServersRequest generates a "aws/request.Request" representing the
- // client's request for the ListServers operation. The "output" return
- // value will be populated with the request's response once the request completes
- // successfully.
- //
- // Use "Send" method on the returned Request to send the API call to the service.
- // the "output" return value is not valid until after Send returns without error.
- //
- // See ListServers for more information on using the ListServers
- // API call, and error handling.
- //
- // This method is useful when you want to inject custom logic or configuration
- // into the SDK's request lifecycle. Such as custom headers, or retry logic.
- //
- //
- // // Example sending a request using the ListServersRequest method.
- // req, resp := client.ListServersRequest(params)
- //
- // err := req.Send()
- // if err == nil { // resp is now filled
- // fmt.Println(resp)
- // }
- //
- // See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/ListServers
- func (c *Transfer) ListServersRequest(input *ListServersInput) (req *request.Request, output *ListServersOutput) {
- op := &request.Operation{
- Name: opListServers,
- HTTPMethod: "POST",
- HTTPPath: "/",
- }
- if input == nil {
- input = &ListServersInput{}
- }
- output = &ListServersOutput{}
- req = c.newRequest(op, input, output)
- return
- }
- // ListServers API operation for AWS Transfer for SFTP.
- //
- // Lists the Secure File Transfer Protocol (SFTP) servers that are associated
- // with your AWS 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 AWS Transfer for SFTP's
- // API operation ListServers for usage and error information.
- //
- // Returned Error Codes:
- // * ErrCodeServiceUnavailableException "ServiceUnavailableException"
- // The request has failed because the AWS Transfer for SFTP service is not available.
- //
- // * ErrCodeInternalServiceError "InternalServiceError"
- // This exception is thrown when an error occurs in the AWS Transfer for SFTP
- // service.
- //
- // * ErrCodeInvalidNextTokenException "InvalidNextTokenException"
- // The NextToken parameter that was passed is invalid.
- //
- // * ErrCodeInvalidRequestException "InvalidRequestException"
- // This exception is thrown when the client submits a malformed request.
- //
- // See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/ListServers
- func (c *Transfer) ListServers(input *ListServersInput) (*ListServersOutput, error) {
- req, out := c.ListServersRequest(input)
- return out, req.Send()
- }
- // ListServersWithContext is the same as ListServers with the addition of
- // the ability to pass a context and additional request options.
- //
- // See ListServers for details on how to use this API operation.
- //
- // The context must be non-nil and will be used for request cancellation. If
- // the context is nil a panic will occur. In the future the SDK may create
- // sub-contexts for http.Requests. See https://golang.org/pkg/context/
- // for more information on using Contexts.
- func (c *Transfer) ListServersWithContext(ctx aws.Context, input *ListServersInput, opts ...request.Option) (*ListServersOutput, error) {
- req, out := c.ListServersRequest(input)
- req.SetContext(ctx)
- req.ApplyOptions(opts...)
- return out, req.Send()
- }
- const opListTagsForResource = "ListTagsForResource"
- // ListTagsForResourceRequest generates a "aws/request.Request" representing the
- // client's request for the ListTagsForResource operation. The "output" return
- // value will be populated with the request's response once the request completes
- // successfully.
- //
- // Use "Send" method on the returned Request to send the API call to the service.
- // the "output" return value is not valid until after Send returns without error.
- //
- // See ListTagsForResource for more information on using the ListTagsForResource
- // API call, and error handling.
- //
- // This method is useful when you want to inject custom logic or configuration
- // into the SDK's request lifecycle. Such as custom headers, or retry logic.
- //
- //
- // // Example sending a request using the ListTagsForResourceRequest method.
- // req, resp := client.ListTagsForResourceRequest(params)
- //
- // err := req.Send()
- // if err == nil { // resp is now filled
- // fmt.Println(resp)
- // }
- //
- // See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/ListTagsForResource
- func (c *Transfer) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput) {
- op := &request.Operation{
- Name: opListTagsForResource,
- HTTPMethod: "POST",
- HTTPPath: "/",
- }
- if input == nil {
- input = &ListTagsForResourceInput{}
- }
- output = &ListTagsForResourceOutput{}
- req = c.newRequest(op, input, output)
- return
- }
- // ListTagsForResource API operation for AWS Transfer for SFTP.
- //
- // Lists all of the tags associated with the Amazon Resource Number (ARN) you
- // specify. The resource can be a user, server, or role.
- //
- // 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 AWS Transfer for SFTP's
- // API operation ListTagsForResource for usage and error information.
- //
- // Returned Error Codes:
- // * ErrCodeServiceUnavailableException "ServiceUnavailableException"
- // The request has failed because the AWS Transfer for SFTP service is not available.
- //
- // * ErrCodeInternalServiceError "InternalServiceError"
- // This exception is thrown when an error occurs in the AWS Transfer for SFTP
- // service.
- //
- // * ErrCodeInvalidNextTokenException "InvalidNextTokenException"
- // The NextToken parameter that was passed is invalid.
- //
- // * ErrCodeInvalidRequestException "InvalidRequestException"
- // This exception is thrown when the client submits a malformed request.
- //
- // See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/ListTagsForResource
- func (c *Transfer) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error) {
- req, out := c.ListTagsForResourceRequest(input)
- return out, req.Send()
- }
- // ListTagsForResourceWithContext is the same as ListTagsForResource with the addition of
- // the ability to pass a context and additional request options.
- //
- // See ListTagsForResource for details on how to use this API operation.
- //
- // The context must be non-nil and will be used for request cancellation. If
- // the context is nil a panic will occur. In the future the SDK may create
- // sub-contexts for http.Requests. See https://golang.org/pkg/context/
- // for more information on using Contexts.
- func (c *Transfer) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error) {
- req, out := c.ListTagsForResourceRequest(input)
- req.SetContext(ctx)
- req.ApplyOptions(opts...)
- return out, req.Send()
- }
- const opListUsers = "ListUsers"
- // ListUsersRequest generates a "aws/request.Request" representing the
- // client's request for the ListUsers operation. The "output" return
- // value will be populated with the request's response once the request completes
- // successfully.
- //
- // Use "Send" method on the returned Request to send the API call to the service.
- // the "output" return value is not valid until after Send returns without error.
- //
- // See ListUsers for more information on using the ListUsers
- // API call, and error handling.
- //
- // This method is useful when you want to inject custom logic or configuration
- // into the SDK's request lifecycle. Such as custom headers, or retry logic.
- //
- //
- // // Example sending a request using the ListUsersRequest method.
- // req, resp := client.ListUsersRequest(params)
- //
- // err := req.Send()
- // if err == nil { // resp is now filled
- // fmt.Println(resp)
- // }
- //
- // See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/ListUsers
- func (c *Transfer) ListUsersRequest(input *ListUsersInput) (req *request.Request, output *ListUsersOutput) {
- op := &request.Operation{
- Name: opListUsers,
- HTTPMethod: "POST",
- HTTPPath: "/",
- }
- if input == nil {
- input = &ListUsersInput{}
- }
- output = &ListUsersOutput{}
- req = c.newRequest(op, input, output)
- return
- }
- // ListUsers API operation for AWS Transfer for SFTP.
- //
- // Lists the users for the server that you specify by passing the ServerId parameter.
- //
- // 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 AWS Transfer for SFTP's
- // API operation ListUsers for usage and error information.
- //
- // Returned Error Codes:
- // * ErrCodeServiceUnavailableException "ServiceUnavailableException"
- // The request has failed because the AWS Transfer for SFTP service is not available.
- //
- // * ErrCodeInternalServiceError "InternalServiceError"
- // This exception is thrown when an error occurs in the AWS Transfer for SFTP
- // service.
- //
- // * ErrCodeInvalidNextTokenException "InvalidNextTokenException"
- // The NextToken parameter that was passed is invalid.
- //
- // * ErrCodeInvalidRequestException "InvalidRequestException"
- // This exception is thrown when the client submits a malformed request.
- //
- // * ErrCodeResourceNotFoundException "ResourceNotFoundException"
- // This exception is thrown when a resource is not found by the AWS Transfer
- // for SFTP service.
- //
- // See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/ListUsers
- func (c *Transfer) ListUsers(input *ListUsersInput) (*ListUsersOutput, error) {
- req, out := c.ListUsersRequest(input)
- return out, req.Send()
- }
- // ListUsersWithContext is the same as ListUsers with the addition of
- // the ability to pass a context and additional request options.
- //
- // See ListUsers for details on how to use this API operation.
- //
- // The context must be non-nil and will be used for request cancellation. If
- // the context is nil a panic will occur. In the future the SDK may create
- // sub-contexts for http.Requests. See https://golang.org/pkg/context/
- // for more information on using Contexts.
- func (c *Transfer) ListUsersWithContext(ctx aws.Context, input *ListUsersInput, opts ...request.Option) (*ListUsersOutput, error) {
- req, out := c.ListUsersRequest(input)
- req.SetContext(ctx)
- req.ApplyOptions(opts...)
- return out, req.Send()
- }
- const opStartServer = "StartServer"
- // StartServerRequest generates a "aws/request.Request" representing the
- // client's request for the StartServer operation. The "output" return
- // value will be populated with the request's response once the request completes
- // successfully.
- //
- // Use "Send" method on the returned Request to send the API call to the service.
- // the "output" return value is not valid until after Send returns without error.
- //
- // See StartServer for more information on using the StartServer
- // API call, and error handling.
- //
- // This method is useful when you want to inject custom logic or configuration
- // into the SDK's request lifecycle. Such as custom headers, or retry logic.
- //
- //
- // // Example sending a request using the StartServerRequest method.
- // req, resp := client.StartServerRequest(params)
- //
- // err := req.Send()
- // if err == nil { // resp is now filled
- // fmt.Println(resp)
- // }
- //
- // See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/StartServer
- func (c *Transfer) StartServerRequest(input *StartServerInput) (req *request.Request, output *StartServerOutput) {
- op := &request.Operation{
- Name: opStartServer,
- HTTPMethod: "POST",
- HTTPPath: "/",
- }
- if input == nil {
- input = &StartServerInput{}
- }
- output = &StartServerOutput{}
- req = c.newRequest(op, input, output)
- req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler)
- return
- }
- // StartServer API operation for AWS Transfer for SFTP.
- //
- // Changes the state of a Secure File Transfer Protocol (SFTP) server from OFFLINE
- // to ONLINE. It has no impact on an SFTP server that is already ONLINE. An
- // ONLINE server can accept and process file transfer jobs.
- //
- // The state of STARTING indicates that the server is in an intermediate state,
- // either not fully able to respond, or not fully online. The values of START_FAILED
- // can indicate an error condition.
- //
- // No response is returned from this call.
- //
- // 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 AWS Transfer for SFTP's
- // API operation StartServer for usage and error information.
- //
- // Returned Error Codes:
- // * ErrCodeServiceUnavailableException "ServiceUnavailableException"
- // The request has failed because the AWS Transfer for SFTP service is not available.
- //
- // * ErrCodeInternalServiceError "InternalServiceError"
- // This exception is thrown when an error occurs in the AWS Transfer for SFTP
- // service.
- //
- // * ErrCodeInvalidRequestException "InvalidRequestException"
- // This exception is thrown when the client submits a malformed request.
- //
- // * ErrCodeResourceNotFoundException "ResourceNotFoundException"
- // This exception is thrown when a resource is not found by the AWS Transfer
- // for SFTP service.
- //
- // See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/StartServer
- func (c *Transfer) StartServer(input *StartServerInput) (*StartServerOutput, error) {
- req, out := c.StartServerRequest(input)
- return out, req.Send()
- }
- // StartServerWithContext is the same as StartServer with the addition of
- // the ability to pass a context and additional request options.
- //
- // See StartServer for details on how to use this API operation.
- //
- // The context must be non-nil and will be used for request cancellation. If
- // the context is nil a panic will occur. In the future the SDK may create
- // sub-contexts for http.Requests. See https://golang.org/pkg/context/
- // for more information on using Contexts.
- func (c *Transfer) StartServerWithContext(ctx aws.Context, input *StartServerInput, opts ...request.Option) (*StartServerOutput, error) {
- req, out := c.StartServerRequest(input)
- req.SetContext(ctx)
- req.ApplyOptions(opts...)
- return out, req.Send()
- }
- const opStopServer = "StopServer"
- // StopServerRequest generates a "aws/request.Request" representing the
- // client's request for the StopServer operation. The "output" return
- // value will be populated with the request's response once the request completes
- // successfully.
- //
- // Use "Send" method on the returned Request to send the API call to the service.
- // the "output" return value is not valid until after Send returns without error.
- //
- // See StopServer for more information on using the StopServer
- // API call, and error handling.
- //
- // This method is useful when you want to inject custom logic or configuration
- // into the SDK's request lifecycle. Such as custom headers, or retry logic.
- //
- //
- // // Example sending a request using the StopServerRequest method.
- // req, resp := client.StopServerRequest(params)
- //
- // err := req.Send()
- // if err == nil { // resp is now filled
- // fmt.Println(resp)
- // }
- //
- // See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/StopServer
- func (c *Transfer) StopServerRequest(input *StopServerInput) (req *request.Request, output *StopServerOutput) {
- op := &request.Operation{
- Name: opStopServer,
- HTTPMethod: "POST",
- HTTPPath: "/",
- }
- if input == nil {
- input = &StopServerInput{}
- }
- output = &StopServerOutput{}
- req = c.newRequest(op, input, output)
- req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler)
- return
- }
- // StopServer API operation for AWS Transfer for SFTP.
- //
- // Changes the state of an SFTP server from ONLINE to OFFLINE. An OFFLINE server
- // cannot accept and process file transfer jobs. Information tied to your server
- // such as server and user properties are not affected by stopping your server.
- // Stopping a server will not reduce or impact your Secure File Transfer Protocol
- // (SFTP) endpoint billing.
- //
- // The states of STOPPING indicates that the server is in an intermediate state,
- // either not fully able to respond, or not fully offline. The values of STOP_FAILED
- // can indicate an error condition.
- //
- // No response is returned from this call.
- //
- // 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 AWS Transfer for SFTP's
- // API operation StopServer for usage and error information.
- //
- // Returned Error Codes:
- // * ErrCodeServiceUnavailableException "ServiceUnavailableException"
- // The request has failed because the AWS Transfer for SFTP service is not available.
- //
- // * ErrCodeInternalServiceError "InternalServiceError"
- // This exception is thrown when an error occurs in the AWS Transfer for SFTP
- // service.
- //
- // * ErrCodeInvalidRequestException "InvalidRequestException"
- // This exception is thrown when the client submits a malformed request.
- //
- // * ErrCodeResourceNotFoundException "ResourceNotFoundException"
- // This exception is thrown when a resource is not found by the AWS Transfer
- // for SFTP service.
- //
- // See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/StopServer
- func (c *Transfer) StopServer(input *StopServerInput) (*StopServerOutput, error) {
- req, out := c.StopServerRequest(input)
- return out, req.Send()
- }
- // StopServerWithContext is the same as StopServer with the addition of
- // the ability to pass a context and additional request options.
- //
- // See StopServer for details on how to use this API operation.
- //
- // The context must be non-nil and will be used for request cancellation. If
- // the context is nil a panic will occur. In the future the SDK may create
- // sub-contexts for http.Requests. See https://golang.org/pkg/context/
- // for more information on using Contexts.
- func (c *Transfer) StopServerWithContext(ctx aws.Context, input *StopServerInput, opts ...request.Option) (*StopServerOutput, error) {
- req, out := c.StopServerRequest(input)
- req.SetContext(ctx)
- req.ApplyOptions(opts...)
- return out, req.Send()
- }
- const opTagResource = "TagResource"
- // TagResourceRequest generates a "aws/request.Request" representing the
- // client's request for the TagResource operation. The "output" return
- // value will be populated with the request's response once the request completes
- // successfully.
- //
- // Use "Send" method on the returned Request to send the API call to the service.
- // the "output" return value is not valid until after Send returns without error.
- //
- // See TagResource for more information on using the TagResource
- // API call, and error handling.
- //
- // This method is useful when you want to inject custom logic or configuration
- // into the SDK's request lifecycle. Such as custom headers, or retry logic.
- //
- //
- // // Example sending a request using the TagResourceRequest method.
- // req, resp := client.TagResourceRequest(params)
- //
- // err := req.Send()
- // if err == nil { // resp is now filled
- // fmt.Println(resp)
- // }
- //
- // See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/TagResource
- func (c *Transfer) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput) {
- op := &request.Operation{
- Name: opTagResource,
- HTTPMethod: "POST",
- HTTPPath: "/",
- }
- if input == nil {
- input = &TagResourceInput{}
- }
- output = &TagResourceOutput{}
- req = c.newRequest(op, input, output)
- req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler)
- return
- }
- // TagResource API operation for AWS Transfer for SFTP.
- //
- // Attaches a key-value pair to a resource, as identified by its Amazon Resource
- // Name (ARN). Resources are users, servers, roles, and other entities.
- //
- // There is no response returned from this call.
- //
- // 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 AWS Transfer for SFTP's
- // API operation TagResource for usage and error information.
- //
- // Returned Error Codes:
- // * ErrCodeServiceUnavailableException "ServiceUnavailableException"
- // The request has failed because the AWS Transfer for SFTP service is not available.
- //
- // * ErrCodeInternalServiceError "InternalServiceError"
- // This exception is thrown when an error occurs in the AWS Transfer for SFTP
- // service.
- //
- // * ErrCodeInvalidRequestException "InvalidRequestException"
- // This exception is thrown when the client submits a malformed request.
- //
- // See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/TagResource
- func (c *Transfer) TagResource(input *TagResourceInput) (*TagResourceOutput, error) {
- req, out := c.TagResourceRequest(input)
- return out, req.Send()
- }
- // TagResourceWithContext is the same as TagResource with the addition of
- // the ability to pass a context and additional request options.
- //
- // See TagResource for details on how to use this API operation.
- //
- // The context must be non-nil and will be used for request cancellation. If
- // the context is nil a panic will occur. In the future the SDK may create
- // sub-contexts for http.Requests. See https://golang.org/pkg/context/
- // for more information on using Contexts.
- func (c *Transfer) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error) {
- req, out := c.TagResourceRequest(input)
- req.SetContext(ctx)
- req.ApplyOptions(opts...)
- return out, req.Send()
- }
- const opTestIdentityProvider = "TestIdentityProvider"
- // TestIdentityProviderRequest generates a "aws/request.Request" representing the
- // client's request for the TestIdentityProvider operation. The "output" return
- // value will be populated with the request's response once the request completes
- // successfully.
- //
- // Use "Send" method on the returned Request to send the API call to the service.
- // the "output" return value is not valid until after Send returns without error.
- //
- // See TestIdentityProvider for more information on using the TestIdentityProvider
- // API call, and error handling.
- //
- // This method is useful when you want to inject custom logic or configuration
- // into the SDK's request lifecycle. Such as custom headers, or retry logic.
- //
- //
- // // Example sending a request using the TestIdentityProviderRequest method.
- // req, resp := client.TestIdentityProviderRequest(params)
- //
- // err := req.Send()
- // if err == nil { // resp is now filled
- // fmt.Println(resp)
- // }
- //
- // See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/TestIdentityProvider
- func (c *Transfer) TestIdentityProviderRequest(input *TestIdentityProviderInput) (req *request.Request, output *TestIdentityProviderOutput) {
- op := &request.Operation{
- Name: opTestIdentityProvider,
- HTTPMethod: "POST",
- HTTPPath: "/",
- }
- if input == nil {
- input = &TestIdentityProviderInput{}
- }
- output = &TestIdentityProviderOutput{}
- req = c.newRequest(op, input, output)
- return
- }
- // TestIdentityProvider API operation for AWS Transfer for SFTP.
- //
- // If the IdentityProviderType of the server is API_Gateway, tests whether your
- // API Gateway is set up successfully. We highly recommend that you call this
- // method to test your authentication method as soon as you create your server.
- // By doing so, you can troubleshoot issues with the API Gateway integration
- // to ensure that your users can successfully use the service.
- //
- // 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 AWS Transfer for SFTP's
- // API operation TestIdentityProvider for usage and error information.
- //
- // Returned Error Codes:
- // * ErrCodeServiceUnavailableException "ServiceUnavailableException"
- // The request has failed because the AWS Transfer for SFTP service is not available.
- //
- // * ErrCodeInternalServiceError "InternalServiceError"
- // This exception is thrown when an error occurs in the AWS Transfer for SFTP
- // service.
- //
- // * ErrCodeInvalidRequestException "InvalidRequestException"
- // This exception is thrown when the client submits a malformed request.
- //
- // * ErrCodeResourceNotFoundException "ResourceNotFoundException"
- // This exception is thrown when a resource is not found by the AWS Transfer
- // for SFTP service.
- //
- // See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/TestIdentityProvider
- func (c *Transfer) TestIdentityProvider(input *TestIdentityProviderInput) (*TestIdentityProviderOutput, error) {
- req, out := c.TestIdentityProviderRequest(input)
- return out, req.Send()
- }
- // TestIdentityProviderWithContext is the same as TestIdentityProvider with the addition of
- // the ability to pass a context and additional request options.
- //
- // See TestIdentityProvider for details on how to use this API operation.
- //
- // The context must be non-nil and will be used for request cancellation. If
- // the context is nil a panic will occur. In the future the SDK may create
- // sub-contexts for http.Requests. See https://golang.org/pkg/context/
- // for more information on using Contexts.
- func (c *Transfer) TestIdentityProviderWithContext(ctx aws.Context, input *TestIdentityProviderInput, opts ...request.Option) (*TestIdentityProviderOutput, error) {
- req, out := c.TestIdentityProviderRequest(input)
- req.SetContext(ctx)
- req.ApplyOptions(opts...)
- return out, req.Send()
- }
- const opUntagResource = "UntagResource"
- // UntagResourceRequest generates a "aws/request.Request" representing the
- // client's request for the UntagResource operation. The "output" return
- // value will be populated with the request's response once the request completes
- // successfully.
- //
- // Use "Send" method on the returned Request to send the API call to the service.
- // the "output" return value is not valid until after Send returns without error.
- //
- // See UntagResource for more information on using the UntagResource
- // API call, and error handling.
- //
- // This method is useful when you want to inject custom logic or configuration
- // into the SDK's request lifecycle. Such as custom headers, or retry logic.
- //
- //
- // // Example sending a request using the UntagResourceRequest method.
- // req, resp := client.UntagResourceRequest(params)
- //
- // err := req.Send()
- // if err == nil { // resp is now filled
- // fmt.Println(resp)
- // }
- //
- // See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/UntagResource
- func (c *Transfer) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput) {
- op := &request.Operation{
- Name: opUntagResource,
- HTTPMethod: "POST",
- HTTPPath: "/",
- }
- if input == nil {
- input = &UntagResourceInput{}
- }
- output = &UntagResourceOutput{}
- req = c.newRequest(op, input, output)
- req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler)
- return
- }
- // UntagResource API operation for AWS Transfer for SFTP.
- //
- // Detaches a key-value pair from a resource, as identified by its Amazon Resource
- // Name (ARN). Resources are users, servers, roles, and other entities.
- //
- // No response is returned from this call.
- //
- // 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 AWS Transfer for SFTP's
- // API operation UntagResource for usage and error information.
- //
- // Returned Error Codes:
- // * ErrCodeServiceUnavailableException "ServiceUnavailableException"
- // The request has failed because the AWS Transfer for SFTP service is not available.
- //
- // * ErrCodeInternalServiceError "InternalServiceError"
- // This exception is thrown when an error occurs in the AWS Transfer for SFTP
- // service.
- //
- // * ErrCodeInvalidRequestException "InvalidRequestException"
- // This exception is thrown when the client submits a malformed request.
- //
- // See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/UntagResource
- func (c *Transfer) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error) {
- req, out := c.UntagResourceRequest(input)
- return out, req.Send()
- }
- // UntagResourceWithContext is the same as UntagResource with the addition of
- // the ability to pass a context and additional request options.
- //
- // See UntagResource for details on how to use this API operation.
- //
- // The context must be non-nil and will be used for request cancellation. If
- // the context is nil a panic will occur. In the future the SDK may create
- // sub-contexts for http.Requests. See https://golang.org/pkg/context/
- // for more information on using Contexts.
- func (c *Transfer) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error) {
- req, out := c.UntagResourceRequest(input)
- req.SetContext(ctx)
- req.ApplyOptions(opts...)
- return out, req.Send()
- }
- const opUpdateServer = "UpdateServer"
- // UpdateServerRequest generates a "aws/request.Request" representing the
- // client's request for the UpdateServer operation. The "output" return
- // value will be populated with the request's response once the request completes
- // successfully.
- //
- // Use "Send" method on the returned Request to send the API call to the service.
- // the "output" return value is not valid until after Send returns without error.
- //
- // See UpdateServer for more information on using the UpdateServer
- // API call, and error handling.
- //
- // This method is useful when you want to inject custom logic or configuration
- // into the SDK's request lifecycle. Such as custom headers, or retry logic.
- //
- //
- // // Example sending a request using the UpdateServerRequest method.
- // req, resp := client.UpdateServerRequest(params)
- //
- // err := req.Send()
- // if err == nil { // resp is now filled
- // fmt.Println(resp)
- // }
- //
- // See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/UpdateServer
- func (c *Transfer) UpdateServerRequest(input *UpdateServerInput) (req *request.Request, output *UpdateServerOutput) {
- op := &request.Operation{
- Name: opUpdateServer,
- HTTPMethod: "POST",
- HTTPPath: "/",
- }
- if input == nil {
- input = &UpdateServerInput{}
- }
- output = &UpdateServerOutput{}
- req = c.newRequest(op, input, output)
- return
- }
- // UpdateServer API operation for AWS Transfer for SFTP.
- //
- // Updates the server properties after that server has been created.
- //
- // The UpdateServer call returns the ServerId of the Secure File Transfer Protocol
- // (SFTP) server you updated.
- //
- // 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 AWS Transfer for SFTP's
- // API operation UpdateServer for usage and error information.
- //
- // Returned Error Codes:
- // * ErrCodeServiceUnavailableException "ServiceUnavailableException"
- // The request has failed because the AWS Transfer for SFTP service is not available.
- //
- // * ErrCodeInternalServiceError "InternalServiceError"
- // This exception is thrown when an error occurs in the AWS Transfer for SFTP
- // service.
- //
- // * ErrCodeInvalidRequestException "InvalidRequestException"
- // This exception is thrown when the client submits a malformed request.
- //
- // * ErrCodeResourceNotFoundException "ResourceNotFoundException"
- // This exception is thrown when a resource is not found by the AWS Transfer
- // for SFTP service.
- //
- // See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/UpdateServer
- func (c *Transfer) UpdateServer(input *UpdateServerInput) (*UpdateServerOutput, error) {
- req, out := c.UpdateServerRequest(input)
- return out, req.Send()
- }
- // UpdateServerWithContext is the same as UpdateServer with the addition of
- // the ability to pass a context and additional request options.
- //
- // See UpdateServer for details on how to use this API operation.
- //
- // The context must be non-nil and will be used for request cancellation. If
- // the context is nil a panic will occur. In the future the SDK may create
- // sub-contexts for http.Requests. See https://golang.org/pkg/context/
- // for more information on using Contexts.
- func (c *Transfer) UpdateServerWithContext(ctx aws.Context, input *UpdateServerInput, opts ...request.Option) (*UpdateServerOutput, error) {
- req, out := c.UpdateServerRequest(input)
- req.SetContext(ctx)
- req.ApplyOptions(opts...)
- return out, req.Send()
- }
- const opUpdateUser = "UpdateUser"
- // UpdateUserRequest generates a "aws/request.Request" representing the
- // client's request for the UpdateUser operation. The "output" return
- // value will be populated with the request's response once the request completes
- // successfully.
- //
- // Use "Send" method on the returned Request to send the API call to the service.
- // the "output" return value is not valid until after Send returns without error.
- //
- // See UpdateUser for more information on using the UpdateUser
- // API call, and error handling.
- //
- // This method is useful when you want to inject custom logic or configuration
- // into the SDK's request lifecycle. Such as custom headers, or retry logic.
- //
- //
- // // Example sending a request using the UpdateUserRequest method.
- // req, resp := client.UpdateUserRequest(params)
- //
- // err := req.Send()
- // if err == nil { // resp is now filled
- // fmt.Println(resp)
- // }
- //
- // See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/UpdateUser
- func (c *Transfer) UpdateUserRequest(input *UpdateUserInput) (req *request.Request, output *UpdateUserOutput) {
- op := &request.Operation{
- Name: opUpdateUser,
- HTTPMethod: "POST",
- HTTPPath: "/",
- }
- if input == nil {
- input = &UpdateUserInput{}
- }
- output = &UpdateUserOutput{}
- req = c.newRequest(op, input, output)
- return
- }
- // UpdateUser API operation for AWS Transfer for SFTP.
- //
- // Assigns new properties to a user. Parameters you pass modify any or all of
- // the following: the home directory, role, and policy for the UserName and
- // ServerId you specify.
- //
- // The response returns the ServerId and the UserName for the updated user.
- //
- // 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 AWS Transfer for SFTP's
- // API operation UpdateUser for usage and error information.
- //
- // Returned Error Codes:
- // * ErrCodeServiceUnavailableException "ServiceUnavailableException"
- // The request has failed because the AWS Transfer for SFTP service is not available.
- //
- // * ErrCodeInternalServiceError "InternalServiceError"
- // This exception is thrown when an error occurs in the AWS Transfer for SFTP
- // service.
- //
- // * ErrCodeInvalidRequestException "InvalidRequestException"
- // This exception is thrown when the client submits a malformed request.
- //
- // * ErrCodeResourceNotFoundException "ResourceNotFoundException"
- // This exception is thrown when a resource is not found by the AWS Transfer
- // for SFTP service.
- //
- // See also, https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/UpdateUser
- func (c *Transfer) UpdateUser(input *UpdateUserInput) (*UpdateUserOutput, error) {
- req, out := c.UpdateUserRequest(input)
- return out, req.Send()
- }
- // UpdateUserWithContext is the same as UpdateUser with the addition of
- // the ability to pass a context and additional request options.
- //
- // See UpdateUser for details on how to use this API operation.
- //
- // The context must be non-nil and will be used for request cancellation. If
- // the context is nil a panic will occur. In the future the SDK may create
- // sub-contexts for http.Requests. See https://golang.org/pkg/context/
- // for more information on using Contexts.
- func (c *Transfer) UpdateUserWithContext(ctx aws.Context, input *UpdateUserInput, opts ...request.Option) (*UpdateUserOutput, error) {
- req, out := c.UpdateUserRequest(input)
- req.SetContext(ctx)
- req.ApplyOptions(opts...)
- return out, req.Send()
- }
- type CreateServerInput struct {
- _ struct{} `type:"structure"`
- // An array containing all of the information required to call a customer-supplied
- // authentication API. This parameter is not required when the IdentityProviderType
- // value of server that is created uses the SERVICE_MANAGED authentication method.
- IdentityProviderDetails *IdentityProviderDetails `type:"structure"`
- // The mode of authentication enabled for this service. The default value is
- // SERVICE_MANAGED, which allows you to store and access SFTP user credentials
- // within the service. An IdentityProviderType value of API_GATEWAY indicates
- // that user authentication requires a call to an API Gateway endpoint URL provided
- // by you to integrate an identity provider of your choice.
- IdentityProviderType *string `type:"string" enum:"IdentityProviderType"`
- // A value that allows the service to write your SFTP users’ activity to your
- // Amazon CloudWatch logs for monitoring and auditing purposes.
- LoggingRole *string `type:"string"`
- // Key-value pairs that can be used to group and search for servers.
- Tags []*Tag `min:"1" type:"list"`
- }
- // String returns the string representation
- func (s CreateServerInput) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s CreateServerInput) GoString() string {
- return s.String()
- }
- // Validate inspects the fields of the type to determine if they are valid.
- func (s *CreateServerInput) Validate() error {
- invalidParams := request.ErrInvalidParams{Context: "CreateServerInput"}
- if s.Tags != nil && len(s.Tags) < 1 {
- invalidParams.Add(request.NewErrParamMinLen("Tags", 1))
- }
- if s.Tags != nil {
- for i, v := range s.Tags {
- if v == nil {
- continue
- }
- if err := v.Validate(); err != nil {
- invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Tags", i), err.(request.ErrInvalidParams))
- }
- }
- }
- if invalidParams.Len() > 0 {
- return invalidParams
- }
- return nil
- }
- // SetIdentityProviderDetails sets the IdentityProviderDetails field's value.
- func (s *CreateServerInput) SetIdentityProviderDetails(v *IdentityProviderDetails) *CreateServerInput {
- s.IdentityProviderDetails = v
- return s
- }
- // SetIdentityProviderType sets the IdentityProviderType field's value.
- func (s *CreateServerInput) SetIdentityProviderType(v string) *CreateServerInput {
- s.IdentityProviderType = &v
- return s
- }
- // SetLoggingRole sets the LoggingRole field's value.
- func (s *CreateServerInput) SetLoggingRole(v string) *CreateServerInput {
- s.LoggingRole = &v
- return s
- }
- // SetTags sets the Tags field's value.
- func (s *CreateServerInput) SetTags(v []*Tag) *CreateServerInput {
- s.Tags = v
- return s
- }
- type CreateServerOutput struct {
- _ struct{} `type:"structure"`
- // The service-assigned ID of the SFTP server that is created.
- //
- // ServerId is a required field
- ServerId *string `type:"string" required:"true"`
- }
- // String returns the string representation
- func (s CreateServerOutput) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s CreateServerOutput) GoString() string {
- return s.String()
- }
- // SetServerId sets the ServerId field's value.
- func (s *CreateServerOutput) SetServerId(v string) *CreateServerOutput {
- s.ServerId = &v
- return s
- }
- type CreateUserInput struct {
- _ struct{} `type:"structure"`
- // The landing directory (folder) for a user when they log in to the server
- // using their SFTP client. An example is /home/username.
- HomeDirectory *string `type:"string"`
- // A scope-down policy for your user so you can use the same IAM role across
- // multiple users. This policy scopes down user access to portions of their
- // Amazon S3 bucket. Variables you can use inside this policy include ${Transfer:UserName},
- // ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.
- Policy *string `type:"string"`
- // The IAM role that controls your user’s access to your Amazon S3 bucket. The
- // policies attached to this role will determine the level of access you want
- // to provide your users when transferring files into and out of your Amazon
- // S3 bucket or buckets. The IAM role should also contain a trust relationship
- // that allows the SFTP server to access your resources when servicing your
- // SFTP user’s transfer requests.
- //
- // Role is a required field
- Role *string `type:"string" required:"true"`
- // A system-assigned unique identifier for an SFTP server instance. This is
- // the specific SFTP server that you added your user to.
- //
- // ServerId is a required field
- ServerId *string `type:"string" required:"true"`
- // The public portion of the Secure Shall (SSH) key used to authenticate the
- // user to the SFTP server.
- SshPublicKeyBody *string `type:"string"`
- // Key-value pairs that can be used to group and search for users. Tags are
- // metadata attached to users for any purpose.
- Tags []*Tag `min:"1" type:"list"`
- // A unique string that identifies a user and is associated with a server as
- // specified by the ServerId.
- //
- // UserName is a required field
- UserName *string `type:"string" required:"true"`
- }
- // String returns the string representation
- func (s CreateUserInput) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s CreateUserInput) GoString() string {
- return s.String()
- }
- // Validate inspects the fields of the type to determine if they are valid.
- func (s *CreateUserInput) Validate() error {
- invalidParams := request.ErrInvalidParams{Context: "CreateUserInput"}
- if s.Role == nil {
- invalidParams.Add(request.NewErrParamRequired("Role"))
- }
- if s.ServerId == nil {
- invalidParams.Add(request.NewErrParamRequired("ServerId"))
- }
- if s.Tags != nil && len(s.Tags) < 1 {
- invalidParams.Add(request.NewErrParamMinLen("Tags", 1))
- }
- if s.UserName == nil {
- invalidParams.Add(request.NewErrParamRequired("UserName"))
- }
- if s.Tags != nil {
- for i, v := range s.Tags {
- if v == nil {
- continue
- }
- if err := v.Validate(); err != nil {
- invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Tags", i), err.(request.ErrInvalidParams))
- }
- }
- }
- if invalidParams.Len() > 0 {
- return invalidParams
- }
- return nil
- }
- // SetHomeDirectory sets the HomeDirectory field's value.
- func (s *CreateUserInput) SetHomeDirectory(v string) *CreateUserInput {
- s.HomeDirectory = &v
- return s
- }
- // SetPolicy sets the Policy field's value.
- func (s *CreateUserInput) SetPolicy(v string) *CreateUserInput {
- s.Policy = &v
- return s
- }
- // SetRole sets the Role field's value.
- func (s *CreateUserInput) SetRole(v string) *CreateUserInput {
- s.Role = &v
- return s
- }
- // SetServerId sets the ServerId field's value.
- func (s *CreateUserInput) SetServerId(v string) *CreateUserInput {
- s.ServerId = &v
- return s
- }
- // SetSshPublicKeyBody sets the SshPublicKeyBody field's value.
- func (s *CreateUserInput) SetSshPublicKeyBody(v string) *CreateUserInput {
- s.SshPublicKeyBody = &v
- return s
- }
- // SetTags sets the Tags field's value.
- func (s *CreateUserInput) SetTags(v []*Tag) *CreateUserInput {
- s.Tags = v
- return s
- }
- // SetUserName sets the UserName field's value.
- func (s *CreateUserInput) SetUserName(v string) *CreateUserInput {
- s.UserName = &v
- return s
- }
- type CreateUserOutput struct {
- _ struct{} `type:"structure"`
- // The ID of the SFTP server that the user is attached to.
- //
- // ServerId is a required field
- ServerId *string `type:"string" required:"true"`
- // A unique string that identifies a user account associated with an SFTP server.
- //
- // UserName is a required field
- UserName *string `type:"string" required:"true"`
- }
- // String returns the string representation
- func (s CreateUserOutput) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s CreateUserOutput) GoString() string {
- return s.String()
- }
- // SetServerId sets the ServerId field's value.
- func (s *CreateUserOutput) SetServerId(v string) *CreateUserOutput {
- s.ServerId = &v
- return s
- }
- // SetUserName sets the UserName field's value.
- func (s *CreateUserOutput) SetUserName(v string) *CreateUserOutput {
- s.UserName = &v
- return s
- }
- type DeleteServerInput struct {
- _ struct{} `type:"structure"`
- // A unique system-assigned identifier for an SFTP server instance.
- //
- // ServerId is a required field
- ServerId *string `type:"string" required:"true"`
- }
- // String returns the string representation
- func (s DeleteServerInput) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s DeleteServerInput) GoString() string {
- return s.String()
- }
- // Validate inspects the fields of the type to determine if they are valid.
- func (s *DeleteServerInput) Validate() error {
- invalidParams := request.ErrInvalidParams{Context: "DeleteServerInput"}
- if s.ServerId == nil {
- invalidParams.Add(request.NewErrParamRequired("ServerId"))
- }
- if invalidParams.Len() > 0 {
- return invalidParams
- }
- return nil
- }
- // SetServerId sets the ServerId field's value.
- func (s *DeleteServerInput) SetServerId(v string) *DeleteServerInput {
- s.ServerId = &v
- return s
- }
- type DeleteServerOutput struct {
- _ struct{} `type:"structure"`
- }
- // String returns the string representation
- func (s DeleteServerOutput) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s DeleteServerOutput) GoString() string {
- return s.String()
- }
- type DeleteSshPublicKeyInput struct {
- _ struct{} `type:"structure"`
- // A system-assigned unique identifier for a Secure File Transfer Protocol (SFTP)
- // server instance that has the user assigned to it.
- //
- // ServerId is a required field
- ServerId *string `type:"string" required:"true"`
- // A unique identifier used to reference your user’s specific SSH key.
- //
- // SshPublicKeyId is a required field
- SshPublicKeyId *string `type:"string" required:"true"`
- // A unique string that identifies a user whose public key is being deleted.
- //
- // UserName is a required field
- UserName *string `type:"string" required:"true"`
- }
- // String returns the string representation
- func (s DeleteSshPublicKeyInput) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s DeleteSshPublicKeyInput) GoString() string {
- return s.String()
- }
- // Validate inspects the fields of the type to determine if they are valid.
- func (s *DeleteSshPublicKeyInput) Validate() error {
- invalidParams := request.ErrInvalidParams{Context: "DeleteSshPublicKeyInput"}
- if s.ServerId == nil {
- invalidParams.Add(request.NewErrParamRequired("ServerId"))
- }
- if s.SshPublicKeyId == nil {
- invalidParams.Add(request.NewErrParamRequired("SshPublicKeyId"))
- }
- if s.UserName == nil {
- invalidParams.Add(request.NewErrParamRequired("UserName"))
- }
- if invalidParams.Len() > 0 {
- return invalidParams
- }
- return nil
- }
- // SetServerId sets the ServerId field's value.
- func (s *DeleteSshPublicKeyInput) SetServerId(v string) *DeleteSshPublicKeyInput {
- s.ServerId = &v
- return s
- }
- // SetSshPublicKeyId sets the SshPublicKeyId field's value.
- func (s *DeleteSshPublicKeyInput) SetSshPublicKeyId(v string) *DeleteSshPublicKeyInput {
- s.SshPublicKeyId = &v
- return s
- }
- // SetUserName sets the UserName field's value.
- func (s *DeleteSshPublicKeyInput) SetUserName(v string) *DeleteSshPublicKeyInput {
- s.UserName = &v
- return s
- }
- type DeleteSshPublicKeyOutput struct {
- _ struct{} `type:"structure"`
- }
- // String returns the string representation
- func (s DeleteSshPublicKeyOutput) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s DeleteSshPublicKeyOutput) GoString() string {
- return s.String()
- }
- type DeleteUserInput struct {
- _ struct{} `type:"structure"`
- // A system-assigned unique identifier for an SFTP server instance that has
- // the user assigned to it.
- //
- // ServerId is a required field
- ServerId *string `type:"string" required:"true"`
- // A unique string that identifies a user that is being deleted from the server.
- //
- // UserName is a required field
- UserName *string `type:"string" required:"true"`
- }
- // String returns the string representation
- func (s DeleteUserInput) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s DeleteUserInput) GoString() string {
- return s.String()
- }
- // Validate inspects the fields of the type to determine if they are valid.
- func (s *DeleteUserInput) Validate() error {
- invalidParams := request.ErrInvalidParams{Context: "DeleteUserInput"}
- if s.ServerId == nil {
- invalidParams.Add(request.NewErrParamRequired("ServerId"))
- }
- if s.UserName == nil {
- invalidParams.Add(request.NewErrParamRequired("UserName"))
- }
- if invalidParams.Len() > 0 {
- return invalidParams
- }
- return nil
- }
- // SetServerId sets the ServerId field's value.
- func (s *DeleteUserInput) SetServerId(v string) *DeleteUserInput {
- s.ServerId = &v
- return s
- }
- // SetUserName sets the UserName field's value.
- func (s *DeleteUserInput) SetUserName(v string) *DeleteUserInput {
- s.UserName = &v
- return s
- }
- type DeleteUserOutput struct {
- _ struct{} `type:"structure"`
- }
- // String returns the string representation
- func (s DeleteUserOutput) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s DeleteUserOutput) GoString() string {
- return s.String()
- }
- type DescribeServerInput struct {
- _ struct{} `type:"structure"`
- // A system-assigned unique identifier for an SFTP server.
- //
- // ServerId is a required field
- ServerId *string `type:"string" required:"true"`
- }
- // String returns the string representation
- func (s DescribeServerInput) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s DescribeServerInput) GoString() string {
- return s.String()
- }
- // Validate inspects the fields of the type to determine if they are valid.
- func (s *DescribeServerInput) Validate() error {
- invalidParams := request.ErrInvalidParams{Context: "DescribeServerInput"}
- if s.ServerId == nil {
- invalidParams.Add(request.NewErrParamRequired("ServerId"))
- }
- if invalidParams.Len() > 0 {
- return invalidParams
- }
- return nil
- }
- // SetServerId sets the ServerId field's value.
- func (s *DescribeServerInput) SetServerId(v string) *DescribeServerInput {
- s.ServerId = &v
- return s
- }
- type DescribeServerOutput struct {
- _ struct{} `type:"structure"`
- // An array containing the properties of the server with the ServerID you specified.
- //
- // Server is a required field
- Server *DescribedServer `type:"structure" required:"true"`
- }
- // String returns the string representation
- func (s DescribeServerOutput) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s DescribeServerOutput) GoString() string {
- return s.String()
- }
- // SetServer sets the Server field's value.
- func (s *DescribeServerOutput) SetServer(v *DescribedServer) *DescribeServerOutput {
- s.Server = v
- return s
- }
- type DescribeUserInput struct {
- _ struct{} `type:"structure"`
- // A system-assigned unique identifier for an SFTP server that has this user
- // assigned.
- //
- // ServerId is a required field
- ServerId *string `type:"string" required:"true"`
- // The name of the user assigned to one or more servers. User names are part
- // of the sign-in credentials to use the AWS Transfer service and perform file
- // transfer tasks.
- //
- // UserName is a required field
- UserName *string `type:"string" required:"true"`
- }
- // String returns the string representation
- func (s DescribeUserInput) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s DescribeUserInput) GoString() string {
- return s.String()
- }
- // Validate inspects the fields of the type to determine if they are valid.
- func (s *DescribeUserInput) Validate() error {
- invalidParams := request.ErrInvalidParams{Context: "DescribeUserInput"}
- if s.ServerId == nil {
- invalidParams.Add(request.NewErrParamRequired("ServerId"))
- }
- if s.UserName == nil {
- invalidParams.Add(request.NewErrParamRequired("UserName"))
- }
- if invalidParams.Len() > 0 {
- return invalidParams
- }
- return nil
- }
- // SetServerId sets the ServerId field's value.
- func (s *DescribeUserInput) SetServerId(v string) *DescribeUserInput {
- s.ServerId = &v
- return s
- }
- // SetUserName sets the UserName field's value.
- func (s *DescribeUserInput) SetUserName(v string) *DescribeUserInput {
- s.UserName = &v
- return s
- }
- type DescribeUserOutput struct {
- _ struct{} `type:"structure"`
- // A system-assigned unique identifier for an SFTP server that has this user
- // assigned.
- //
- // ServerId is a required field
- ServerId *string `type:"string" required:"true"`
- // An array containing the properties of the user account for the ServerID value
- // that you specified.
- //
- // User is a required field
- User *DescribedUser `type:"structure" required:"true"`
- }
- // String returns the string representation
- func (s DescribeUserOutput) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s DescribeUserOutput) GoString() string {
- return s.String()
- }
- // SetServerId sets the ServerId field's value.
- func (s *DescribeUserOutput) SetServerId(v string) *DescribeUserOutput {
- s.ServerId = &v
- return s
- }
- // SetUser sets the User field's value.
- func (s *DescribeUserOutput) SetUser(v *DescribedUser) *DescribeUserOutput {
- s.User = v
- return s
- }
- // Describe the properties of the server that was specified. Information returned
- // includes: the server Amazon Resource Name (ARN), the authentication configuration
- // and type, the logging role, server Id and state, and assigned tags or metadata.
- type DescribedServer struct {
- _ struct{} `type:"structure"`
- // Specifies the unique Amazon Resource Name (ARN) for the server to be described.
- //
- // Arn is a required field
- Arn *string `min:"20" type:"string" required:"true"`
- // Specifies information to call a customer-supplied authentication API. This
- // field is not populated when the IdentityProviderType of the server is SERVICE_MANAGED>.
- IdentityProviderDetails *IdentityProviderDetails `type:"structure"`
- // This property defines the mode of authentication method enabled for this
- // service. A value of SERVICE_MANAGED, means that you are using this Server
- // to store and access SFTP user credentials within the service. A value of
- // API_GATEWAY indicates that you have integrated an API Gateway endpoint that
- // will be invoked for authenticating your user into the service.
- IdentityProviderType *string `type:"string" enum:"IdentityProviderType"`
- // This property is an AWS Identity and Access Management (IAM) entity that
- // allows the server to turn on Amazon CloudWatch logging for Amazon S3 events.
- // When set, user activity can be view in your CloudWatch logs.
- LoggingRole *string `type:"string"`
- // This property is a unique system assigned identifier for the SFTP server
- // that you instantiate.
- ServerId *string `type:"string"`
- // The condition of the SFTP server for the server that was described. A value
- // of ONLINE indicates that the server can accept jobs and transfer files. A
- // State value of OFFLINE means that the server cannot perform file transfer
- // operations.
- //
- // The states of STARTING and STOPPING indicated that the server is in an intermediate
- // state, either not fully able to respond, or not fully offline. The values
- // of START_FAILED or STOP_FAILED can indicate an error condition.
- State *string `type:"string" enum:"State"`
- // This property contains the key-value pairs that you can use to search for
- // and group servers that were assigned to the server that was described.
- Tags []*Tag `min:"1" type:"list"`
- // The number of users that are assigned to the SFTP server you specified with
- // the ServerId.
- UserCount *int64 `type:"integer"`
- }
- // String returns the string representation
- func (s DescribedServer) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s DescribedServer) GoString() string {
- return s.String()
- }
- // SetArn sets the Arn field's value.
- func (s *DescribedServer) SetArn(v string) *DescribedServer {
- s.Arn = &v
- return s
- }
- // SetIdentityProviderDetails sets the IdentityProviderDetails field's value.
- func (s *DescribedServer) SetIdentityProviderDetails(v *IdentityProviderDetails) *DescribedServer {
- s.IdentityProviderDetails = v
- return s
- }
- // SetIdentityProviderType sets the IdentityProviderType field's value.
- func (s *DescribedServer) SetIdentityProviderType(v string) *DescribedServer {
- s.IdentityProviderType = &v
- return s
- }
- // SetLoggingRole sets the LoggingRole field's value.
- func (s *DescribedServer) SetLoggingRole(v string) *DescribedServer {
- s.LoggingRole = &v
- return s
- }
- // SetServerId sets the ServerId field's value.
- func (s *DescribedServer) SetServerId(v string) *DescribedServer {
- s.ServerId = &v
- return s
- }
- // SetState sets the State field's value.
- func (s *DescribedServer) SetState(v string) *DescribedServer {
- s.State = &v
- return s
- }
- // SetTags sets the Tags field's value.
- func (s *DescribedServer) SetTags(v []*Tag) *DescribedServer {
- s.Tags = v
- return s
- }
- // SetUserCount sets the UserCount field's value.
- func (s *DescribedServer) SetUserCount(v int64) *DescribedServer {
- s.UserCount = &v
- return s
- }
- // Returns properties of the user that you wish to describe.
- type DescribedUser struct {
- _ struct{} `type:"structure"`
- // This property contains the unique Amazon Resource Name (ARN) for the user
- // that was requested to be described.
- //
- // Arn is a required field
- Arn *string `min:"20" type:"string" required:"true"`
- // This property specifies the landing directory (or folder) which is the location
- // that files are written to or read from in an Amazon S3 bucket for the described
- // user. An example would be: /bucket_name/home/username.
- HomeDirectory *string `type:"string"`
- // Specifies the name of the policy in use for the described user.
- Policy *string `type:"string"`
- // This property specifies the IAM role that controls your user’s access to
- // your Amazon S3 bucket. The policies attached to this role will determine
- // the level of access you want to provide your users when transferring files
- // into and out of your Amazon S3 bucket or buckets. The IAM role should also
- // contain a trust relationship that allows the SFTP server to access your resources
- // when servicing your SFTP user’s transfer requests.
- Role *string `type:"string"`
- // This property contains the public key portion of the Secure Shell (SSH) keys
- // stored for the described user.
- SshPublicKeys []*SshPublicKey `type:"list"`
- // This property contains the key-value pairs for the user requested. Tag can
- // be used to search for and group users for a variety of purposes.
- Tags []*Tag `min:"1" type:"list"`
- // This property is the name of the user that was requested to be described.
- // User names are used for authentication purposes. This is the string that
- // will be used by your user when they log in to your SFTP server.
- UserName *string `type:"string"`
- }
- // String returns the string representation
- func (s DescribedUser) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s DescribedUser) GoString() string {
- return s.String()
- }
- // SetArn sets the Arn field's value.
- func (s *DescribedUser) SetArn(v string) *DescribedUser {
- s.Arn = &v
- return s
- }
- // SetHomeDirectory sets the HomeDirectory field's value.
- func (s *DescribedUser) SetHomeDirectory(v string) *DescribedUser {
- s.HomeDirectory = &v
- return s
- }
- // SetPolicy sets the Policy field's value.
- func (s *DescribedUser) SetPolicy(v string) *DescribedUser {
- s.Policy = &v
- return s
- }
- // SetRole sets the Role field's value.
- func (s *DescribedUser) SetRole(v string) *DescribedUser {
- s.Role = &v
- return s
- }
- // SetSshPublicKeys sets the SshPublicKeys field's value.
- func (s *DescribedUser) SetSshPublicKeys(v []*SshPublicKey) *DescribedUser {
- s.SshPublicKeys = v
- return s
- }
- // SetTags sets the Tags field's value.
- func (s *DescribedUser) SetTags(v []*Tag) *DescribedUser {
- s.Tags = v
- return s
- }
- // SetUserName sets the UserName field's value.
- func (s *DescribedUser) SetUserName(v string) *DescribedUser {
- s.UserName = &v
- return s
- }
- // Returns information related to the type of user authentication that is in
- // use for a server's users. A server can only have one method of authentication.
- type IdentityProviderDetails struct {
- _ struct{} `type:"structure"`
- // The Role parameter provides the type of InvocationRole used to authenticate
- // the user account.
- InvocationRole *string `type:"string"`
- // The IdentityProviderDetail parameter contains the location of the service
- // endpoint used to authenticate users.
- Url *string `type:"string"`
- }
- // String returns the string representation
- func (s IdentityProviderDetails) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s IdentityProviderDetails) GoString() string {
- return s.String()
- }
- // SetInvocationRole sets the InvocationRole field's value.
- func (s *IdentityProviderDetails) SetInvocationRole(v string) *IdentityProviderDetails {
- s.InvocationRole = &v
- return s
- }
- // SetUrl sets the Url field's value.
- func (s *IdentityProviderDetails) SetUrl(v string) *IdentityProviderDetails {
- s.Url = &v
- return s
- }
- type ImportSshPublicKeyInput struct {
- _ struct{} `type:"structure"`
- // A system-assigned unique identifier for an SFTP server.
- //
- // ServerId is a required field
- ServerId *string `type:"string" required:"true"`
- // The public key portion of an SSH key pair.
- //
- // SshPublicKeyBody is a required field
- SshPublicKeyBody *string `type:"string" required:"true"`
- // The name of the user account that is assigned to one or more servers.
- //
- // UserName is a required field
- UserName *string `type:"string" required:"true"`
- }
- // String returns the string representation
- func (s ImportSshPublicKeyInput) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s ImportSshPublicKeyInput) GoString() string {
- return s.String()
- }
- // Validate inspects the fields of the type to determine if they are valid.
- func (s *ImportSshPublicKeyInput) Validate() error {
- invalidParams := request.ErrInvalidParams{Context: "ImportSshPublicKeyInput"}
- if s.ServerId == nil {
- invalidParams.Add(request.NewErrParamRequired("ServerId"))
- }
- if s.SshPublicKeyBody == nil {
- invalidParams.Add(request.NewErrParamRequired("SshPublicKeyBody"))
- }
- if s.UserName == nil {
- invalidParams.Add(request.NewErrParamRequired("UserName"))
- }
- if invalidParams.Len() > 0 {
- return invalidParams
- }
- return nil
- }
- // SetServerId sets the ServerId field's value.
- func (s *ImportSshPublicKeyInput) SetServerId(v string) *ImportSshPublicKeyInput {
- s.ServerId = &v
- return s
- }
- // SetSshPublicKeyBody sets the SshPublicKeyBody field's value.
- func (s *ImportSshPublicKeyInput) SetSshPublicKeyBody(v string) *ImportSshPublicKeyInput {
- s.SshPublicKeyBody = &v
- return s
- }
- // SetUserName sets the UserName field's value.
- func (s *ImportSshPublicKeyInput) SetUserName(v string) *ImportSshPublicKeyInput {
- s.UserName = &v
- return s
- }
- // This response identifies the user, server they belong to, and the identifier
- // of the SSH public key associated with that user. A user can have more than
- // one key on each server that they are associate with.
- type ImportSshPublicKeyOutput struct {
- _ struct{} `type:"structure"`
- // A system-assigned unique identifier for an SFTP server.
- //
- // ServerId is a required field
- ServerId *string `type:"string" required:"true"`
- // This identifier is the name given to a public key by the system that was
- // imported.
- //
- // SshPublicKeyId is a required field
- SshPublicKeyId *string `type:"string" required:"true"`
- // A user name assigned to the ServerID value that you specified.
- //
- // UserName is a required field
- UserName *string `type:"string" required:"true"`
- }
- // String returns the string representation
- func (s ImportSshPublicKeyOutput) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s ImportSshPublicKeyOutput) GoString() string {
- return s.String()
- }
- // SetServerId sets the ServerId field's value.
- func (s *ImportSshPublicKeyOutput) SetServerId(v string) *ImportSshPublicKeyOutput {
- s.ServerId = &v
- return s
- }
- // SetSshPublicKeyId sets the SshPublicKeyId field's value.
- func (s *ImportSshPublicKeyOutput) SetSshPublicKeyId(v string) *ImportSshPublicKeyOutput {
- s.SshPublicKeyId = &v
- return s
- }
- // SetUserName sets the UserName field's value.
- func (s *ImportSshPublicKeyOutput) SetUserName(v string) *ImportSshPublicKeyOutput {
- s.UserName = &v
- return s
- }
- type ListServersInput struct {
- _ struct{} `type:"structure"`
- // Specifies the number of servers to return as a response to the ListServers
- // query.
- MaxResults *int64 `min:"1" type:"integer"`
- // When additional results are obtained from the ListServers command, a NextToken
- // parameter is returned in the output. You can then pass the NextToken parameter
- // in a subsequent command to continue listing additional servers.
- NextToken *string `min:"1" type:"string"`
- }
- // String returns the string representation
- func (s ListServersInput) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s ListServersInput) GoString() string {
- return s.String()
- }
- // Validate inspects the fields of the type to determine if they are valid.
- func (s *ListServersInput) Validate() error {
- invalidParams := request.ErrInvalidParams{Context: "ListServersInput"}
- if s.MaxResults != nil && *s.MaxResults < 1 {
- invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1))
- }
- if s.NextToken != nil && len(*s.NextToken) < 1 {
- invalidParams.Add(request.NewErrParamMinLen("NextToken", 1))
- }
- if invalidParams.Len() > 0 {
- return invalidParams
- }
- return nil
- }
- // SetMaxResults sets the MaxResults field's value.
- func (s *ListServersInput) SetMaxResults(v int64) *ListServersInput {
- s.MaxResults = &v
- return s
- }
- // SetNextToken sets the NextToken field's value.
- func (s *ListServersInput) SetNextToken(v string) *ListServersInput {
- s.NextToken = &v
- return s
- }
- type ListServersOutput struct {
- _ struct{} `type:"structure"`
- // When you can get additional results from the ListServers operation, a NextToken
- // parameter is returned in the output. In a following command, you can pass
- // in the NextToken parameter to continue listing additional servers.
- NextToken *string `min:"1" type:"string"`
- // An array of servers that were listed.
- //
- // Servers is a required field
- Servers []*ListedServer `type:"list" required:"true"`
- }
- // String returns the string representation
- func (s ListServersOutput) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s ListServersOutput) GoString() string {
- return s.String()
- }
- // SetNextToken sets the NextToken field's value.
- func (s *ListServersOutput) SetNextToken(v string) *ListServersOutput {
- s.NextToken = &v
- return s
- }
- // SetServers sets the Servers field's value.
- func (s *ListServersOutput) SetServers(v []*ListedServer) *ListServersOutput {
- s.Servers = v
- return s
- }
- type ListTagsForResourceInput struct {
- _ struct{} `type:"structure"`
- // Requests the tags associated with a particular Amazon Resource Name (ARN).
- // An ARN is an identifier for a specific AWS resource, such as a server, user,
- // or role.
- //
- // Arn is a required field
- Arn *string `min:"20" type:"string" required:"true"`
- MaxResults *int64 `min:"1" type:"integer"`
- NextToken *string `min:"1" type:"string"`
- }
- // String returns the string representation
- func (s ListTagsForResourceInput) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s ListTagsForResourceInput) GoString() string {
- return s.String()
- }
- // Validate inspects the fields of the type to determine if they are valid.
- func (s *ListTagsForResourceInput) Validate() error {
- invalidParams := request.ErrInvalidParams{Context: "ListTagsForResourceInput"}
- if s.Arn == nil {
- invalidParams.Add(request.NewErrParamRequired("Arn"))
- }
- if s.Arn != nil && len(*s.Arn) < 20 {
- invalidParams.Add(request.NewErrParamMinLen("Arn", 20))
- }
- if s.MaxResults != nil && *s.MaxResults < 1 {
- invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1))
- }
- if s.NextToken != nil && len(*s.NextToken) < 1 {
- invalidParams.Add(request.NewErrParamMinLen("NextToken", 1))
- }
- if invalidParams.Len() > 0 {
- return invalidParams
- }
- return nil
- }
- // SetArn sets the Arn field's value.
- func (s *ListTagsForResourceInput) SetArn(v string) *ListTagsForResourceInput {
- s.Arn = &v
- return s
- }
- // SetMaxResults sets the MaxResults field's value.
- func (s *ListTagsForResourceInput) SetMaxResults(v int64) *ListTagsForResourceInput {
- s.MaxResults = &v
- return s
- }
- // SetNextToken sets the NextToken field's value.
- func (s *ListTagsForResourceInput) SetNextToken(v string) *ListTagsForResourceInput {
- s.NextToken = &v
- return s
- }
- type ListTagsForResourceOutput struct {
- _ struct{} `type:"structure"`
- // This value is the ARN you specified to list the tags of.
- Arn *string `min:"20" type:"string"`
- NextToken *string `min:"1" type:"string"`
- // Key-value pairs that are assigned to a resource, usually for the purpose
- // of grouping and searching for items. Tags are metadata that you define that
- // you can use for any purpose.
- Tags []*Tag `min:"1" type:"list"`
- }
- // String returns the string representation
- func (s ListTagsForResourceOutput) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s ListTagsForResourceOutput) GoString() string {
- return s.String()
- }
- // SetArn sets the Arn field's value.
- func (s *ListTagsForResourceOutput) SetArn(v string) *ListTagsForResourceOutput {
- s.Arn = &v
- return s
- }
- // SetNextToken sets the NextToken field's value.
- func (s *ListTagsForResourceOutput) SetNextToken(v string) *ListTagsForResourceOutput {
- s.NextToken = &v
- return s
- }
- // SetTags sets the Tags field's value.
- func (s *ListTagsForResourceOutput) SetTags(v []*Tag) *ListTagsForResourceOutput {
- s.Tags = v
- return s
- }
- type ListUsersInput struct {
- _ struct{} `type:"structure"`
- // Specifies the number of users to return as a response to the ListUsers request.
- MaxResults *int64 `min:"1" type:"integer"`
- // When you can get additional results from the ListUsersListUsers call, a NextToken
- // parameter is returned in the output. You can then pass in a subsequent command
- // the NextToken parameter to continue listing additional users.
- NextToken *string `min:"1" type:"string"`
- // A system-assigned unique identifier for a Secure File Transfer Protocol (SFTP)
- // server that has users are assigned to it.
- //
- // ServerId is a required field
- ServerId *string `type:"string" required:"true"`
- }
- // String returns the string representation
- func (s ListUsersInput) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s ListUsersInput) GoString() string {
- return s.String()
- }
- // Validate inspects the fields of the type to determine if they are valid.
- func (s *ListUsersInput) Validate() error {
- invalidParams := request.ErrInvalidParams{Context: "ListUsersInput"}
- if s.MaxResults != nil && *s.MaxResults < 1 {
- invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1))
- }
- if s.NextToken != nil && len(*s.NextToken) < 1 {
- invalidParams.Add(request.NewErrParamMinLen("NextToken", 1))
- }
- if s.ServerId == nil {
- invalidParams.Add(request.NewErrParamRequired("ServerId"))
- }
- if invalidParams.Len() > 0 {
- return invalidParams
- }
- return nil
- }
- // SetMaxResults sets the MaxResults field's value.
- func (s *ListUsersInput) SetMaxResults(v int64) *ListUsersInput {
- s.MaxResults = &v
- return s
- }
- // SetNextToken sets the NextToken field's value.
- func (s *ListUsersInput) SetNextToken(v string) *ListUsersInput {
- s.NextToken = &v
- return s
- }
- // SetServerId sets the ServerId field's value.
- func (s *ListUsersInput) SetServerId(v string) *ListUsersInput {
- s.ServerId = &v
- return s
- }
- type ListUsersOutput struct {
- _ struct{} `type:"structure"`
- // When you can get additional results from the ListUsers call, a NextToken
- // parameter is returned in the output. You can then pass in a subsequent command
- // the NextToken parameter to continue listing additional users.
- NextToken *string `min:"1" type:"string"`
- // A system-assigned unique identifier for an SFTP server that the users are
- // assigned to.
- //
- // ServerId is a required field
- ServerId *string `type:"string" required:"true"`
- // Returns the user accounts and their properties for the ServerId value that
- // you specify.
- //
- // Users is a required field
- Users []*ListedUser `type:"list" required:"true"`
- }
- // String returns the string representation
- func (s ListUsersOutput) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s ListUsersOutput) GoString() string {
- return s.String()
- }
- // SetNextToken sets the NextToken field's value.
- func (s *ListUsersOutput) SetNextToken(v string) *ListUsersOutput {
- s.NextToken = &v
- return s
- }
- // SetServerId sets the ServerId field's value.
- func (s *ListUsersOutput) SetServerId(v string) *ListUsersOutput {
- s.ServerId = &v
- return s
- }
- // SetUsers sets the Users field's value.
- func (s *ListUsersOutput) SetUsers(v []*ListedUser) *ListUsersOutput {
- s.Users = v
- return s
- }
- // Returns properties of the server that was specified.
- type ListedServer struct {
- _ struct{} `type:"structure"`
- // The unique Amazon Resource Name (ARN) for the server to be listed.
- //
- // Arn is a required field
- Arn *string `min:"20" type:"string" required:"true"`
- // The authentication method used to validate a user for the server that was
- // specified. listed. This can include Secure Shell (SSH), user name and password
- // combinations, or your own custom authentication method. Valid values include
- // SERVICE_MANAGED or API_GATEWAY.
- IdentityProviderType *string `type:"string" enum:"IdentityProviderType"`
- // The AWS Identity and Access Management entity that allows the server to turn
- // on Amazon CloudWatch logging.
- LoggingRole *string `type:"string"`
- // This value is the unique system assigned identifier for the SFTP servers
- // that were listed.
- ServerId *string `type:"string"`
- // This property describes the condition of the SFTP server for the server that
- // was described. A value of ONLINE> indicates that the server can accept jobs
- // and transfer files. A State value of OFFLINE means that the server cannot
- // perform file transfer operations.
- //
- // The states of STARTING and STOPPING indicated that the server is in an intermediate
- // state, either not fully able to respond, or not fully offline. The values
- // of START_FAILED or STOP_FAILED can indicate an error condition.
- State *string `type:"string" enum:"State"`
- // This property is a numeric value that indicates the number of users that
- // are assigned to the SFTP server you specified with the ServerId.
- UserCount *int64 `type:"integer"`
- }
- // String returns the string representation
- func (s ListedServer) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s ListedServer) GoString() string {
- return s.String()
- }
- // SetArn sets the Arn field's value.
- func (s *ListedServer) SetArn(v string) *ListedServer {
- s.Arn = &v
- return s
- }
- // SetIdentityProviderType sets the IdentityProviderType field's value.
- func (s *ListedServer) SetIdentityProviderType(v string) *ListedServer {
- s.IdentityProviderType = &v
- return s
- }
- // SetLoggingRole sets the LoggingRole field's value.
- func (s *ListedServer) SetLoggingRole(v string) *ListedServer {
- s.LoggingRole = &v
- return s
- }
- // SetServerId sets the ServerId field's value.
- func (s *ListedServer) SetServerId(v string) *ListedServer {
- s.ServerId = &v
- return s
- }
- // SetState sets the State field's value.
- func (s *ListedServer) SetState(v string) *ListedServer {
- s.State = &v
- return s
- }
- // SetUserCount sets the UserCount field's value.
- func (s *ListedServer) SetUserCount(v int64) *ListedServer {
- s.UserCount = &v
- return s
- }
- // Returns properties of the user that you specify.
- type ListedUser struct {
- _ struct{} `type:"structure"`
- // This property is the unique Amazon Resource Name (ARN) for the user that
- // you wish to learn about.
- //
- // Arn is a required field
- Arn *string `min:"20" type:"string" required:"true"`
- // This value specifies the location that files are written to or read from
- // an Amazon S3 bucket for the user you specify by their ARN.
- HomeDirectory *string `type:"string"`
- // The role in use by this user. A role is an AWS Identity and Access Management
- // (IAM) entity that in this case allows the SFTP server to act on a user's
- // behalf. It allows the server to inherit the trust relationship that enables
- // that user to perform file operations to their Amazon S3 bucket.
- Role *string `type:"string"`
- // This value is the number of SSH public keys stored for the user you specified.
- SshPublicKeyCount *int64 `type:"integer"`
- // The name of the user whose ARN was specified. User names are used for authentication
- // purposes.
- UserName *string `type:"string"`
- }
- // String returns the string representation
- func (s ListedUser) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s ListedUser) GoString() string {
- return s.String()
- }
- // SetArn sets the Arn field's value.
- func (s *ListedUser) SetArn(v string) *ListedUser {
- s.Arn = &v
- return s
- }
- // SetHomeDirectory sets the HomeDirectory field's value.
- func (s *ListedUser) SetHomeDirectory(v string) *ListedUser {
- s.HomeDirectory = &v
- return s
- }
- // SetRole sets the Role field's value.
- func (s *ListedUser) SetRole(v string) *ListedUser {
- s.Role = &v
- return s
- }
- // SetSshPublicKeyCount sets the SshPublicKeyCount field's value.
- func (s *ListedUser) SetSshPublicKeyCount(v int64) *ListedUser {
- s.SshPublicKeyCount = &v
- return s
- }
- // SetUserName sets the UserName field's value.
- func (s *ListedUser) SetUserName(v string) *ListedUser {
- s.UserName = &v
- return s
- }
- // Provides information about the public Secure Shell (SSH) key that is associated
- // with a user account for a specific server (as identified by ServerId). The
- // information returned includes the date the key was imported, the public key
- // contents, and the public key ID. A user can store more than one SSH public
- // key associated with their user name on a specific SFTP server.
- type SshPublicKey struct {
- _ struct{} `type:"structure"`
- // The date that the public key was added to the user account.
- //
- // DateImported is a required field
- DateImported *time.Time `type:"timestamp" required:"true"`
- // The content of the SSH public key as specified by the PublicKeyId.
- //
- // SshPublicKeyBody is a required field
- SshPublicKeyBody *string `type:"string" required:"true"`
- // The SshPublicKeyId parameter contains the identifier of the public key.
- //
- // SshPublicKeyId is a required field
- SshPublicKeyId *string `type:"string" required:"true"`
- }
- // String returns the string representation
- func (s SshPublicKey) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s SshPublicKey) GoString() string {
- return s.String()
- }
- // SetDateImported sets the DateImported field's value.
- func (s *SshPublicKey) SetDateImported(v time.Time) *SshPublicKey {
- s.DateImported = &v
- return s
- }
- // SetSshPublicKeyBody sets the SshPublicKeyBody field's value.
- func (s *SshPublicKey) SetSshPublicKeyBody(v string) *SshPublicKey {
- s.SshPublicKeyBody = &v
- return s
- }
- // SetSshPublicKeyId sets the SshPublicKeyId field's value.
- func (s *SshPublicKey) SetSshPublicKeyId(v string) *SshPublicKey {
- s.SshPublicKeyId = &v
- return s
- }
- type StartServerInput struct {
- _ struct{} `type:"structure"`
- // A system-assigned unique identifier for an SFTP server that you start.
- //
- // ServerId is a required field
- ServerId *string `type:"string" required:"true"`
- }
- // String returns the string representation
- func (s StartServerInput) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s StartServerInput) GoString() string {
- return s.String()
- }
- // Validate inspects the fields of the type to determine if they are valid.
- func (s *StartServerInput) Validate() error {
- invalidParams := request.ErrInvalidParams{Context: "StartServerInput"}
- if s.ServerId == nil {
- invalidParams.Add(request.NewErrParamRequired("ServerId"))
- }
- if invalidParams.Len() > 0 {
- return invalidParams
- }
- return nil
- }
- // SetServerId sets the ServerId field's value.
- func (s *StartServerInput) SetServerId(v string) *StartServerInput {
- s.ServerId = &v
- return s
- }
- type StartServerOutput struct {
- _ struct{} `type:"structure"`
- }
- // String returns the string representation
- func (s StartServerOutput) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s StartServerOutput) GoString() string {
- return s.String()
- }
- type StopServerInput struct {
- _ struct{} `type:"structure"`
- // A system-assigned unique identifier for an SFTP server that you stopped.
- //
- // ServerId is a required field
- ServerId *string `type:"string" required:"true"`
- }
- // String returns the string representation
- func (s StopServerInput) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s StopServerInput) GoString() string {
- return s.String()
- }
- // Validate inspects the fields of the type to determine if they are valid.
- func (s *StopServerInput) Validate() error {
- invalidParams := request.ErrInvalidParams{Context: "StopServerInput"}
- if s.ServerId == nil {
- invalidParams.Add(request.NewErrParamRequired("ServerId"))
- }
- if invalidParams.Len() > 0 {
- return invalidParams
- }
- return nil
- }
- // SetServerId sets the ServerId field's value.
- func (s *StopServerInput) SetServerId(v string) *StopServerInput {
- s.ServerId = &v
- return s
- }
- type StopServerOutput struct {
- _ struct{} `type:"structure"`
- }
- // String returns the string representation
- func (s StopServerOutput) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s StopServerOutput) GoString() string {
- return s.String()
- }
- // Creates a key-value pair for a specific resource. Tags are metadata that
- // you can use to search for and group a resource for various purposes. You
- // can apply tags to servers, users, and roles. A tag key can take more than
- // one value. For example, to group servers for accounting purposes, you might
- // create a tag called Group and assign the values Research and Accounting to
- // that group.
- type Tag struct {
- _ struct{} `type:"structure"`
- // The name assigned to the tag that you create.
- //
- // Key is a required field
- Key *string `type:"string" required:"true"`
- // This property contains one or more values that you assigned to the key name
- // you create.
- //
- // Value is a required field
- Value *string `type:"string" required:"true"`
- }
- // 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()
- }
- // Validate inspects the fields of the type to determine if they are valid.
- func (s *Tag) Validate() error {
- invalidParams := request.ErrInvalidParams{Context: "Tag"}
- if s.Key == nil {
- invalidParams.Add(request.NewErrParamRequired("Key"))
- }
- if s.Value == nil {
- invalidParams.Add(request.NewErrParamRequired("Value"))
- }
- if invalidParams.Len() > 0 {
- return invalidParams
- }
- return nil
- }
- // SetKey sets the Key field's value.
- func (s *Tag) SetKey(v string) *Tag {
- s.Key = &v
- return s
- }
- // SetValue sets the Value field's value.
- func (s *Tag) SetValue(v string) *Tag {
- s.Value = &v
- return s
- }
- type TagResourceInput struct {
- _ struct{} `type:"structure"`
- // An Amazon Resource Name (ARN) for a specific AWS resource, such as a server,
- // user, or role.
- //
- // Arn is a required field
- Arn *string `min:"20" type:"string" required:"true"`
- // Key-value pairs assigned to ARNs that you can use to group and search for
- // resources by type. You can attach this metadata to user accounts for any
- // purpose.
- //
- // Tags is a required field
- Tags []*Tag `min:"1" type:"list" required:"true"`
- }
- // String returns the string representation
- func (s TagResourceInput) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s TagResourceInput) GoString() string {
- return s.String()
- }
- // Validate inspects the fields of the type to determine if they are valid.
- func (s *TagResourceInput) Validate() error {
- invalidParams := request.ErrInvalidParams{Context: "TagResourceInput"}
- if s.Arn == nil {
- invalidParams.Add(request.NewErrParamRequired("Arn"))
- }
- if s.Arn != nil && len(*s.Arn) < 20 {
- invalidParams.Add(request.NewErrParamMinLen("Arn", 20))
- }
- if s.Tags == nil {
- invalidParams.Add(request.NewErrParamRequired("Tags"))
- }
- if s.Tags != nil && len(s.Tags) < 1 {
- invalidParams.Add(request.NewErrParamMinLen("Tags", 1))
- }
- if s.Tags != nil {
- for i, v := range s.Tags {
- if v == nil {
- continue
- }
- if err := v.Validate(); err != nil {
- invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Tags", i), err.(request.ErrInvalidParams))
- }
- }
- }
- if invalidParams.Len() > 0 {
- return invalidParams
- }
- return nil
- }
- // SetArn sets the Arn field's value.
- func (s *TagResourceInput) SetArn(v string) *TagResourceInput {
- s.Arn = &v
- return s
- }
- // SetTags sets the Tags field's value.
- func (s *TagResourceInput) SetTags(v []*Tag) *TagResourceInput {
- s.Tags = v
- return s
- }
- type TagResourceOutput struct {
- _ struct{} `type:"structure"`
- }
- // String returns the string representation
- func (s TagResourceOutput) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s TagResourceOutput) GoString() string {
- return s.String()
- }
- type TestIdentityProviderInput struct {
- _ struct{} `type:"structure"`
- // A system assigned identifier for a specific server. That server's user authentication
- // method is tested with a user name and password.
- //
- // ServerId is a required field
- ServerId *string `type:"string" required:"true"`
- // This request parameter is name of the user account to be tested.
- //
- // UserName is a required field
- UserName *string `type:"string" required:"true"`
- // The password of the user account to be tested.
- UserPassword *string `type:"string"`
- }
- // String returns the string representation
- func (s TestIdentityProviderInput) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s TestIdentityProviderInput) GoString() string {
- return s.String()
- }
- // Validate inspects the fields of the type to determine if they are valid.
- func (s *TestIdentityProviderInput) Validate() error {
- invalidParams := request.ErrInvalidParams{Context: "TestIdentityProviderInput"}
- if s.ServerId == nil {
- invalidParams.Add(request.NewErrParamRequired("ServerId"))
- }
- if s.UserName == nil {
- invalidParams.Add(request.NewErrParamRequired("UserName"))
- }
- if invalidParams.Len() > 0 {
- return invalidParams
- }
- return nil
- }
- // SetServerId sets the ServerId field's value.
- func (s *TestIdentityProviderInput) SetServerId(v string) *TestIdentityProviderInput {
- s.ServerId = &v
- return s
- }
- // SetUserName sets the UserName field's value.
- func (s *TestIdentityProviderInput) SetUserName(v string) *TestIdentityProviderInput {
- s.UserName = &v
- return s
- }
- // SetUserPassword sets the UserPassword field's value.
- func (s *TestIdentityProviderInput) SetUserPassword(v string) *TestIdentityProviderInput {
- s.UserPassword = &v
- return s
- }
- type TestIdentityProviderOutput struct {
- _ struct{} `type:"structure"`
- // The result of the authorization test as a message.
- Message *string `type:"string"`
- // The HTTP status code that is the response from your API Gateway.
- //
- // StatusCode is a required field
- StatusCode *int64 `type:"integer" required:"true"`
- // The endpoint of the service used to authenticate a user.
- //
- // Url is a required field
- Url *string `type:"string" required:"true"`
- }
- // String returns the string representation
- func (s TestIdentityProviderOutput) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s TestIdentityProviderOutput) GoString() string {
- return s.String()
- }
- // SetMessage sets the Message field's value.
- func (s *TestIdentityProviderOutput) SetMessage(v string) *TestIdentityProviderOutput {
- s.Message = &v
- return s
- }
- // SetStatusCode sets the StatusCode field's value.
- func (s *TestIdentityProviderOutput) SetStatusCode(v int64) *TestIdentityProviderOutput {
- s.StatusCode = &v
- return s
- }
- // SetUrl sets the Url field's value.
- func (s *TestIdentityProviderOutput) SetUrl(v string) *TestIdentityProviderOutput {
- s.Url = &v
- return s
- }
- type UntagResourceInput struct {
- _ struct{} `type:"structure"`
- // This is the value of the resource that will have the tag removed. An Amazon
- // Resource Name (ARN) is an identifier for a specific AWS resource, such as
- // a server, user, or role.
- //
- // Arn is a required field
- Arn *string `min:"20" type:"string" required:"true"`
- // TagKeys are key-value pairs assigned to ARNs that can be used to group and
- // search for resources by type. This metadata can be attached to resources
- // for any purpose.
- //
- // TagKeys is a required field
- TagKeys []*string `min:"1" type:"list" required:"true"`
- }
- // String returns the string representation
- func (s UntagResourceInput) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s UntagResourceInput) GoString() string {
- return s.String()
- }
- // Validate inspects the fields of the type to determine if they are valid.
- func (s *UntagResourceInput) Validate() error {
- invalidParams := request.ErrInvalidParams{Context: "UntagResourceInput"}
- if s.Arn == nil {
- invalidParams.Add(request.NewErrParamRequired("Arn"))
- }
- if s.Arn != nil && len(*s.Arn) < 20 {
- invalidParams.Add(request.NewErrParamMinLen("Arn", 20))
- }
- 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
- }
- // SetArn sets the Arn field's value.
- func (s *UntagResourceInput) SetArn(v string) *UntagResourceInput {
- s.Arn = &v
- return s
- }
- // SetTagKeys sets the TagKeys field's value.
- func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput {
- s.TagKeys = v
- return s
- }
- type UntagResourceOutput struct {
- _ struct{} `type:"structure"`
- }
- // String returns the string representation
- func (s UntagResourceOutput) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s UntagResourceOutput) GoString() string {
- return s.String()
- }
- type UpdateServerInput struct {
- _ struct{} `type:"structure"`
- // This response parameter is an array containing all of the information required
- // to call a customer's authentication API method.
- IdentityProviderDetails *IdentityProviderDetails `type:"structure"`
- // Changes the AWS Identity and Access Management (IAM) role that allows Amazon
- // S3 events to be logged in Amazon CloudWatch, turning logging on or off.
- LoggingRole *string `type:"string"`
- // A system-assigned unique identifier for an SFTP server instance that the
- // user account is assigned to.
- //
- // ServerId is a required field
- ServerId *string `type:"string" required:"true"`
- }
- // String returns the string representation
- func (s UpdateServerInput) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s UpdateServerInput) GoString() string {
- return s.String()
- }
- // Validate inspects the fields of the type to determine if they are valid.
- func (s *UpdateServerInput) Validate() error {
- invalidParams := request.ErrInvalidParams{Context: "UpdateServerInput"}
- if s.ServerId == nil {
- invalidParams.Add(request.NewErrParamRequired("ServerId"))
- }
- if invalidParams.Len() > 0 {
- return invalidParams
- }
- return nil
- }
- // SetIdentityProviderDetails sets the IdentityProviderDetails field's value.
- func (s *UpdateServerInput) SetIdentityProviderDetails(v *IdentityProviderDetails) *UpdateServerInput {
- s.IdentityProviderDetails = v
- return s
- }
- // SetLoggingRole sets the LoggingRole field's value.
- func (s *UpdateServerInput) SetLoggingRole(v string) *UpdateServerInput {
- s.LoggingRole = &v
- return s
- }
- // SetServerId sets the ServerId field's value.
- func (s *UpdateServerInput) SetServerId(v string) *UpdateServerInput {
- s.ServerId = &v
- return s
- }
- type UpdateServerOutput struct {
- _ struct{} `type:"structure"`
- // A system-assigned unique identifier for an SFTP server that the user account
- // is assigned to.
- //
- // ServerId is a required field
- ServerId *string `type:"string" required:"true"`
- }
- // String returns the string representation
- func (s UpdateServerOutput) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s UpdateServerOutput) GoString() string {
- return s.String()
- }
- // SetServerId sets the ServerId field's value.
- func (s *UpdateServerOutput) SetServerId(v string) *UpdateServerOutput {
- s.ServerId = &v
- return s
- }
- type UpdateUserInput struct {
- _ struct{} `type:"structure"`
- // The HomeDirectory parameter specifies the landing directory (folder) for
- // a user when they log in to the server using their client. An example would
- // be: /home/username.
- HomeDirectory *string `type:"string"`
- // Allows you to supply a scope-down policy for your user so you can use the
- // same AWS Identity and Access Management (IAM) role across multiple users.
- // The policy scopes down users access to portions of your Amazon S3 bucket.
- // Variables you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory},
- // and ${Transfer:HomeBucket}.
- Policy *string `type:"string"`
- // The IAM role that controls your user’s access to your Amazon S3 bucket. The
- // policies attached to this role will determine the level of access you want
- // to provide your users when transferring files into and out of your Amazon
- // S3 bucket or buckets. The IAM role should also contain a trust relationship
- // that allows the Secure File Transfer Protocol (SFTP) server to access your
- // resources when servicing your SFTP user’s transfer requests.
- Role *string `type:"string"`
- // A system-assigned unique identifier for an SFTP server instance that the
- // user account is assigned to.
- //
- // ServerId is a required field
- ServerId *string `type:"string" required:"true"`
- // A unique string that identifies a user and is associated with a server as
- // specified by the ServerId. This is the string that will be used by your user
- // when they log in to your SFTP server.
- //
- // UserName is a required field
- UserName *string `type:"string" required:"true"`
- }
- // String returns the string representation
- func (s UpdateUserInput) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s UpdateUserInput) GoString() string {
- return s.String()
- }
- // Validate inspects the fields of the type to determine if they are valid.
- func (s *UpdateUserInput) Validate() error {
- invalidParams := request.ErrInvalidParams{Context: "UpdateUserInput"}
- if s.ServerId == nil {
- invalidParams.Add(request.NewErrParamRequired("ServerId"))
- }
- if s.UserName == nil {
- invalidParams.Add(request.NewErrParamRequired("UserName"))
- }
- if invalidParams.Len() > 0 {
- return invalidParams
- }
- return nil
- }
- // SetHomeDirectory sets the HomeDirectory field's value.
- func (s *UpdateUserInput) SetHomeDirectory(v string) *UpdateUserInput {
- s.HomeDirectory = &v
- return s
- }
- // SetPolicy sets the Policy field's value.
- func (s *UpdateUserInput) SetPolicy(v string) *UpdateUserInput {
- s.Policy = &v
- return s
- }
- // SetRole sets the Role field's value.
- func (s *UpdateUserInput) SetRole(v string) *UpdateUserInput {
- s.Role = &v
- return s
- }
- // SetServerId sets the ServerId field's value.
- func (s *UpdateUserInput) SetServerId(v string) *UpdateUserInput {
- s.ServerId = &v
- return s
- }
- // SetUserName sets the UserName field's value.
- func (s *UpdateUserInput) SetUserName(v string) *UpdateUserInput {
- s.UserName = &v
- return s
- }
- // UpdateUserResponse returns the user name and server identifier for the request
- // to update a user's properties.
- type UpdateUserOutput struct {
- _ struct{} `type:"structure"`
- // A system-assigned unique identifier for an SFTP server instance that the
- // user account is assigned to.
- //
- // ServerId is a required field
- ServerId *string `type:"string" required:"true"`
- // The unique identifier for a user that is assigned to the SFTP server instance
- // that was specified in the request.
- //
- // UserName is a required field
- UserName *string `type:"string" required:"true"`
- }
- // String returns the string representation
- func (s UpdateUserOutput) String() string {
- return awsutil.Prettify(s)
- }
- // GoString returns the string representation
- func (s UpdateUserOutput) GoString() string {
- return s.String()
- }
- // SetServerId sets the ServerId field's value.
- func (s *UpdateUserOutput) SetServerId(v string) *UpdateUserOutput {
- s.ServerId = &v
- return s
- }
- // SetUserName sets the UserName field's value.
- func (s *UpdateUserOutput) SetUserName(v string) *UpdateUserOutput {
- s.UserName = &v
- return s
- }
- // Returns information related to the type of user authentication that is in
- // use for a server's users. For SERVICE_MANAGED authentication, the Secure
- // Shell (SSH) public keys are stored with a user on an SFTP server instance.
- // For API_GATEWAY authentication, your custom authentication method is implemented
- // by using an API call. A server can only have one method of authentication.
- const (
- // IdentityProviderTypeServiceManaged is a IdentityProviderType enum value
- IdentityProviderTypeServiceManaged = "SERVICE_MANAGED"
- // IdentityProviderTypeApiGateway is a IdentityProviderType enum value
- IdentityProviderTypeApiGateway = "API_GATEWAY"
- )
- // Describes the condition of the SFTP server with respect to its ability to
- // perform file operations. There are six possible states: OFFLINE, ONLINE,
- // STARTING, STOPPING, START_FAILED, and STOP_FAILED.
- //
- // OFFLINE indicates that the SFTP server exists, but that it is not available
- // for file operations. ONLINE indicates that the SFTP server is available to
- // perform file operations. STARTING indicates that the SFTP server's was instantiated,
- // but the server is not yet available to perform file operations. Under normal
- // conditions, it can take a couple of minutes for an SFTP server to be completely
- // operational. Both START_FAILED and STOP_FAILED are error conditions.
- const (
- // StateOffline is a State enum value
- StateOffline = "OFFLINE"
- // StateOnline is a State enum value
- StateOnline = "ONLINE"
- // StateStarting is a State enum value
- StateStarting = "STARTING"
- // StateStopping is a State enum value
- StateStopping = "STOPPING"
- // StateStartFailed is a State enum value
- StateStartFailed = "START_FAILED"
- // StateStopFailed is a State enum value
- StateStopFailed = "STOP_FAILED"
- )
|