AWS Device Farm · 2020-02-05 · AWS Device Farm API Reference Table of Contents Welcome..... 1 Actions..... 2

AWS Device FarmAPI Reference

API Version 2015-06-23

AWS Device Farm API Reference

AWS Device Farm: API ReferenceCopyright © 2020 Amazon Web Services, Inc. and/or its affiliates. All rights reserved.

Amazon's trademarks and trade dress may not be used in connection with any product or service that is notAmazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages ordiscredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who mayor may not be affiliated with, connected to, or sponsored by Amazon.


Table of ContentsWelcome .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1Actions .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

CreateDevicePool ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

CreateInstanceProfile .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

CreateNetworkProfile .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

CreateProject ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

CreateRemoteAccessSession .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

CreateTestGridProject ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

CreateTestGridUrl ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

CreateUpload .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

API Version 2015-06-23iii


Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

CreateVPCEConfiguration .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

DeleteDevicePool ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

DeleteInstanceProfile .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

DeleteNetworkProfile .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

DeleteProject ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39

DeleteRemoteAccessSession .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

DeleteRun .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43

DeleteTestGridProject ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

DeleteUpload .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46

API Version 2015-06-23iv


Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47

DeleteVPCEConfiguration .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49

GetAccountSettings .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51

GetDevice .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54

GetDeviceInstance .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56

GetDevicePool ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58

GetDevicePoolCompatibility ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63

GetInstanceProfile .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66

GetJob .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69

GetNetworkProfile .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70

API Version 2015-06-23v


Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71

GetOfferingStatus .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73Example .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74

GetProject ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77

GetRemoteAccessSession .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80

GetRun .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83

GetSuite .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85

GetTest ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88

GetTestGridProject ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91

GetTestGridSession .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92

API Version 2015-06-23vi


Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93

GetUpload .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96

GetVPCEConfiguration .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98

InstallToRemoteAccessSession .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100

ListArtifacts ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104

ListDeviceInstances .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106

ListDevicePools ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110

ListDevices .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114

ListInstanceProfiles .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115

API Version 2015-06-23vii


Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116

ListJobs .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120

ListNetworkProfiles .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124

ListOfferingPromotions .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126

ListOfferings .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128Example .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129

ListOfferingTransactions .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131Example .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137

ListProjects ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139

ListRemoteAccessSessions .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143

ListRuns .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145

API Version 2015-06-23viii


Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147

ListSamples .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150

ListSuites .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154

ListTagsForResource .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156

ListTestGridProjects ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158

ListTestGridSessionActions .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160

ListTestGridSessionArtifacts ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163

ListTestGridSessions .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167

ListTests ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168

API Version 2015-06-23ix


Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170

ListUniqueProblems .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174

ListUploads .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178

ListVPCEConfigurations .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180

PurchaseOffering .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182Example .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183

RenewOffering .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186Example .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187

ScheduleRun .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192

StopJob .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195

StopRemoteAccessSession .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196

API Version 2015-06-23x


Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198

StopRun .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201

TagResource .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203

UntagResource .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205

UpdateDeviceInstance .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207

UpdateDevicePool ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211

UpdateInstanceProfile .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214

UpdateNetworkProfile .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218

UpdateProject ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220

API Version 2015-06-23xi


Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220

UpdateTestGridProject ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223

UpdateUpload .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227

UpdateVPCEConfiguration .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230

Data Types .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231AccountSettings .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233

Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234

Artifact ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236

Counters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238

CPU ..... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239

CreateRemoteAccessSessionConfiguration .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240

CustomerArtifactPaths .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241

Device .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245

DeviceFilter ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248

DeviceInstance .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250

DeviceMinutes .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251

DevicePool ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253

API Version 2015-06-23xii


DevicePoolCompatibilityResult ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254

DeviceSelectionConfiguration .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256

DeviceSelectionResult ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257

ExecutionConfiguration .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258

IncompatibilityMessage .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259

InstanceProfile .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261

Job .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265

ListTestGridProjectsRequest ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266

ListTestGridSessionsRequest ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268

Location .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269

MonetaryAmount .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 270Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 270See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 270

NetworkProfile .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 271Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 271See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 272

Offering .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 273Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 273See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 273

OfferingPromotion .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275

OfferingStatus .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 276Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 276See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 276

OfferingTransaction .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 277Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 277See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 277

Problem ..... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 279

ProblemDetail .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280

Project ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281

API Version 2015-06-23xiii


Radios .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 282Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 282See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 282

RecurringCharge .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283

RemoteAccessSession .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 287

Resolution .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 289Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 289See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 289

Rule .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 290Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 290See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 291

Run .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 298

Sample .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 299Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 299See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 300

ScheduleRunConfiguration .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 301Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 301See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302

ScheduleRunTest ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 303Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 303See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 305

Suite .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 306Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 306See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 308

Tag .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 309Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 309See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 309

Test ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 310Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 310See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 312

TestGridProject ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 313Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 313See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 313

TestGridSession .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 314Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 314See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 315

TestGridSessionAction .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 316Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 316See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 316

TestGridSessionArtifact ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 317Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 317See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 317

TrialMinutes .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 318Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 318See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 318

UniqueProblem ..... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 319Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 319See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 319

Upload .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 320Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 320See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 322

API Version 2015-06-23xiv


VPCEConfiguration .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 323Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 323See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 323

Common Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 325Common Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 327

API Version 2015-06-23xv


WelcomeWelcome to the AWS Device Farm API documentation, which contains APIs for:

• Testing on desktop browsers

Device Farm makes it possible for you to test your web applications on desktop browsers usingSelenium. The APIs for desktop browser testing contain TestGrid in their names. For moreinformation, see Testing Web Applications on Selenium with Device Farm.

• Testing on real mobile devices

Device Farm makes it possible for you to test apps on physical phones, tablets, and other devices in thecloud. For more information, see the Device Farm Developer Guide.

This document was last published on May 28, 2020.


https://docs.aws.amazon.com/devicefarm/latest/testgrid/

https://docs.aws.amazon.com/devicefarm/latest/developerguide/


ActionsThe following actions are supported:

• CreateDevicePool (p. 4)• CreateInstanceProfile (p. 7)• CreateNetworkProfile (p. 10)• CreateProject (p. 14)• CreateRemoteAccessSession (p. 16)• CreateTestGridProject (p. 21)• CreateTestGridUrl (p. 23)• CreateUpload (p. 25)• CreateVPCEConfiguration (p. 29)• DeleteDevicePool (p. 32)• DeleteInstanceProfile (p. 34)• DeleteNetworkProfile (p. 36)• DeleteProject (p. 38)• DeleteRemoteAccessSession (p. 40)• DeleteRun (p. 42)• DeleteTestGridProject (p. 44)• DeleteUpload (p. 46)• DeleteVPCEConfiguration (p. 48)• GetAccountSettings (p. 50)• GetDevice (p. 52)• GetDeviceInstance (p. 55)• GetDevicePool (p. 57)• GetDevicePoolCompatibility (p. 59)• GetInstanceProfile (p. 65)• GetJob (p. 67)• GetNetworkProfile (p. 70)• GetOfferingStatus (p. 72)• GetProject (p. 76)• GetRemoteAccessSession (p. 78)• GetRun (p. 81)• GetSuite (p. 84)• GetTest (p. 87)• GetTestGridProject (p. 90)• GetTestGridSession (p. 92)• GetUpload (p. 95)• GetVPCEConfiguration (p. 97)• InstallToRemoteAccessSession (p. 99)• ListArtifacts (p. 102)• ListDeviceInstances (p. 105)• ListDevicePools (p. 108)



• ListDevices (p. 111)• ListInstanceProfiles (p. 115)• ListJobs (p. 118)• ListNetworkProfiles (p. 122)• ListOfferingPromotions (p. 125)• ListOfferings (p. 127)• ListOfferingTransactions (p. 130)• ListProjects (p. 138)• ListRemoteAccessSessions (p. 141)• ListRuns (p. 145)• ListSamples (p. 149)• ListSuites (p. 152)• ListTagsForResource (p. 155)• ListTestGridProjects (p. 157)• ListTestGridSessionActions (p. 159)• ListTestGridSessionArtifacts (p. 162)• ListTestGridSessions (p. 165)• ListTests (p. 168)• ListUniqueProblems (p. 171)• ListUploads (p. 175)• ListVPCEConfigurations (p. 179)• PurchaseOffering (p. 181)• RenewOffering (p. 185)• ScheduleRun (p. 188)• StopJob (p. 193)• StopRemoteAccessSession (p. 196)• StopRun (p. 199)• TagResource (p. 202)• UntagResource (p. 204)• UpdateDeviceInstance (p. 206)• UpdateDevicePool (p. 209)• UpdateInstanceProfile (p. 212)• UpdateNetworkProfile (p. 215)• UpdateProject (p. 219)• UpdateTestGridProject (p. 222)• UpdateUpload (p. 225)• UpdateVPCEConfiguration (p. 228)


AWS Device Farm API ReferenceCreateDevicePool

CreateDevicePoolCreates a device pool.

Request Syntax{ "description": "string", "maxDevices": number, "name": "string", "projectArn": "string", "rules": [ { "attribute": "string", "operator": "string", "value": "string" } ]}

Request ParametersFor information about the parameters that are common to all actions, see CommonParameters (p. 325).

The request accepts the following data in JSON format.

description (p. 4)

The device pool's description.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 16384.

Required: NomaxDevices (p. 4)

The number of devices that Device Farm can add to your device pool. Device Farm adds devices thatare available and meet the criteria that you assign for the rules parameter. Depending on howmany devices meet these constraints, your device pool might contain fewer devices than the valuefor this parameter.

By specifying the maximum number of devices, you can control the costs that you incur by runningtests.

Type: Integer

Required: Noname (p. 4)

The device pool's name.

Type: String


Required: Yes


AWS Device Farm API ReferenceResponse Syntax

projectArn (p. 4)

The ARN of the project for the device pool.

Type: String


Pattern: ârn:.+

Required: Yesrules (p. 4)

The device pool's rules.

Type: Array of Rule (p. 290) objects

Required: Yes

Response Syntax{ "devicePool": { "arn": "string", "description": "string", "maxDevices": number, "name": "string", "rules": [ { "attribute": "string", "operator": "string", "value": "string" } ], "type": "string" }}

Response ElementsIf the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

devicePool (p. 5)

The newly created device pool.

Type: DevicePool (p. 252) object

ErrorsFor information about the errors that are common to all actions, see Common Errors (p. 327).

ArgumentException

An invalid argument was specified.


AWS Device Farm API ReferenceSee Also

HTTP Status Code: 400LimitExceededException

A limit was exceeded.

HTTP Status Code: 400NotFoundException

The specified entity was not found.

HTTP Status Code: 400ServiceAccountException

There was a problem with the service account.

HTTP Status Code: 400

See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3


https://docs.aws.amazon.com/goto/aws-cli/devicefarm-2015-06-23/CreateDevicePool

https://docs.aws.amazon.com/goto/DotNetSDKV3/devicefarm-2015-06-23/CreateDevicePool

https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/CreateDevicePool

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/CreateDevicePool

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/CreateDevicePool

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/devicefarm-2015-06-23/CreateDevicePool

https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/CreateDevicePool

https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/CreateDevicePool

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/CreateDevicePool

AWS Device Farm API ReferenceCreateInstanceProfile

CreateInstanceProfileCreates a profile that can be applied to one or more private fleet device instances.

Request Syntax{ "description": "string", "excludeAppPackagesFromCleanup": [ "string" ], "name": "string", "packageCleanup": boolean, "rebootAfterUse": boolean}



description (p. 7)

The description of your instance profile.

Type: String


Required: NoexcludeAppPackagesFromCleanup (p. 7)

An array of strings that specifies the list of app packages that should not be cleaned up from thedevice after a test run.

The list of packages is considered only if you set packageCleanup to true.

Type: Array of strings


The name of your instance profile.

Type: String


Required: YespackageCleanup (p. 7)

When set to true, Device Farm removes app packages after a test run. The default value is falsefor private devices.

Type: Boolean

Required: No



rebootAfterUse (p. 7)

When set to true, Device Farm reboots the instance after a test run. The default value is true.

Type: Boolean

Required: No

Response Syntax{ "instanceProfile": { "arn": "string", "description": "string", "excludeAppPackagesFromCleanup": [ "string" ], "name": "string", "packageCleanup": boolean, "rebootAfterUse": boolean }}



instanceProfile (p. 8)

An object that contains information about your instance profile.

Type: InstanceProfile (p. 260) object


ArgumentException














https://docs.aws.amazon.com/goto/aws-cli/devicefarm-2015-06-23/CreateInstanceProfile

https://docs.aws.amazon.com/goto/DotNetSDKV3/devicefarm-2015-06-23/CreateInstanceProfile

https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/CreateInstanceProfile

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/CreateInstanceProfile

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/CreateInstanceProfile

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/devicefarm-2015-06-23/CreateInstanceProfile

https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/CreateInstanceProfile

https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/CreateInstanceProfile

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/CreateInstanceProfile

AWS Device Farm API ReferenceCreateNetworkProfile

CreateNetworkProfileCreates a network profile.

Request Syntax{ "description": "string", "downlinkBandwidthBits": number, "downlinkDelayMs": number, "downlinkJitterMs": number, "downlinkLossPercent": number, "name": "string", "projectArn": "string", "type": "string", "uplinkBandwidthBits": number, "uplinkDelayMs": number, "uplinkJitterMs": number, "uplinkLossPercent": number}



description (p. 10)

The description of the network profile.

Type: String


Required: NodownlinkBandwidthBits (p. 10)

The data throughput rate in bits per second, as an integer from 0 to 104857600.

Type: Long

Required: NodownlinkDelayMs (p. 10)

Delay time for all packets to destination in milliseconds as an integer from 0 to 2000.

Type: Long

Required: NodownlinkJitterMs (p. 10)

Time variation in the delay of received packets in milliseconds as an integer from 0 to 2000.

Type: Long

Required: No


AWS Device Farm API ReferenceRequest Parameters

downlinkLossPercent (p. 10)

Proportion of received packets that fail to arrive from 0 to 100 percent.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 100.


The name for the new network profile.

Type: String


Required: YesprojectArn (p. 10)

The Amazon Resource Name (ARN) of the project for which you want to create a network profile.

Type: String


Pattern: ârn:.+

Required: Yestype (p. 10)

The type of network profile to create. Valid values are listed here.

Type: String

Valid Values: CURATED | PRIVATE

Required: NouplinkBandwidthBits (p. 10)


Type: Long

Required: NouplinkDelayMs (p. 10)


Type: Long

Required: NouplinkJitterMs (p. 10)


Type: Long

Required: NouplinkLossPercent (p. 10)

Proportion of transmitted packets that fail to arrive from 0 to 100 percent.



Type: Integer


Required: No

Response Syntax{ "networkProfile": { "arn": "string", "description": "string", "downlinkBandwidthBits": number, "downlinkDelayMs": number, "downlinkJitterMs": number, "downlinkLossPercent": number, "name": "string", "type": "string", "uplinkBandwidthBits": number, "uplinkDelayMs": number, "uplinkJitterMs": number, "uplinkLossPercent": number }}



networkProfile (p. 12)

The network profile that is returned by the create network profile request.

Type: NetworkProfile (p. 271) object


ArgumentException









ServiceAccountException






https://docs.aws.amazon.com/goto/aws-cli/devicefarm-2015-06-23/CreateNetworkProfile

https://docs.aws.amazon.com/goto/DotNetSDKV3/devicefarm-2015-06-23/CreateNetworkProfile

https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/CreateNetworkProfile

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/CreateNetworkProfile

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/CreateNetworkProfile

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/devicefarm-2015-06-23/CreateNetworkProfile

https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/CreateNetworkProfile

https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/CreateNetworkProfile

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/CreateNetworkProfile

AWS Device Farm API ReferenceCreateProject

CreateProjectCreates a project.

Request Syntax

{ "defaultJobTimeoutMinutes": number, "name": "string"}



defaultJobTimeoutMinutes (p. 14)

Sets the execution timeout value (in minutes) for a project. All test runs in this project use thespecified execution timeout value unless overridden when scheduling a run.

Type: Integer

Required: No

name (p. 14)

The project's name.

Type: String


Required: Yes

Response Syntax

{ "project": { "arn": "string", "created": number, "defaultJobTimeoutMinutes": number, "name": "string" }}




AWS Device Farm API ReferenceErrors

project (p. 14)

The newly created project.

Type: Project (p. 281) object


ArgumentException








HTTP Status Code: 400TagOperationException

The operation was not successful. Try again.





https://docs.aws.amazon.com/goto/aws-cli/devicefarm-2015-06-23/CreateProject

https://docs.aws.amazon.com/goto/DotNetSDKV3/devicefarm-2015-06-23/CreateProject

https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/CreateProject

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/CreateProject

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/CreateProject

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/devicefarm-2015-06-23/CreateProject

https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/CreateProject

https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/CreateProject

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/CreateProject

AWS Device Farm API ReferenceCreateRemoteAccessSession

CreateRemoteAccessSessionSpecifies and starts a remote access session.

Request Syntax{ "clientId": "string", "configuration": { "billingMethod": "string", "vpceConfigurationArns": [ "string" ] }, "deviceArn": "string", "instanceArn": "string", "interactionMode": "string", "name": "string", "projectArn": "string", "remoteDebugEnabled": boolean, "remoteRecordAppArn": "string", "remoteRecordEnabled": boolean, "skipAppResign": boolean, "sshPublicKey": "string"}



clientId (p. 16)

Unique identifier for the client. If you want access to multiple devices on the same client, you shouldpass the same clientId value in each call to CreateRemoteAccessSession. This identifier isrequired only if remoteDebugEnabled is set to true.

Remote debugging is no longer supported.

Type: String


Required: Noconfiguration (p. 16)

The configuration information for the remote access session request.

Type: CreateRemoteAccessSessionConfiguration (p. 240) object

Required: NodeviceArn (p. 16)

The ARN of the device for which you want to create a remote access session.

Type: String



https://docs.aws.amazon.com/devicefarm/latest/developerguide/history.html


Pattern: ârn:.+

Required: YesinstanceArn (p. 16)

The Amazon Resource Name (ARN) of the device instance for which you want to create a remoteaccess session.

Type: String


Pattern: ârn:.+

Required: NointeractionMode (p. 16)

The interaction mode of the remote access session. Valid values are:• INTERACTIVE: You can interact with the iOS device by viewing, touching, and rotating the screen.

You cannot run XCUITest framework-based tests in this mode.• NO_VIDEO: You are connected to the device, but cannot interact with it or view the screen. This

mode has the fastest test execution speed. You can run XCUITest framework-based tests in thismode.

• VIDEO_ONLY: You can view the screen, but cannot touch or rotate it. You can run XCUITestframework-based tests and watch the screen in this mode.

Type: String


Valid Values: INTERACTIVE | NO_VIDEO | VIDEO_ONLY


The name of the remote access session to create.

Type: String


Required: NoprojectArn (p. 16)

The Amazon Resource Name (ARN) of the project for which you want to create a remote accesssession.

Type: String


Pattern: ârn:.+

Required: YesremoteDebugEnabled (p. 16)

Set to true if you want to access devices remotely for debugging in your remote access session.


Type: Boolean




Required: NoremoteRecordAppArn (p. 16)

The Amazon Resource Name (ARN) for the app to be recorded in the remote access session.

Type: String


Pattern: ârn:.+

Required: NoremoteRecordEnabled (p. 16)

Set to true to enable remote recording for the remote access session.

Type: Boolean

Required: NoskipAppResign (p. 16)

When set to true, for private devices, Device Farm does not sign your app again. For public devices,Device Farm always signs your apps again.

For more information on how Device Farm modifies your uploads during tests, see Do you modifymy app?

Type: Boolean

Required: NosshPublicKey (p. 16)

Ignored. The public key of the ssh key pair you want to use for connecting to remote devices in yourremote debugging session. This key is required only if remoteDebugEnabled is set to true.


Type: String


Required: No

Response Syntax{ "remoteAccessSession": { "arn": "string", "billingMethod": "string", "clientId": "string", "created": number, "device": { "arn": "string", "availability": "string", "carrier": "string", "cpu": { "architecture": "string", "clock": number, "frequency": "string"


https://aws.amazon.com/device-farm/faq/



AWS Device Farm API ReferenceResponse Elements

}, "fleetName": "string", "fleetType": "string", "formFactor": "string", "heapSize": number, "image": "string", "instances": [ { "arn": "string", "deviceArn": "string", "instanceProfile": { "arn": "string", "description": "string", "excludeAppPackagesFromCleanup": [ "string" ], "name": "string", "packageCleanup": boolean, "rebootAfterUse": boolean }, "labels": [ "string" ], "status": "string", "udid": "string" } ], "manufacturer": "string", "memory": number, "model": "string", "modelId": "string", "name": "string", "os": "string", "platform": "string", "radio": "string", "remoteAccessEnabled": boolean, "remoteDebugEnabled": boolean, "resolution": { "height": number, "width": number } }, "deviceMinutes": { "metered": number, "total": number, "unmetered": number }, "deviceUdid": "string", "endpoint": "string", "hostAddress": "string", "instanceArn": "string", "interactionMode": "string", "message": "string", "name": "string", "remoteDebugEnabled": boolean, "remoteRecordAppArn": "string", "remoteRecordEnabled": boolean, "result": "string", "skipAppResign": boolean, "started": number, "status": "string", "stopped": number }}





remoteAccessSession (p. 18)

A container that describes the remote access session when the request to create a remote accesssession is sent.

Type: RemoteAccessSession (p. 284) object


ArgumentException












https://docs.aws.amazon.com/goto/aws-cli/devicefarm-2015-06-23/CreateRemoteAccessSession

https://docs.aws.amazon.com/goto/DotNetSDKV3/devicefarm-2015-06-23/CreateRemoteAccessSession

https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/CreateRemoteAccessSession

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/CreateRemoteAccessSession

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/CreateRemoteAccessSession

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/devicefarm-2015-06-23/CreateRemoteAccessSession

https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/CreateRemoteAccessSession

https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/CreateRemoteAccessSession

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/CreateRemoteAccessSession

AWS Device Farm API ReferenceCreateTestGridProject

CreateTestGridProjectCreates a Selenium testing project. Projects are used to track TestGridSession (p. 314) instances.

Request Syntax{ "description": "string", "name": "string"}



description (p. 21)

Human-readable description of the project.

Type: String


Pattern: .*\S.*


Human-readable name of the Selenium testing project.

Type: String


Pattern: .*\S.*

Required: Yes

Response Syntax{ "testGridProject": { "arn": "string", "created": number, "description": "string", "name": "string" }}





testGridProject (p. 21)

ARN of the Selenium testing project that was created.

Type: TestGridProject (p. 313) object


InternalServiceException

An internal exception was raised in the service. Contact [email protected] ifyou see this error.





mailto:[email protected]

https://docs.aws.amazon.com/goto/aws-cli/devicefarm-2015-06-23/CreateTestGridProject

https://docs.aws.amazon.com/goto/DotNetSDKV3/devicefarm-2015-06-23/CreateTestGridProject

https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/CreateTestGridProject

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/CreateTestGridProject

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/CreateTestGridProject

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/devicefarm-2015-06-23/CreateTestGridProject

https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/CreateTestGridProject

https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/CreateTestGridProject

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/CreateTestGridProject

AWS Device Farm API ReferenceCreateTestGridUrl

CreateTestGridUrlCreates a signed, short-term URL that can be passed to a Selenium RemoteWebDriver constructor.

Request Syntax{ "expiresInSeconds": number, "projectArn": "string"}



expiresInSeconds (p. 23)

Lifetime, in seconds, of the URL.

Type: Integer


Required: Yes

projectArn (p. 23)

ARN (from CreateTestGridProject (p. 21) or ListTestGridProjects (p. 157)) to associate with theshort-term URL.

Type: String


Pattern: ârn:aws:devicefarm:.+

Required: Yes

Response Syntax{ "expires": number, "url": "string"}





expires (p. 23)

The number of seconds the URL from CreateTestGridUrl:url (p. 24) stays active.

Type: Timestampurl (p. 23)

A signed URL, expiring in CreateTestGridUrl:expiresInSeconds (p. 23) seconds, to be passed to aRemoteWebDriver.

Type: String


ArgumentException


HTTP Status Code: 400InternalServiceException









https://docs.aws.amazon.com/goto/aws-cli/devicefarm-2015-06-23/CreateTestGridUrl

https://docs.aws.amazon.com/goto/DotNetSDKV3/devicefarm-2015-06-23/CreateTestGridUrl

https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/CreateTestGridUrl

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/CreateTestGridUrl

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/CreateTestGridUrl

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/devicefarm-2015-06-23/CreateTestGridUrl

https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/CreateTestGridUrl

https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/CreateTestGridUrl

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/CreateTestGridUrl

AWS Device Farm API ReferenceCreateUpload

CreateUploadUploads an app or test scripts.

Request Syntax{ "contentType": "string", "name": "string", "projectArn": "string", "type": "string"}



contentType (p. 25)

The upload's content type (for example, application/octet-stream).

Type: String



The upload's file name. The name should not contain any forward slashes (/). If you are uploading aniOS app, the file name must end with the .ipa extension. If you are uploading an Android app, thefile name must end with the .apk extension. For all others, the file name must end with the .zipfile extension.

Type: String


Required: YesprojectArn (p. 25)

The ARN of the project for the upload.

Type: String


Pattern: ârn:.+


The upload's upload type.

Must be one of the following values:



• ANDROID_APP• IOS_APP• WEB_APP• EXTERNAL_DATA• APPIUM_JAVA_JUNIT_TEST_PACKAGE• APPIUM_JAVA_TESTNG_TEST_PACKAGE• APPIUM_PYTHON_TEST_PACKAGE• APPIUM_NODE_TEST_PACKAGE• APPIUM_RUBY_TEST_PACKAGE• APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE• APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE• APPIUM_WEB_PYTHON_TEST_PACKAGE• APPIUM_WEB_NODE_TEST_PACKAGE• APPIUM_WEB_RUBY_TEST_PACKAGE• CALABASH_TEST_PACKAGE• INSTRUMENTATION_TEST_PACKAGE• UIAUTOMATION_TEST_PACKAGE• UIAUTOMATOR_TEST_PACKAGE• XCTEST_TEST_PACKAGE• XCTEST_UI_TEST_PACKAGE• APPIUM_JAVA_JUNIT_TEST_SPEC• APPIUM_JAVA_TESTNG_TEST_SPEC• APPIUM_PYTHON_TEST_SPEC• APPIUM_NODE_TEST_SPEC• APPIUM_RUBY_TEST_SPEC• APPIUM_WEB_JAVA_JUNIT_TEST_SPEC• APPIUM_WEB_JAVA_TESTNG_TEST_SPEC• APPIUM_WEB_PYTHON_TEST_SPEC• APPIUM_WEB_NODE_TEST_SPEC• APPIUM_WEB_RUBY_TEST_SPEC• INSTRUMENTATION_TEST_SPEC• XCTEST_UI_TEST_SPEC

If you call CreateUpload with WEB_APP specified, AWS Device Farm throws anArgumentException error.

Type: String

Valid Values: ANDROID_APP | IOS_APP | WEB_APP | EXTERNAL_DATA |APPIUM_JAVA_JUNIT_TEST_PACKAGE | APPIUM_JAVA_TESTNG_TEST_PACKAGE| APPIUM_PYTHON_TEST_PACKAGE | APPIUM_NODE_TEST_PACKAGE |APPIUM_RUBY_TEST_PACKAGE | APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE |APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE | APPIUM_WEB_PYTHON_TEST_PACKAGE| APPIUM_WEB_NODE_TEST_PACKAGE | APPIUM_WEB_RUBY_TEST_PACKAGE| CALABASH_TEST_PACKAGE | INSTRUMENTATION_TEST_PACKAGE |UIAUTOMATION_TEST_PACKAGE | UIAUTOMATOR_TEST_PACKAGE |XCTEST_TEST_PACKAGE | XCTEST_UI_TEST_PACKAGE | APPIUM_JAVA_JUNIT_TEST_SPEC| APPIUM_JAVA_TESTNG_TEST_SPEC | APPIUM_PYTHON_TEST_SPEC| APPIUM_NODE_TEST_SPEC | APPIUM_RUBY_TEST_SPEC |APPIUM_WEB_JAVA_JUNIT_TEST_SPEC | APPIUM_WEB_JAVA_TESTNG_TEST_SPEC



| APPIUM_WEB_PYTHON_TEST_SPEC | APPIUM_WEB_NODE_TEST_SPEC |APPIUM_WEB_RUBY_TEST_SPEC | INSTRUMENTATION_TEST_SPEC | XCTEST_UI_TEST_SPEC

Required: Yes

Response Syntax{ "upload": { "arn": "string", "category": "string", "contentType": "string", "created": number, "message": "string", "metadata": "string", "name": "string", "status": "string", "type": "string", "url": "string" }}



upload (p. 27)

The newly created upload.

Type: Upload (p. 320) object


ArgumentException














https://docs.aws.amazon.com/goto/aws-cli/devicefarm-2015-06-23/CreateUpload

https://docs.aws.amazon.com/goto/DotNetSDKV3/devicefarm-2015-06-23/CreateUpload

https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/CreateUpload

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/CreateUpload

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/CreateUpload

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/devicefarm-2015-06-23/CreateUpload

https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/CreateUpload

https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/CreateUpload

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/CreateUpload

AWS Device Farm API ReferenceCreateVPCEConfiguration

CreateVPCEConfigurationCreates a configuration record in Device Farm for your Amazon Virtual Private Cloud (VPC) endpoint.

Request Syntax{ "serviceDnsName": "string", "vpceConfigurationDescription": "string", "vpceConfigurationName": "string", "vpceServiceName": "string"}



serviceDnsName (p. 29)

The DNS name of the service running in your VPC that you want Device Farm to test.

Type: String


Required: YesvpceConfigurationDescription (p. 29)

An optional description that provides details about your VPC endpoint configuration.

Type: String


Required: NovpceConfigurationName (p. 29)

The friendly name you give to your VPC endpoint configuration, to manage your configurationsmore easily.

Type: String


Required: YesvpceServiceName (p. 29)

The name of the VPC endpoint service running in your AWS account that you want Device Farm totest.

Type: String




Required: Yes

Response Syntax{ "vpceConfiguration": { "arn": "string", "serviceDnsName": "string", "vpceConfigurationDescription": "string", "vpceConfigurationName": "string", "vpceServiceName": "string" }}



vpceConfiguration (p. 30)

An object that contains information about your VPC endpoint configuration.

Type: VPCEConfiguration (p. 323) object


ArgumentException








• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++


https://docs.aws.amazon.com/goto/aws-cli/devicefarm-2015-06-23/CreateVPCEConfiguration

https://docs.aws.amazon.com/goto/DotNetSDKV3/devicefarm-2015-06-23/CreateVPCEConfiguration

https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/CreateVPCEConfiguration


• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3


https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/CreateVPCEConfiguration

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/CreateVPCEConfiguration

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/devicefarm-2015-06-23/CreateVPCEConfiguration

https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/CreateVPCEConfiguration

https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/CreateVPCEConfiguration

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/CreateVPCEConfiguration

AWS Device Farm API ReferenceDeleteDevicePool

DeleteDevicePoolDeletes a device pool given the pool ARN. Does not allow deletion of curated pools owned by the system.

Request Syntax{ "arn": "string"}



arn (p. 32)

Represents the Amazon Resource Name (ARN) of the Device Farm device pool to delete.

Type: String


Pattern: ârn:.+

Required: Yes

Response ElementsIf the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.


ArgumentException














https://docs.aws.amazon.com/goto/aws-cli/devicefarm-2015-06-23/DeleteDevicePool

https://docs.aws.amazon.com/goto/DotNetSDKV3/devicefarm-2015-06-23/DeleteDevicePool

https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/DeleteDevicePool

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/DeleteDevicePool

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/DeleteDevicePool

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/devicefarm-2015-06-23/DeleteDevicePool

https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/DeleteDevicePool

https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/DeleteDevicePool

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/DeleteDevicePool

AWS Device Farm API ReferenceDeleteInstanceProfile

DeleteInstanceProfileDeletes a profile that can be applied to one or more private device instances.




arn (p. 34)

The Amazon Resource Name (ARN) of the instance profile you are requesting to delete.

Type: String


Pattern: ârn:.+

Required: Yes



ArgumentException














https://docs.aws.amazon.com/goto/aws-cli/devicefarm-2015-06-23/DeleteInstanceProfile

https://docs.aws.amazon.com/goto/DotNetSDKV3/devicefarm-2015-06-23/DeleteInstanceProfile

https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/DeleteInstanceProfile

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/DeleteInstanceProfile

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/DeleteInstanceProfile

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/devicefarm-2015-06-23/DeleteInstanceProfile

https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/DeleteInstanceProfile

https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/DeleteInstanceProfile

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/DeleteInstanceProfile

AWS Device Farm API ReferenceDeleteNetworkProfile

DeleteNetworkProfileDeletes a network profile.




arn (p. 36)

The ARN of the network profile to delete.

Type: String


Pattern: ârn:.+

Required: Yes



ArgumentException














https://docs.aws.amazon.com/goto/aws-cli/devicefarm-2015-06-23/DeleteNetworkProfile

https://docs.aws.amazon.com/goto/DotNetSDKV3/devicefarm-2015-06-23/DeleteNetworkProfile

https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/DeleteNetworkProfile

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/DeleteNetworkProfile

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/DeleteNetworkProfile

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/devicefarm-2015-06-23/DeleteNetworkProfile

https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/DeleteNetworkProfile

https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/DeleteNetworkProfile

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/DeleteNetworkProfile

AWS Device Farm API ReferenceDeleteProject

DeleteProjectDeletes an AWS Device Farm project, given the project ARN.

Deleting this resource does not stop an in-progress run.




arn (p. 38)

Represents the Amazon Resource Name (ARN) of the Device Farm project to delete.

Type: String


Pattern: ârn:.+

Required: Yes



ArgumentException















https://docs.aws.amazon.com/goto/aws-cli/devicefarm-2015-06-23/DeleteProject

https://docs.aws.amazon.com/goto/DotNetSDKV3/devicefarm-2015-06-23/DeleteProject

https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/DeleteProject

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/DeleteProject

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/DeleteProject

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/devicefarm-2015-06-23/DeleteProject

https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/DeleteProject

https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/DeleteProject

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/DeleteProject

AWS Device Farm API ReferenceDeleteRemoteAccessSession

DeleteRemoteAccessSessionDeletes a completed remote access session and its results.




arn (p. 40)

The Amazon Resource Name (ARN) of the session for which you want to delete remote access.

Type: String


Pattern: ârn:.+

Required: Yes



ArgumentException














https://docs.aws.amazon.com/goto/aws-cli/devicefarm-2015-06-23/DeleteRemoteAccessSession

https://docs.aws.amazon.com/goto/DotNetSDKV3/devicefarm-2015-06-23/DeleteRemoteAccessSession

https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/DeleteRemoteAccessSession

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/DeleteRemoteAccessSession

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/DeleteRemoteAccessSession

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/devicefarm-2015-06-23/DeleteRemoteAccessSession

https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/DeleteRemoteAccessSession

https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/DeleteRemoteAccessSession

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/DeleteRemoteAccessSession

AWS Device Farm API ReferenceDeleteRun

DeleteRunDeletes the run, given the run ARN.

Deleting this resource does not stop an in-progress run.




arn (p. 42)

The Amazon Resource Name (ARN) for the run to delete.

Type: String


Pattern: ârn:.+

Required: Yes



ArgumentException















https://docs.aws.amazon.com/goto/aws-cli/devicefarm-2015-06-23/DeleteRun

https://docs.aws.amazon.com/goto/DotNetSDKV3/devicefarm-2015-06-23/DeleteRun

https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/DeleteRun

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/DeleteRun

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/DeleteRun

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/devicefarm-2015-06-23/DeleteRun

https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/DeleteRun

https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/DeleteRun

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/DeleteRun

AWS Device Farm API ReferenceDeleteTestGridProject

DeleteTestGridProjectDeletes a Selenium testing project and all content generated under it.

ImportantYou cannot undo this operation.

NoteYou cannot delete a project if it has active sessions.

Request Syntax{ "projectArn": "string"}



projectArn (p. 44)

The ARN of the project to delete, from CreateTestGridProject (p. 21) orListTestGridProjects (p. 157).

Type: String



Required: Yes



ArgumentException


HTTP Status Code: 400CannotDeleteException

The requested object could not be deleted.




InternalServiceException









https://docs.aws.amazon.com/goto/aws-cli/devicefarm-2015-06-23/DeleteTestGridProject

https://docs.aws.amazon.com/goto/DotNetSDKV3/devicefarm-2015-06-23/DeleteTestGridProject

https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/DeleteTestGridProject

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/DeleteTestGridProject

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/DeleteTestGridProject

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/devicefarm-2015-06-23/DeleteTestGridProject

https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/DeleteTestGridProject

https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/DeleteTestGridProject

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/DeleteTestGridProject

AWS Device Farm API ReferenceDeleteUpload

DeleteUploadDeletes an upload given the upload ARN.




arn (p. 46)

Represents the Amazon Resource Name (ARN) of the Device Farm upload to delete.

Type: String


Pattern: ârn:.+

Required: Yes



ArgumentException














https://docs.aws.amazon.com/goto/aws-cli/devicefarm-2015-06-23/DeleteUpload

https://docs.aws.amazon.com/goto/DotNetSDKV3/devicefarm-2015-06-23/DeleteUpload

https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/DeleteUpload

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/DeleteUpload

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/DeleteUpload

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/devicefarm-2015-06-23/DeleteUpload

https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/DeleteUpload

https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/DeleteUpload

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/DeleteUpload

AWS Device Farm API ReferenceDeleteVPCEConfiguration

DeleteVPCEConfigurationDeletes a configuration for your Amazon Virtual Private Cloud (VPC) endpoint.




arn (p. 48)

The Amazon Resource Name (ARN) of the VPC endpoint configuration you want to delete.

Type: String


Pattern: ârn:.+

Required: Yes



ArgumentException


HTTP Status Code: 400InvalidOperationException

There was an error with the update request, or you do not have sufficient permissions to update thisVPC endpoint configuration.












https://docs.aws.amazon.com/goto/aws-cli/devicefarm-2015-06-23/DeleteVPCEConfiguration

https://docs.aws.amazon.com/goto/DotNetSDKV3/devicefarm-2015-06-23/DeleteVPCEConfiguration

https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/DeleteVPCEConfiguration

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/DeleteVPCEConfiguration

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/DeleteVPCEConfiguration

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/devicefarm-2015-06-23/DeleteVPCEConfiguration

https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/DeleteVPCEConfiguration

https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/DeleteVPCEConfiguration

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/DeleteVPCEConfiguration

AWS Device Farm API ReferenceGetAccountSettings

GetAccountSettingsReturns the number of unmetered iOS or unmetered Android devices that have been purchased by theaccount.

Response Syntax

{ "accountSettings": { "awsAccountNumber": "string", "defaultJobTimeoutMinutes": number, "maxJobTimeoutMinutes": number, "maxSlots": { "string" : number }, "skipAppResign": boolean, "trialMinutes": { "remaining": number, "total": number }, "unmeteredDevices": { "string" : number }, "unmeteredRemoteAccessDevices": { "string" : number } }}



accountSettings (p. 50)

The account settings.

Type: AccountSettings (p. 233) object


ArgumentException



LimitExceededException





NotFoundException








https://docs.aws.amazon.com/goto/aws-cli/devicefarm-2015-06-23/GetAccountSettings

https://docs.aws.amazon.com/goto/DotNetSDKV3/devicefarm-2015-06-23/GetAccountSettings

https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/GetAccountSettings

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/GetAccountSettings

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/GetAccountSettings

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/devicefarm-2015-06-23/GetAccountSettings

https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/GetAccountSettings

https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/GetAccountSettings

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/GetAccountSettings

AWS Device Farm API ReferenceGetDevice

GetDeviceGets information about a unique device type.




arn (p. 52)

The device type's ARN.

Type: String


Pattern: ârn:.+

Required: Yes

Response Syntax{ "device": { "arn": "string", "availability": "string", "carrier": "string", "cpu": { "architecture": "string", "clock": number, "frequency": "string" }, "fleetName": "string", "fleetType": "string", "formFactor": "string", "heapSize": number, "image": "string", "instances": [ { "arn": "string", "deviceArn": "string", "instanceProfile": { "arn": "string", "description": "string", "excludeAppPackagesFromCleanup": [ "string" ], "name": "string", "packageCleanup": boolean, "rebootAfterUse": boolean



}, "labels": [ "string" ], "status": "string", "udid": "string" } ], "manufacturer": "string", "memory": number, "model": "string", "modelId": "string", "name": "string", "os": "string", "platform": "string", "radio": "string", "remoteAccessEnabled": boolean, "remoteDebugEnabled": boolean, "resolution": { "height": number, "width": number } }}



device (p. 52)

An object that contains information about the requested device.

Type: Device (p. 242) object


ArgumentException














https://docs.aws.amazon.com/goto/aws-cli/devicefarm-2015-06-23/GetDevice

https://docs.aws.amazon.com/goto/DotNetSDKV3/devicefarm-2015-06-23/GetDevice

https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/GetDevice

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/GetDevice

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/GetDevice

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/devicefarm-2015-06-23/GetDevice

https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/GetDevice

https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/GetDevice

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/GetDevice

AWS Device Farm API ReferenceGetDeviceInstance

GetDeviceInstanceReturns information about a device instance that belongs to a private device fleet.




arn (p. 55)

The Amazon Resource Name (ARN) of the instance you're requesting information about.

Type: String


Pattern: ârn:.+

Required: Yes

Response Syntax{ "deviceInstance": { "arn": "string", "deviceArn": "string", "instanceProfile": { "arn": "string", "description": "string", "excludeAppPackagesFromCleanup": [ "string" ], "name": "string", "packageCleanup": boolean, "rebootAfterUse": boolean }, "labels": [ "string" ], "status": "string", "udid": "string" }}





deviceInstance (p. 55)

An object that contains information about your device instance.

Type: DeviceInstance (p. 249) object


ArgumentException












https://docs.aws.amazon.com/goto/aws-cli/devicefarm-2015-06-23/GetDeviceInstance

https://docs.aws.amazon.com/goto/DotNetSDKV3/devicefarm-2015-06-23/GetDeviceInstance

https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/GetDeviceInstance

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/GetDeviceInstance

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/GetDeviceInstance

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/devicefarm-2015-06-23/GetDeviceInstance

https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/GetDeviceInstance

https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/GetDeviceInstance

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/GetDeviceInstance

AWS Device Farm API ReferenceGetDevicePool

GetDevicePoolGets information about a device pool.

Request Syntax

{ "arn": "string"}



arn (p. 57)

The device pool's ARN.

Type: String


Pattern: ârn:.+

Required: Yes

Response Syntax

{ "devicePool": { "arn": "string", "description": "string", "maxDevices": number, "name": "string", "rules": [ { "attribute": "string", "operator": "string", "value": "string" } ], "type": "string" }}





devicePool (p. 57)

An object that contains information about the requested device pool.



ArgumentException












https://docs.aws.amazon.com/goto/aws-cli/devicefarm-2015-06-23/GetDevicePool

https://docs.aws.amazon.com/goto/DotNetSDKV3/devicefarm-2015-06-23/GetDevicePool

https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/GetDevicePool

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/GetDevicePool

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/GetDevicePool

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/devicefarm-2015-06-23/GetDevicePool

https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/GetDevicePool

https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/GetDevicePool

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/GetDevicePool

AWS Device Farm API ReferenceGetDevicePoolCompatibility

GetDevicePoolCompatibilityGets information about compatibility with a device pool.

Request Syntax{ "appArn": "string", "configuration": { "auxiliaryApps": [ "string" ], "billingMethod": "string", "customerArtifactPaths": { "androidPaths": [ "string" ], "deviceHostPaths": [ "string" ], "iosPaths": [ "string" ] }, "extraDataPackageArn": "string", "locale": "string", "location": { "latitude": number, "longitude": number }, "networkProfileArn": "string", "radios": { "bluetooth": boolean, "gps": boolean, "nfc": boolean, "wifi": boolean }, "vpceConfigurationArns": [ "string" ] }, "devicePoolArn": "string", "test": { "filter": "string", "parameters": { "string" : "string" }, "testPackageArn": "string", "testSpecArn": "string", "type": "string" }, "testType": "string"}



appArn (p. 59)

The ARN of the app that is associated with the specified device pool.

Type: String


Pattern: ârn:.+



Required: No

configuration (p. 59)

An object that contains information about the settings for a run.

Type: ScheduleRunConfiguration (p. 301) object

Required: No

devicePoolArn (p. 59)


Type: String


Pattern: ârn:.+

Required: Yes

test (p. 59)

Information about the uploaded test to be run against the device pool.

Type: ScheduleRunTest (p. 303) object

Required: No

testType (p. 59)

The test type for the specified device pool.

Allowed values include the following:

• BUILTIN_FUZZ.

• BUILTIN_EXPLORER. For Android, an app explorer that traverses an Android app, interacting withit and capturing screenshots at the same time.

• APPIUM_JAVA_JUNIT.

• APPIUM_JAVA_TESTNG.

• APPIUM_PYTHON.

• APPIUM_NODE.

• APPIUM_RUBY.

• APPIUM_WEB_JAVA_JUNIT.

• APPIUM_WEB_JAVA_TESTNG.

• APPIUM_WEB_PYTHON.

• APPIUM_WEB_NODE.

• APPIUM_WEB_RUBY.

• CALABASH.

• INSTRUMENTATION.

• UIAUTOMATION.

• UIAUTOMATOR.

• XCTEST.

• XCTEST_UI.



Type: String

Valid Values: BUILTIN_FUZZ | BUILTIN_EXPLORER | WEB_PERFORMANCE_PROFILE |APPIUM_JAVA_JUNIT | APPIUM_JAVA_TESTNG | APPIUM_PYTHON | APPIUM_NODE| APPIUM_RUBY | APPIUM_WEB_JAVA_JUNIT | APPIUM_WEB_JAVA_TESTNG |APPIUM_WEB_PYTHON | APPIUM_WEB_NODE | APPIUM_WEB_RUBY | CALABASH |INSTRUMENTATION | UIAUTOMATION | UIAUTOMATOR | XCTEST | XCTEST_UI |REMOTE_ACCESS_RECORD | REMOTE_ACCESS_REPLAY

Required: No

Response Syntax{ "compatibleDevices": [ { "compatible": boolean, "device": { "arn": "string", "availability": "string", "carrier": "string", "cpu": { "architecture": "string", "clock": number, "frequency": "string" }, "fleetName": "string", "fleetType": "string", "formFactor": "string", "heapSize": number, "image": "string", "instances": [ { "arn": "string", "deviceArn": "string", "instanceProfile": { "arn": "string", "description": "string", "excludeAppPackagesFromCleanup": [ "string" ], "name": "string", "packageCleanup": boolean, "rebootAfterUse": boolean }, "labels": [ "string" ], "status": "string", "udid": "string" } ], "manufacturer": "string", "memory": number, "model": "string", "modelId": "string", "name": "string", "os": "string", "platform": "string", "radio": "string", "remoteAccessEnabled": boolean, "remoteDebugEnabled": boolean, "resolution": { "height": number, "width": number }



}, "incompatibilityMessages": [ { "message": "string", "type": "string" } ] } ], "incompatibleDevices": [ { "compatible": boolean, "device": { "arn": "string", "availability": "string", "carrier": "string", "cpu": { "architecture": "string", "clock": number, "frequency": "string" }, "fleetName": "string", "fleetType": "string", "formFactor": "string", "heapSize": number, "image": "string", "instances": [ { "arn": "string", "deviceArn": "string", "instanceProfile": { "arn": "string", "description": "string", "excludeAppPackagesFromCleanup": [ "string" ], "name": "string", "packageCleanup": boolean, "rebootAfterUse": boolean }, "labels": [ "string" ], "status": "string", "udid": "string" } ], "manufacturer": "string", "memory": number, "model": "string", "modelId": "string", "name": "string", "os": "string", "platform": "string", "radio": "string", "remoteAccessEnabled": boolean, "remoteDebugEnabled": boolean, "resolution": { "height": number, "width": number } }, "incompatibilityMessages": [ { "message": "string", "type": "string" } ] } ]



}



compatibleDevices (p. 61)

Information about compatible devices.

Type: Array of DevicePoolCompatibilityResult (p. 254) objectsincompatibleDevices (p. 61)

Information about incompatible devices.

Type: Array of DevicePoolCompatibilityResult (p. 254) objects


ArgumentException










• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript


https://docs.aws.amazon.com/goto/aws-cli/devicefarm-2015-06-23/GetDevicePoolCompatibility

https://docs.aws.amazon.com/goto/DotNetSDKV3/devicefarm-2015-06-23/GetDevicePoolCompatibility

https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/GetDevicePoolCompatibility

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/GetDevicePoolCompatibility

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/GetDevicePoolCompatibility

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/devicefarm-2015-06-23/GetDevicePoolCompatibility


• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3


https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/GetDevicePoolCompatibility

https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/GetDevicePoolCompatibility

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/GetDevicePoolCompatibility

AWS Device Farm API ReferenceGetInstanceProfile

GetInstanceProfileReturns information about the specified instance profile.




arn (p. 65)

The Amazon Resource Name (ARN) of an instance profile.

Type: String


Pattern: ârn:.+

Required: Yes





An object that contains information about an instance profile.





ArgumentException












https://docs.aws.amazon.com/goto/aws-cli/devicefarm-2015-06-23/GetInstanceProfile

https://docs.aws.amazon.com/goto/DotNetSDKV3/devicefarm-2015-06-23/GetInstanceProfile

https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/GetInstanceProfile

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/GetInstanceProfile

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/GetInstanceProfile

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/devicefarm-2015-06-23/GetInstanceProfile

https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/GetInstanceProfile

https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/GetInstanceProfile

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/GetInstanceProfile

AWS Device Farm API ReferenceGetJob

GetJobGets information about a job.




arn (p. 67)

The job's ARN.

Type: String


Pattern: ârn:.+

Required: Yes

Response Syntax{ "job": { "arn": "string", "counters": { "errored": number, "failed": number, "passed": number, "skipped": number, "stopped": number, "total": number, "warned": number }, "created": number, "device": { "arn": "string", "availability": "string", "carrier": "string", "cpu": { "architecture": "string", "clock": number, "frequency": "string" }, "fleetName": "string", "fleetType": "string", "formFactor": "string",



"heapSize": number, "image": "string", "instances": [ { "arn": "string", "deviceArn": "string", "instanceProfile": { "arn": "string", "description": "string", "excludeAppPackagesFromCleanup": [ "string" ], "name": "string", "packageCleanup": boolean, "rebootAfterUse": boolean }, "labels": [ "string" ], "status": "string", "udid": "string" } ], "manufacturer": "string", "memory": number, "model": "string", "modelId": "string", "name": "string", "os": "string", "platform": "string", "radio": "string", "remoteAccessEnabled": boolean, "remoteDebugEnabled": boolean, "resolution": { "height": number, "width": number } }, "deviceMinutes": { "metered": number, "total": number, "unmetered": number }, "instanceArn": "string", "message": "string", "name": "string", "result": "string", "started": number, "status": "string", "stopped": number, "type": "string", "videoCapture": boolean, "videoEndpoint": "string" }}



job (p. 67)

An object that contains information about the requested job.

Type: Job (p. 262) object




ArgumentException












https://docs.aws.amazon.com/goto/aws-cli/devicefarm-2015-06-23/GetJob

https://docs.aws.amazon.com/goto/DotNetSDKV3/devicefarm-2015-06-23/GetJob

https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/GetJob

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/GetJob

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/GetJob

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/devicefarm-2015-06-23/GetJob

https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/GetJob

https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/GetJob

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/GetJob

AWS Device Farm API ReferenceGetNetworkProfile

GetNetworkProfileReturns information about a network profile.

Request Syntax

{ "arn": "string"}



arn (p. 70)

The ARN of the network profile to return information about.

Type: String


Pattern: ârn:.+

Required: Yes

Response Syntax

{ "networkProfile": { "arn": "string", "description": "string", "downlinkBandwidthBits": number, "downlinkDelayMs": number, "downlinkJitterMs": number, "downlinkLossPercent": number, "name": "string", "type": "string", "uplinkBandwidthBits": number, "uplinkDelayMs": number, "uplinkJitterMs": number, "uplinkLossPercent": number }}






The network profile.



ArgumentException












https://docs.aws.amazon.com/goto/aws-cli/devicefarm-2015-06-23/GetNetworkProfile

https://docs.aws.amazon.com/goto/DotNetSDKV3/devicefarm-2015-06-23/GetNetworkProfile

https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/GetNetworkProfile

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/GetNetworkProfile

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/GetNetworkProfile

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/devicefarm-2015-06-23/GetNetworkProfile

https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/GetNetworkProfile

https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/GetNetworkProfile

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/GetNetworkProfile

AWS Device Farm API ReferenceGetOfferingStatus

GetOfferingStatusGets the current status and future status of all offerings purchased by an AWS account. The responseindicates how many offerings are currently available and the offerings that will be available in the nextperiod. The API returns a NotEligible error if the user is not permitted to invoke the operation. If youmust be able to invoke this operation, contact [email protected].

Request Syntax{ "nextToken": "string"}



nextToken (p. 72)

An identifier that was returned from the previous call to this operation, which can be used to returnthe next set of items in the list.

Type: String


Required: No

Response Syntax{ "current": { "string" : { "effectiveOn": number, "offering": { "description": "string", "id": "string", "platform": "string", "recurringCharges": [ { "cost": { "amount": number, "currencyCode": "string" }, "frequency": "string" } ], "type": "string" }, "quantity": number, "type": "string" } }, "nextPeriod": {




"string" : { "effectiveOn": number, "offering": { "description": "string", "id": "string", "platform": "string", "recurringCharges": [ { "cost": { "amount": number, "currencyCode": "string" }, "frequency": "string" } ], "type": "string" }, "quantity": number, "type": "string" } }, "nextToken": "string"}



current (p. 72)

When specified, gets the offering status for the current period.

Type: String to OfferingStatus (p. 276) object map

Key Length Constraints: Minimum length of 32.nextPeriod (p. 72)

When specified, gets the offering status for the next period.

Type: String to OfferingStatus (p. 276) object map

Key Length Constraints: Minimum length of 32.nextToken (p. 72)


Type: String



ArgumentException



AWS Device Farm API ReferenceExample



HTTP Status Code: 400NotEligibleException

Exception gets thrown when a user is not eligible to perform the specified transaction.






Example

The following example checks the current and renewal status.

Sample Response

{ "current": { "offering-id-ios": { "offering": { "platform": "IOS", "type": "RECURRING", "id": "offering-id-ios", "description": "iOS Unmetered Device Slot" }, "quantity": 1 } }, "nextPeriod": { "offering-id-ios": { "effectiveOn": 1459468800.0, "offering": { "platform": "IOS", "type": "RECURRING", "id": "offering-id-ios", "description": "iOS Unmetered Device Slot" }, "quantity": 1 } }}






https://docs.aws.amazon.com/goto/aws-cli/devicefarm-2015-06-23/GetOfferingStatus

https://docs.aws.amazon.com/goto/DotNetSDKV3/devicefarm-2015-06-23/GetOfferingStatus

https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/GetOfferingStatus

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/GetOfferingStatus

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/GetOfferingStatus

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/devicefarm-2015-06-23/GetOfferingStatus

https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/GetOfferingStatus

https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/GetOfferingStatus

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/GetOfferingStatus

AWS Device Farm API ReferenceGetProject

GetProjectGets information about a project.




arn (p. 76)

The project's ARN.

Type: String


Pattern: ârn:.+

Required: Yes

Response Syntax{ "project": { "arn": "string", "created": number, "defaultJobTimeoutMinutes": number, "name": "string" }}



project (p. 76)

The project to get information about.





ArgumentException












https://docs.aws.amazon.com/goto/aws-cli/devicefarm-2015-06-23/GetProject

https://docs.aws.amazon.com/goto/DotNetSDKV3/devicefarm-2015-06-23/GetProject

https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/GetProject

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/GetProject

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/GetProject

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/devicefarm-2015-06-23/GetProject

https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/GetProject

https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/GetProject

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/GetProject

AWS Device Farm API ReferenceGetRemoteAccessSession

GetRemoteAccessSessionReturns a link to a currently running remote access session.

Request Syntax

{ "arn": "string"}



arn (p. 78)

The Amazon Resource Name (ARN) of the remote access session about which you want to get sessioninformation.

Type: String


Pattern: ârn:.+

Required: Yes

Response Syntax

{ "remoteAccessSession": { "arn": "string", "billingMethod": "string", "clientId": "string", "created": number, "device": { "arn": "string", "availability": "string", "carrier": "string", "cpu": { "architecture": "string", "clock": number, "frequency": "string" }, "fleetName": "string", "fleetType": "string", "formFactor": "string", "heapSize": number, "image": "string", "instances": [ { "arn": "string",



"deviceArn": "string", "instanceProfile": { "arn": "string", "description": "string", "excludeAppPackagesFromCleanup": [ "string" ], "name": "string", "packageCleanup": boolean, "rebootAfterUse": boolean }, "labels": [ "string" ], "status": "string", "udid": "string" } ], "manufacturer": "string", "memory": number, "model": "string", "modelId": "string", "name": "string", "os": "string", "platform": "string", "radio": "string", "remoteAccessEnabled": boolean, "remoteDebugEnabled": boolean, "resolution": { "height": number, "width": number } }, "deviceMinutes": { "metered": number, "total": number, "unmetered": number }, "deviceUdid": "string", "endpoint": "string", "hostAddress": "string", "instanceArn": "string", "interactionMode": "string", "message": "string", "name": "string", "remoteDebugEnabled": boolean, "remoteRecordAppArn": "string", "remoteRecordEnabled": boolean, "result": "string", "skipAppResign": boolean, "started": number, "status": "string", "stopped": number }}




A container that lists detailed information about the remote access session.





ArgumentException












https://docs.aws.amazon.com/goto/aws-cli/devicefarm-2015-06-23/GetRemoteAccessSession

https://docs.aws.amazon.com/goto/DotNetSDKV3/devicefarm-2015-06-23/GetRemoteAccessSession

https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/GetRemoteAccessSession

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/GetRemoteAccessSession

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/GetRemoteAccessSession

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/devicefarm-2015-06-23/GetRemoteAccessSession

https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/GetRemoteAccessSession

https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/GetRemoteAccessSession

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/GetRemoteAccessSession

AWS Device Farm API ReferenceGetRun

GetRunGets information about a run.

Request Syntax

{ "arn": "string"}



arn (p. 81)

The run's ARN.

Type: String


Pattern: ârn:.+

Required: Yes

Response Syntax

{ "run": { "appUpload": "string", "arn": "string", "billingMethod": "string", "completedJobs": number, "counters": { "errored": number, "failed": number, "passed": number, "skipped": number, "stopped": number, "total": number, "warned": number }, "created": number, "customerArtifactPaths": { "androidPaths": [ "string" ], "deviceHostPaths": [ "string" ], "iosPaths": [ "string" ] }, "deviceMinutes": { "metered": number, "total": number,



"unmetered": number }, "devicePoolArn": "string", "deviceSelectionResult": { "filters": [ { "attribute": "string", "operator": "string", "values": [ "string" ] } ], "matchedDevicesCount": number, "maxDevices": number }, "eventCount": number, "jobTimeoutMinutes": number, "locale": "string", "location": { "latitude": number, "longitude": number }, "message": "string", "name": "string", "networkProfile": { "arn": "string", "description": "string", "downlinkBandwidthBits": number, "downlinkDelayMs": number, "downlinkJitterMs": number, "downlinkLossPercent": number, "name": "string", "type": "string", "uplinkBandwidthBits": number, "uplinkDelayMs": number, "uplinkJitterMs": number, "uplinkLossPercent": number }, "parsingResultUrl": "string", "platform": "string", "radios": { "bluetooth": boolean, "gps": boolean, "nfc": boolean, "wifi": boolean }, "result": "string", "resultCode": "string", "seed": number, "skipAppResign": boolean, "started": number, "status": "string", "stopped": number, "testSpecArn": "string", "totalJobs": number, "type": "string", "webUrl": "string" }}





run (p. 81)

The run to get results from.

Type: Run (p. 293) object


ArgumentException












https://docs.aws.amazon.com/goto/aws-cli/devicefarm-2015-06-23/GetRun

https://docs.aws.amazon.com/goto/DotNetSDKV3/devicefarm-2015-06-23/GetRun

https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/GetRun

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/GetRun

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/GetRun

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/devicefarm-2015-06-23/GetRun

https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/GetRun

https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/GetRun

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/GetRun

AWS Device Farm API ReferenceGetSuite

GetSuiteGets information about a suite.




arn (p. 84)

The suite's ARN.

Type: String


Pattern: ârn:.+

Required: Yes

Response Syntax{ "suite": { "arn": "string", "counters": { "errored": number, "failed": number, "passed": number, "skipped": number, "stopped": number, "total": number, "warned": number }, "created": number, "deviceMinutes": { "metered": number, "total": number, "unmetered": number }, "message": "string", "name": "string", "result": "string", "started": number, "status": "string", "stopped": number, "type": "string" }



}



suite (p. 84)

A collection of one or more tests.

Type: Suite (p. 306) object


ArgumentException












https://docs.aws.amazon.com/goto/aws-cli/devicefarm-2015-06-23/GetSuite

https://docs.aws.amazon.com/goto/DotNetSDKV3/devicefarm-2015-06-23/GetSuite

https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/GetSuite

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/GetSuite

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/GetSuite

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/devicefarm-2015-06-23/GetSuite

https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/GetSuite

https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/GetSuite

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/GetSuite



AWS Device Farm API ReferenceGetTest

GetTestGets information about a test.




arn (p. 87)

The test's ARN.

Type: String


Pattern: ârn:.+

Required: Yes

Response Syntax{ "test": { "arn": "string", "counters": { "errored": number, "failed": number, "passed": number, "skipped": number, "stopped": number, "total": number, "warned": number }, "created": number, "deviceMinutes": { "metered": number, "total": number, "unmetered": number }, "message": "string", "name": "string", "result": "string", "started": number, "status": "string", "stopped": number, "type": "string" }



}



test (p. 87)

A test condition that is evaluated.

Type: Test (p. 310) object


ArgumentException












https://docs.aws.amazon.com/goto/aws-cli/devicefarm-2015-06-23/GetTest

https://docs.aws.amazon.com/goto/DotNetSDKV3/devicefarm-2015-06-23/GetTest

https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/GetTest

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/GetTest

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/GetTest

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/devicefarm-2015-06-23/GetTest

https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/GetTest

https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/GetTest

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/GetTest



AWS Device Farm API ReferenceGetTestGridProject

GetTestGridProjectRetrieves information about a Selenium testing project.

Request Syntax

{ "projectArn": "string"}



projectArn (p. 90)

The ARN of the Selenium testing project, from either CreateTestGridProject (p. 21) orListTestGridProjects (p. 157).

Type: String



Required: Yes

Response Syntax

{ "testGridProject": { "arn": "string", "created": number, "description": "string", "name": "string" }}




A TestGridProject (p. 313).





ArgumentException











https://docs.aws.amazon.com/goto/aws-cli/devicefarm-2015-06-23/GetTestGridProject

https://docs.aws.amazon.com/goto/DotNetSDKV3/devicefarm-2015-06-23/GetTestGridProject

https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/GetTestGridProject

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/GetTestGridProject

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/GetTestGridProject

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/devicefarm-2015-06-23/GetTestGridProject

https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/GetTestGridProject

https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/GetTestGridProject

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/GetTestGridProject

AWS Device Farm API ReferenceGetTestGridSession

GetTestGridSessionA session is an instance of a browser created through a RemoteWebDriver with the URL fromCreateTestGridUrl:url (p. 24). You can use the following to look up sessions:

• The session ARN (GetTestGridSession:sessionArn (p. 92)).• The project ARN and a session ID (GetTestGridSession:projectArn (p. 92) and

GetTestGridSession:sessionId (p. 92)).

Request Syntax{ "projectArn": "string", "sessionArn": "string", "sessionId": "string"}



projectArn (p. 92)

The ARN for the project that this session belongs to. See CreateTestGridProject (p. 21) andListTestGridProjects (p. 157).

Type: String



Required: NosessionArn (p. 92)

An ARN that uniquely identifies a TestGridSession (p. 314).

Type: String



Required: NosessionId (p. 92)

An ID associated with this session.

Type: String


Pattern: .*\S.*



Required: No

Response Syntax{ "testGridSession": { "arn": "string", "billingMinutes": number, "created": number, "ended": number, "seleniumProperties": "string", "status": "string" }}



testGridSession (p. 93)

The TestGridSession (p. 314) that was requested.

Type: TestGridSession (p. 314) object


ArgumentException








• AWS Command Line Interface• AWS SDK for .NET



https://docs.aws.amazon.com/goto/aws-cli/devicefarm-2015-06-23/GetTestGridSession

https://docs.aws.amazon.com/goto/DotNetSDKV3/devicefarm-2015-06-23/GetTestGridSession


• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3


https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/GetTestGridSession

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/GetTestGridSession

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/GetTestGridSession

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/devicefarm-2015-06-23/GetTestGridSession

https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/GetTestGridSession

https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/GetTestGridSession

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/GetTestGridSession

AWS Device Farm API ReferenceGetUpload

GetUploadGets information about an upload.




arn (p. 95)

The upload's ARN.

Type: String


Pattern: ârn:.+

Required: Yes




upload (p. 95)

An app or a set of one or more tests to upload or that have been uploaded.





ArgumentException












https://docs.aws.amazon.com/goto/aws-cli/devicefarm-2015-06-23/GetUpload

https://docs.aws.amazon.com/goto/DotNetSDKV3/devicefarm-2015-06-23/GetUpload

https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/GetUpload

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/GetUpload

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/GetUpload

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/devicefarm-2015-06-23/GetUpload

https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/GetUpload

https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/GetUpload

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/GetUpload

AWS Device Farm API ReferenceGetVPCEConfiguration

GetVPCEConfigurationReturns information about the configuration settings for your Amazon Virtual Private Cloud (VPC)endpoint.




arn (p. 97)

The Amazon Resource Name (ARN) of the VPC endpoint configuration you want to describe.

Type: String


Pattern: ârn:.+

Required: Yes










ArgumentException










https://docs.aws.amazon.com/goto/aws-cli/devicefarm-2015-06-23/GetVPCEConfiguration

https://docs.aws.amazon.com/goto/DotNetSDKV3/devicefarm-2015-06-23/GetVPCEConfiguration

https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/GetVPCEConfiguration

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/GetVPCEConfiguration

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/GetVPCEConfiguration

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/devicefarm-2015-06-23/GetVPCEConfiguration

https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/GetVPCEConfiguration

https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/GetVPCEConfiguration

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/GetVPCEConfiguration

AWS Device Farm API ReferenceInstallToRemoteAccessSession

InstallToRemoteAccessSessionInstalls an application to the device in a remote access session. For Android applications, the file must bein .apk format. For iOS applications, the file must be in .ipa format.

Request Syntax{ "appArn": "string", "remoteAccessSessionArn": "string"}



appArn (p. 99)

The ARN of the app about which you are requesting information.

Type: String


Pattern: ârn:.+

Required: YesremoteAccessSessionArn (p. 99)

The Amazon Resource Name (ARN) of the remote access session about which you are requestinginformation.

Type: String


Pattern: ârn:.+

Required: Yes

Response Syntax{ "appUpload": { "arn": "string", "category": "string", "contentType": "string", "created": number, "message": "string", "metadata": "string", "name": "string", "status": "string", "type": "string",



"url": "string" }}



appUpload (p. 99)

An app to upload or that has been uploaded.



ArgumentException










• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python


https://docs.aws.amazon.com/goto/aws-cli/devicefarm-2015-06-23/InstallToRemoteAccessSession

https://docs.aws.amazon.com/goto/DotNetSDKV3/devicefarm-2015-06-23/InstallToRemoteAccessSession

https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/InstallToRemoteAccessSession

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/InstallToRemoteAccessSession

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/InstallToRemoteAccessSession

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/devicefarm-2015-06-23/InstallToRemoteAccessSession

https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/InstallToRemoteAccessSession

https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/InstallToRemoteAccessSession


• AWS SDK for Ruby V3


https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/InstallToRemoteAccessSession

AWS Device Farm API ReferenceListArtifacts

ListArtifactsGets information about artifacts.

Request Syntax{ "arn": "string", "nextToken": "string", "type": "string"}



arn (p. 102)

The run, job, suite, or test ARN.

Type: String


Pattern: ârn:.+

Required: Yes

nextToken (p. 102)


Type: String


Required: No

type (p. 102)

The artifacts' type.

Allowed values include:

• FILE

• LOG

• SCREENSHOT

Type: String

Valid Values: SCREENSHOT | FILE | LOG

Required: Yes



Response Syntax{ "artifacts": [ { "arn": "string", "extension": "string", "name": "string", "type": "string", "url": "string" } ], "nextToken": "string"}



artifacts (p. 103)

Information about the artifacts.

Type: Array of Artifact (p. 235) objects

nextToken (p. 103)

If the number of items that are returned is significantly large, this is an identifier that is alsoreturned. It can be used in a subsequent call to this operation to return the next set of items in thelist.

Type: String



ArgumentException






NotFoundException











https://docs.aws.amazon.com/goto/aws-cli/devicefarm-2015-06-23/ListArtifacts

https://docs.aws.amazon.com/goto/DotNetSDKV3/devicefarm-2015-06-23/ListArtifacts

https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/ListArtifacts

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/ListArtifacts

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/ListArtifacts

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/devicefarm-2015-06-23/ListArtifacts

https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/ListArtifacts

https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/ListArtifacts

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/ListArtifacts

AWS Device Farm API ReferenceListDeviceInstances

ListDeviceInstancesReturns information about the private device instances associated with one or more AWS accounts.

Request Syntax{ "maxResults": number, "nextToken": "string"}



maxResults (p. 105)

An integer that specifies the maximum number of items you want to return in the API response.

Type: Integer

Required: NonextToken (p. 105)


Type: String


Required: No

Response Syntax{ "deviceInstances": [ { "arn": "string", "deviceArn": "string", "instanceProfile": { "arn": "string", "description": "string", "excludeAppPackagesFromCleanup": [ "string" ], "name": "string", "packageCleanup": boolean, "rebootAfterUse": boolean }, "labels": [ "string" ], "status": "string", "udid": "string" } ],



"nextToken": "string"}



deviceInstances (p. 105)

An object that contains information about your device instances.

Type: Array of DeviceInstance (p. 249) objectsnextToken (p. 105)

An identifier that can be used in the next call to this operation to return the next set of items in thelist.

Type: String



ArgumentException












https://docs.aws.amazon.com/goto/aws-cli/devicefarm-2015-06-23/ListDeviceInstances

https://docs.aws.amazon.com/goto/DotNetSDKV3/devicefarm-2015-06-23/ListDeviceInstances

https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/ListDeviceInstances




https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/ListDeviceInstances

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/ListDeviceInstances

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/devicefarm-2015-06-23/ListDeviceInstances

https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/ListDeviceInstances

https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/ListDeviceInstances

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/ListDeviceInstances

AWS Device Farm API ReferenceListDevicePools

ListDevicePoolsGets information about device pools.




arn (p. 108)

The project ARN.

Type: String


Pattern: ârn:.+

Required: YesnextToken (p. 108)


Type: String


Required: Notype (p. 108)

The device pools' type.

Allowed values include:• CURATED: A device pool that is created and managed by AWS Device Farm.• PRIVATE: A device pool that is created and managed by the device pool developer.

Type: String


Required: No

Response Syntax{



"devicePools": [ { "arn": "string", "description": "string", "maxDevices": number, "name": "string", "rules": [ { "attribute": "string", "operator": "string", "value": "string" } ], "type": "string" } ], "nextToken": "string"}



devicePools (p. 108)

Information about the device pools.

Type: Array of DevicePool (p. 252) objectsnextToken (p. 108)


Type: String



ArgumentException















https://docs.aws.amazon.com/goto/aws-cli/devicefarm-2015-06-23/ListDevicePools

https://docs.aws.amazon.com/goto/DotNetSDKV3/devicefarm-2015-06-23/ListDevicePools

https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/ListDevicePools

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/ListDevicePools

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/ListDevicePools

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/devicefarm-2015-06-23/ListDevicePools

https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/ListDevicePools

https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/ListDevicePools

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/ListDevicePools

AWS Device Farm API ReferenceListDevices

ListDevicesGets information about unique device types.

Request Syntax{ "arn": "string", "filters": [ { "attribute": "string", "operator": "string", "values": [ "string" ] } ], "nextToken": "string"}



arn (p. 111)

The Amazon Resource Name (ARN) of the project.

Type: String


Pattern: ârn:.+

Required: Nofilters (p. 111)

Used to select a set of devices. A filter is made up of an attribute, an operator, and one or morevalues.• Attribute: The aspect of a device such as platform or model used as the selection criteria in a

device filter.

Allowed values include:• ARN: The Amazon Resource Name (ARN) of the device (for example,arn:aws:devicefarm:us-west-2::device:12345Example).

• PLATFORM: The device platform. Valid values are ANDROID or IOS.• OS_VERSION: The operating system version (for example, 10.3.2).• MODEL: The device model (for example, iPad 5th Gen).• AVAILABILITY: The current availability of the device. Valid values are AVAILABLE,

HIGHLY_AVAILABLE, BUSY, or TEMPORARY_NOT_AVAILABLE.• FORM_FACTOR: The device form factor. Valid values are PHONE or TABLET.• MANUFACTURER: The device manufacturer (for example, Apple).• REMOTE_ACCESS_ENABLED: Whether the device is enabled for remote access. Valid values are

TRUE or FALSE.



• REMOTE_DEBUG_ENABLED: Whether the device is enabled for remote debugging. Valid valuesare TRUE or FALSE. Because remote debugging is no longer supported, this attribute is ignored.

• INSTANCE_ARN: The Amazon Resource Name (ARN) of the device instance.• INSTANCE_LABELS: The label of the device instance.• FLEET_TYPE: The fleet type. Valid values are PUBLIC or PRIVATE.

• Operator: The filter operator.• The EQUALS operator is available for every attribute except INSTANCE_LABELS.• The CONTAINS operator is available for the INSTANCE_LABELS and MODEL attributes.• The IN and NOT_IN operators are available for the ARN, OS_VERSION, MODEL,

MANUFACTURER, and INSTANCE_ARN attributes.• The LESS_THAN, GREATER_THAN, LESS_THAN_OR_EQUALS, and GREATER_THAN_OR_EQUALS

operators are also available for the OS_VERSION attribute.• Values: An array of one or more filter values.

• The IN and NOT_IN operators take a values array that has one or more elements.• The other operators require an array with a single element.• In a request, the AVAILABILITY attribute takes the following values: AVAILABLE,

HIGHLY_AVAILABLE, BUSY, or TEMPORARY_NOT_AVAILABLE.

Type: Array of DeviceFilter (p. 246) objects



Type: String


Required: No

Response Syntax{ "devices": [ { "arn": "string", "availability": "string", "carrier": "string", "cpu": { "architecture": "string", "clock": number, "frequency": "string" }, "fleetName": "string", "fleetType": "string", "formFactor": "string", "heapSize": number, "image": "string", "instances": [ { "arn": "string", "deviceArn": "string", "instanceProfile": { "arn": "string",




"description": "string", "excludeAppPackagesFromCleanup": [ "string" ], "name": "string", "packageCleanup": boolean, "rebootAfterUse": boolean }, "labels": [ "string" ], "status": "string", "udid": "string" } ], "manufacturer": "string", "memory": number, "model": "string", "modelId": "string", "name": "string", "os": "string", "platform": "string", "radio": "string", "remoteAccessEnabled": boolean, "remoteDebugEnabled": boolean, "resolution": { "height": number, "width": number } } ], "nextToken": "string"}



devices (p. 112)

Information about the devices.

Type: Array of Device (p. 242) objectsnextToken (p. 112)


Type: String



ArgumentException















https://docs.aws.amazon.com/goto/aws-cli/devicefarm-2015-06-23/ListDevices

https://docs.aws.amazon.com/goto/DotNetSDKV3/devicefarm-2015-06-23/ListDevices

https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/ListDevices

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/ListDevices

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/ListDevices

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/devicefarm-2015-06-23/ListDevices

https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/ListDevices

https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/ListDevices

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/ListDevices

AWS Device Farm API ReferenceListInstanceProfiles

ListInstanceProfilesReturns information about all the instance profiles in an AWS account.




maxResults (p. 115)


Type: Integer



Type: String


Required: No

Response Syntax{ "instanceProfiles": [ { "arn": "string", "description": "string", "excludeAppPackagesFromCleanup": [ "string" ], "name": "string", "packageCleanup": boolean, "rebootAfterUse": boolean } ], "nextToken": "string"}





instanceProfiles (p. 115)

An object that contains information about your instance profiles.

Type: Array of InstanceProfile (p. 260) objectsnextToken (p. 115)

An identifier that can be used in the next call to this operation to return the next set of items in thelist.

Type: String



ArgumentException












https://docs.aws.amazon.com/goto/aws-cli/devicefarm-2015-06-23/ListInstanceProfiles

https://docs.aws.amazon.com/goto/DotNetSDKV3/devicefarm-2015-06-23/ListInstanceProfiles

https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/ListInstanceProfiles

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/ListInstanceProfiles

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/ListInstanceProfiles

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/devicefarm-2015-06-23/ListInstanceProfiles

https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/ListInstanceProfiles

https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/ListInstanceProfiles

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/ListInstanceProfiles



AWS Device Farm API ReferenceListJobs

ListJobsGets information about jobs for a given test run.

Request Syntax

{ "arn": "string", "nextToken": "string"}



arn (p. 118)

The run's Amazon Resource Name (ARN).

Type: String


Pattern: ârn:.+

Required: Yes

nextToken (p. 118)


Type: String


Required: No

Response Syntax

{ "jobs": [ { "arn": "string", "counters": { "errored": number, "failed": number, "passed": number, "skipped": number, "stopped": number, "total": number, "warned": number



}, "created": number, "device": { "arn": "string", "availability": "string", "carrier": "string", "cpu": { "architecture": "string", "clock": number, "frequency": "string" }, "fleetName": "string", "fleetType": "string", "formFactor": "string", "heapSize": number, "image": "string", "instances": [ { "arn": "string", "deviceArn": "string", "instanceProfile": { "arn": "string", "description": "string", "excludeAppPackagesFromCleanup": [ "string" ], "name": "string", "packageCleanup": boolean, "rebootAfterUse": boolean }, "labels": [ "string" ], "status": "string", "udid": "string" } ], "manufacturer": "string", "memory": number, "model": "string", "modelId": "string", "name": "string", "os": "string", "platform": "string", "radio": "string", "remoteAccessEnabled": boolean, "remoteDebugEnabled": boolean, "resolution": { "height": number, "width": number } }, "deviceMinutes": { "metered": number, "total": number, "unmetered": number }, "instanceArn": "string", "message": "string", "name": "string", "result": "string", "started": number, "status": "string", "stopped": number, "type": "string", "videoCapture": boolean, "videoEndpoint": "string" } ], "nextToken": "string"



}



jobs (p. 118)

Information about the jobs.

Type: Array of Job (p. 262) objectsnextToken (p. 118)


Type: String



ArgumentException












https://docs.aws.amazon.com/goto/aws-cli/devicefarm-2015-06-23/ListJobs

https://docs.aws.amazon.com/goto/DotNetSDKV3/devicefarm-2015-06-23/ListJobs

https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/ListJobs




https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/ListJobs

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/ListJobs

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/devicefarm-2015-06-23/ListJobs

https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/ListJobs

https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/ListJobs

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/ListJobs

AWS Device Farm API ReferenceListNetworkProfiles

ListNetworkProfilesReturns the list of available network profiles.




arn (p. 122)

The Amazon Resource Name (ARN) of the project for which you want to list network profiles.

Type: String


Pattern: ârn:.+



Type: String



The type of network profile to return information about. Valid values are listed here.

Type: String


Required: No

Response Syntax{ "networkProfiles": [ { "arn": "string",



"description": "string", "downlinkBandwidthBits": number, "downlinkDelayMs": number, "downlinkJitterMs": number, "downlinkLossPercent": number, "name": "string", "type": "string", "uplinkBandwidthBits": number, "uplinkDelayMs": number, "uplinkJitterMs": number, "uplinkLossPercent": number } ], "nextToken": "string"}



networkProfiles (p. 122)

A list of the available network profiles.

Type: Array of NetworkProfile (p. 271) objectsnextToken (p. 122)


Type: String



ArgumentException














https://docs.aws.amazon.com/goto/aws-cli/devicefarm-2015-06-23/ListNetworkProfiles

https://docs.aws.amazon.com/goto/DotNetSDKV3/devicefarm-2015-06-23/ListNetworkProfiles

https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/ListNetworkProfiles

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/ListNetworkProfiles

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/ListNetworkProfiles

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/devicefarm-2015-06-23/ListNetworkProfiles

https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/ListNetworkProfiles

https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/ListNetworkProfiles

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/ListNetworkProfiles

AWS Device Farm API ReferenceListOfferingPromotions

ListOfferingPromotionsReturns a list of offering promotions. Each offering promotion record contains the ID and descriptionof the promotion. The API returns a NotEligible error if the caller is not permitted to invoke theoperation. Contact [email protected] if you must be able to invoke this operation.




nextToken (p. 125)


Type: String


Required: No

Response Syntax{ "nextToken": "string", "offeringPromotions": [ { "description": "string", "id": "string" } ]}



nextToken (p. 125)

An identifier to be used in the next call to this operation, to return the next set of items in the list.

Type: String





offeringPromotions (p. 125)

Information about the offering promotions.

Type: Array of OfferingPromotion (p. 275) objects


ArgumentException














https://docs.aws.amazon.com/goto/aws-cli/devicefarm-2015-06-23/ListOfferingPromotions

https://docs.aws.amazon.com/goto/DotNetSDKV3/devicefarm-2015-06-23/ListOfferingPromotions

https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/ListOfferingPromotions

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/ListOfferingPromotions

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/ListOfferingPromotions

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/devicefarm-2015-06-23/ListOfferingPromotions

https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/ListOfferingPromotions

https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/ListOfferingPromotions

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/ListOfferingPromotions

AWS Device Farm API ReferenceListOfferings

ListOfferingsReturns a list of products or offerings that the user can manage through the API. Each offeringrecord indicates the recurring price per unit and the frequency for that offering. The API returns aNotEligible error if the user is not permitted to invoke the operation. If you must be able to invokethis operation, contact [email protected].

Request Syntax

{ "nextToken": "string"}



nextToken (p. 127)


Type: String


Required: No

Response Syntax

{ "nextToken": "string", "offerings": [ { "description": "string", "id": "string", "platform": "string", "recurringCharges": [ { "cost": { "amount": number, "currencyCode": "string" }, "frequency": "string" } ], "type": "string" } ]}






nextToken (p. 127)


Type: String


offerings (p. 127)

A value that represents the list offering results.

Type: Array of Offering (p. 273) objects


ArgumentException






NotEligibleException



NotFoundException






Example

The following example response shows a list of device offerings for the user's account.



Sample Response

{ "offerings": [ { "recurringCharges": [ { "cost": { "amount": 250.0, "currencyCode": "USD" }, "frequency": "MONTHLY" } ], "platform": "IOS", "type": "RECURRING", "id": "offering-id-ios", "description": "iOS Unmetered Device Slot" }, { "recurringCharges": [ { "cost": { "amount": 250.0, "currencyCode": "USD" }, "frequency": "MONTHLY" } ], "platform": "ANDROID", "type": "RECURRING", "id": "offering-id-android", "description": "Android Unmetered Device Slot" } ]}




https://docs.aws.amazon.com/goto/aws-cli/devicefarm-2015-06-23/ListOfferings

https://docs.aws.amazon.com/goto/DotNetSDKV3/devicefarm-2015-06-23/ListOfferings

https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/ListOfferings

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/ListOfferings

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/ListOfferings

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/devicefarm-2015-06-23/ListOfferings

https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/ListOfferings

https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/ListOfferings

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/ListOfferings

AWS Device Farm API ReferenceListOfferingTransactions

ListOfferingTransactionsReturns a list of all historical purchases, renewals, and system renewal transactions for an AWS account.The list is paginated and ordered by a descending timestamp (most recent transactions are first). The APIreturns a NotEligible error if the user is not permitted to invoke the operation. If you must be able toinvoke this operation, contact [email protected].




nextToken (p. 130)


Type: String


Required: No

Response Syntax{ "nextToken": "string", "offeringTransactions": [ { "cost": { "amount": number, "currencyCode": "string" }, "createdOn": number, "offeringPromotionId": "string", "offeringStatus": { "effectiveOn": number, "offering": { "description": "string", "id": "string", "platform": "string", "recurringCharges": [ { "cost": { "amount": number, "currencyCode": "string" }, "frequency": "string" }




], "type": "string" }, "quantity": number, "type": "string" }, "transactionId": "string" } ]}



nextToken (p. 130)


Type: String

Length Constraints: Minimum length of 4. Maximum length of 1024.offeringTransactions (p. 130)

The audit log of subscriptions you have purchased and modified through AWS Device Farm.

Type: Array of OfferingTransaction (p. 277) objects


ArgumentException













Example

The following example response contains all the transactions that the customer has made.

Sample Response

{ "offeringTransactions": [ { "createdOn": 1458596241.001, "offeringStatus": { "effectiveOn": 1458596240.974, "type": "PURCHASE", "offering": { "platform": "IOS", "type": "RECURRING", "id": "offering-id-ios", "description": "iOS Unmetered Device Slot" }, "quantity": 1 }, "cost": { "amount": 80.65, "currencyCode": "USD" }, "transactionId": "transaction-id" }, { "createdOn": 1458587590.308, "offeringStatus": { "effectiveOn": 1458587590.24, "type": "PURCHASE", "offering": { "platform": "IOS", "type": "RECURRING", "id": "offering-id-ios", "description": "iOS Unmetered Device Slot" }, "quantity": 1 }, "cost": { "amount": 80.65, "currencyCode": "USD" }, "transactionId": "transaction-id" }, { "createdOn": 1458541943.395, "offeringStatus": { "effectiveOn": 1458541943.34, "type": "PURCHASE", "offering": { "platform": "ANDROID", "type": "RECURRING", "id": "offering-id-android", "description": "Android Unmetered Device Slot" }, "quantity": 10 }, "cost": {



"amount": 806.45, "currencyCode": "USD" }, "transactionId": "transaction-id" }, { "createdOn": 1458584276.849, "offeringStatus": { "effectiveOn": 1458584276.811, "type": "PURCHASE", "offering": { "platform": "ANDROID", "type": "RECURRING", "id": "offering-id-android", "description": "Android Unmetered Device Slot" }, "quantity": 2 }, "cost": { "amount": 161.29, "currencyCode": "USD" }, "transactionId": "transaction-id" }, { "createdOn": 1458592981.171, "offeringStatus": { "effectiveOn": 1458592981.137, "type": "PURCHASE", "offering": { "platform": "IOS", "type": "RECURRING", "id": "offering-id-ios", "description": "iOS Unmetered Device Slot" }, "quantity": 1 }, "cost": { "amount": 80.65, "currencyCode": "USD" }, "transactionId": "transaction-id" }, { "createdOn": 1458591927.511, "offeringStatus": { "effectiveOn": 1458591927.468, "type": "PURCHASE", "offering": { "platform": "IOS", "type": "RECURRING", "id": "offering-id-ios", "description": "iOS Unmetered Device Slot" }, "quantity": 1 }, "cost": { "amount": 80.65, "currencyCode": "USD" }, "transactionId": "transaction-id" }, { "createdOn": 1458581880.117, "offeringStatus": { "effectiveOn": 1459468800.0,



"type": "RENEW", "offering": { "platform": "IOS", "type": "RECURRING", "id": "offering-id-ios", "description": "iOS Unmetered Device Slot" }, "quantity": 0 }, "cost": { "amount": 0.0, "currencyCode": "USD" }, "transactionId": "transaction-id" }, { "createdOn": 1458587390.031, "offeringStatus": { "effectiveOn": 1458587390.008, "type": "PURCHASE", "offering": { "platform": "ANDROID", "type": "RECURRING", "id": "offering-id-android", "description": "Android Unmetered Device Slot" }, "quantity": 1 }, "cost": { "amount": 80.65, "currencyCode": "USD" }, "transactionId": "transaction-id" }, { "createdOn": 1458591927.99, "offeringStatus": { "effectiveOn": 1459468800.0, "type": "RENEW", "offering": { "platform": "ANDROID", "type": "RECURRING", "id": "offering-id-android", "description": "Android Unmetered Device Slot" }, "quantity": 3 }, "cost": { "amount": 750.0, "currencyCode": "USD" }, "transactionId": "transaction-id" }, { "createdOn": 1458581580.426, "offeringStatus": { "effectiveOn": 1458581580.377, "type": "PURCHASE", "offering": { "platform": "ANDROID", "type": "RECURRING", "id": "offering-id-android", "description": "Android Unmetered Device Slot" }, "quantity": 1 },



"cost": { "amount": 80.65, "currencyCode": "USD" }, "transactionId": "transaction-id" }, { "createdOn": 1458582235.794, "offeringStatus": { "effectiveOn": 1459468800.0, "type": "RENEW", "offering": { "platform": "ANDROID", "type": "RECURRING", "id": "offering-id-android", "description": "Android Unmetered Device Slot" }, "quantity": 1 }, "cost": { "amount": 250.0, "currencyCode": "USD" }, "transactionId": "transaction-id" }, { "createdOn": 1458581580.429, "offeringStatus": { "effectiveOn": 1458581580.372, "type": "PURCHASE", "offering": { "platform": "IOS", "type": "RECURRING", "id": "offering-id-ios", "description": "iOS Unmetered Device Slot" }, "quantity": 1 }, "cost": { "amount": 80.65, "currencyCode": "USD" }, "transactionId": "transaction-id" }, { "createdOn": 1458593014.881, "offeringStatus": { "effectiveOn": 1458593014.856, "type": "PURCHASE", "offering": { "platform": "IOS", "type": "RECURRING", "id": "offering-id-ios", "description": "iOS Unmetered Device Slot" }, "quantity": 2 }, "cost": { "amount": 161.29, "currencyCode": "USD" }, "transactionId": "transaction-id" }, { "createdOn": 1458581880.415, "offeringStatus": {



"effectiveOn": 1459468800.0, "type": "RENEW", "offering": { "platform": "ANDROID", "type": "RECURRING", "id": "offering-id-android", "description": "Android Unmetered Device Slot" }, "quantity": 0 }, "cost": { "amount": 0.0, "currencyCode": "USD" }, "transactionId": "transaction-id" }, { "createdOn": 1458591927.662, "offeringStatus": { "effectiveOn": 1458591927.491, "type": "PURCHASE", "offering": { "platform": "ANDROID", "type": "RECURRING", "id": "offering-id-android", "description": "Android Unmetered Device Slot" }, "quantity": 1 }, "cost": { "amount": 80.65, "currencyCode": "USD" }, "transactionId": "transaction-id" }, { "createdOn": 1458582235.834, "offeringStatus": { "effectiveOn": 1459468800.0, "type": "RENEW", "offering": { "platform": "IOS", "type": "RECURRING", "id": "offering-id-ios", "description": "iOS Unmetered Device Slot" }, "quantity": 1 }, "cost": { "amount": 250.0, "currencyCode": "USD" }, "transactionId": "transaction-id" }, { "createdOn": 1458583642.184, "offeringStatus": { "effectiveOn": 1459468800.0, "type": "RENEW", "offering": { "platform": "IOS", "type": "RECURRING", "id": "offering-id-ios", "description": "iOS Unmetered Device Slot" }, "quantity": 0



}, "cost": { "amount": 0.0, "currencyCode": "USD" }, "transactionId": "transaction-id" }, { "createdOn": 1458581880.007, "offeringStatus": { "effectiveOn": 1458581879.937, "type": "PURCHASE", "offering": { "platform": "ANDROID", "type": "RECURRING", "id": "offering-id-android", "description": "Android Unmetered Device Slot" }, "quantity": 1 }, "cost": { "amount": 80.65, "currencyCode": "USD" }, "transactionId": "transaction-id" } ]}




https://docs.aws.amazon.com/goto/aws-cli/devicefarm-2015-06-23/ListOfferingTransactions

https://docs.aws.amazon.com/goto/DotNetSDKV3/devicefarm-2015-06-23/ListOfferingTransactions

https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/ListOfferingTransactions

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/ListOfferingTransactions

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/ListOfferingTransactions

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/devicefarm-2015-06-23/ListOfferingTransactions

https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/ListOfferingTransactions

https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/ListOfferingTransactions

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/ListOfferingTransactions

AWS Device Farm API ReferenceListProjects

ListProjectsGets information about projects.

Request Syntax{ "arn": "string", "nextToken": "string"}



arn (p. 138)

Optional. If no Amazon Resource Name (ARN) is specified, then AWS Device Farm returns a list of allprojects for the AWS account. You can also specify a project ARN.

Type: String


Pattern: ârn:.+

Required: No

nextToken (p. 138)


Type: String


Required: No

Response Syntax{ "nextToken": "string", "projects": [ { "arn": "string", "created": number, "defaultJobTimeoutMinutes": number, "name": "string" } ]}





nextToken (p. 138)


Type: String

Length Constraints: Minimum length of 4. Maximum length of 1024.projects (p. 138)

Information about the projects.

Type: Array of Project (p. 281) objects


ArgumentException










• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java


https://docs.aws.amazon.com/goto/aws-cli/devicefarm-2015-06-23/ListProjects

https://docs.aws.amazon.com/goto/DotNetSDKV3/devicefarm-2015-06-23/ListProjects

https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/ListProjects

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/ListProjects

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/ListProjects


• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3


https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/devicefarm-2015-06-23/ListProjects

https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/ListProjects

https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/ListProjects

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/ListProjects

AWS Device Farm API ReferenceListRemoteAccessSessions

ListRemoteAccessSessionsReturns a list of all currently running remote access sessions.




arn (p. 141)

The Amazon Resource Name (ARN) of the project about which you are requesting information.

Type: String


Pattern: ârn:.+



Type: String


Required: No

Response Syntax{ "nextToken": "string", "remoteAccessSessions": [ { "arn": "string", "billingMethod": "string", "clientId": "string", "created": number, "device": { "arn": "string", "availability": "string", "carrier": "string", "cpu": { "architecture": "string", "clock": number, "frequency": "string"



}, "fleetName": "string", "fleetType": "string", "formFactor": "string", "heapSize": number, "image": "string", "instances": [ { "arn": "string", "deviceArn": "string", "instanceProfile": { "arn": "string", "description": "string", "excludeAppPackagesFromCleanup": [ "string" ], "name": "string", "packageCleanup": boolean, "rebootAfterUse": boolean }, "labels": [ "string" ], "status": "string", "udid": "string" } ], "manufacturer": "string", "memory": number, "model": "string", "modelId": "string", "name": "string", "os": "string", "platform": "string", "radio": "string", "remoteAccessEnabled": boolean, "remoteDebugEnabled": boolean, "resolution": { "height": number, "width": number } }, "deviceMinutes": { "metered": number, "total": number, "unmetered": number }, "deviceUdid": "string", "endpoint": "string", "hostAddress": "string", "instanceArn": "string", "interactionMode": "string", "message": "string", "name": "string", "remoteDebugEnabled": boolean, "remoteRecordAppArn": "string", "remoteRecordEnabled": boolean, "result": "string", "skipAppResign": boolean, "started": number, "status": "string", "stopped": number } ]}





nextToken (p. 141)


Type: String

Length Constraints: Minimum length of 4. Maximum length of 1024.remoteAccessSessions (p. 141)

A container that represents the metadata from the service about each remote access session you arerequesting.

Type: Array of RemoteAccessSession (p. 284) objects


ArgumentException










• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java


https://docs.aws.amazon.com/goto/aws-cli/devicefarm-2015-06-23/ListRemoteAccessSessions

https://docs.aws.amazon.com/goto/DotNetSDKV3/devicefarm-2015-06-23/ListRemoteAccessSessions

https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/ListRemoteAccessSessions

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/ListRemoteAccessSessions

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/ListRemoteAccessSessions


• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3


https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/devicefarm-2015-06-23/ListRemoteAccessSessions

https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/ListRemoteAccessSessions

https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/ListRemoteAccessSessions

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/ListRemoteAccessSessions

AWS Device Farm API ReferenceListRuns

ListRunsGets information about runs, given an AWS Device Farm project ARN.




arn (p. 145)

The Amazon Resource Name (ARN) of the project for which you want to list runs.

Type: String


Pattern: ârn:.+



Type: String


Required: No

Response Syntax{ "nextToken": "string", "runs": [ { "appUpload": "string", "arn": "string", "billingMethod": "string", "completedJobs": number, "counters": { "errored": number, "failed": number, "passed": number, "skipped": number, "stopped": number,



"total": number, "warned": number }, "created": number, "customerArtifactPaths": { "androidPaths": [ "string" ], "deviceHostPaths": [ "string" ], "iosPaths": [ "string" ] }, "deviceMinutes": { "metered": number, "total": number, "unmetered": number }, "devicePoolArn": "string", "deviceSelectionResult": { "filters": [ { "attribute": "string", "operator": "string", "values": [ "string" ] } ], "matchedDevicesCount": number, "maxDevices": number }, "eventCount": number, "jobTimeoutMinutes": number, "locale": "string", "location": { "latitude": number, "longitude": number }, "message": "string", "name": "string", "networkProfile": { "arn": "string", "description": "string", "downlinkBandwidthBits": number, "downlinkDelayMs": number, "downlinkJitterMs": number, "downlinkLossPercent": number, "name": "string", "type": "string", "uplinkBandwidthBits": number, "uplinkDelayMs": number, "uplinkJitterMs": number, "uplinkLossPercent": number }, "parsingResultUrl": "string", "platform": "string", "radios": { "bluetooth": boolean, "gps": boolean, "nfc": boolean, "wifi": boolean }, "result": "string", "resultCode": "string", "seed": number, "skipAppResign": boolean, "started": number, "status": "string", "stopped": number, "testSpecArn": "string", "totalJobs": number,



"type": "string", "webUrl": "string" } ]}



nextToken (p. 145)


Type: String

Length Constraints: Minimum length of 4. Maximum length of 1024.runs (p. 145)

Information about the runs.

Type: Array of Run (p. 293) objects


ArgumentException














https://docs.aws.amazon.com/goto/aws-cli/devicefarm-2015-06-23/ListRuns

https://docs.aws.amazon.com/goto/DotNetSDKV3/devicefarm-2015-06-23/ListRuns

https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/ListRuns

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/ListRuns

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/ListRuns

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/devicefarm-2015-06-23/ListRuns

https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/ListRuns

https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/ListRuns

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/ListRuns

AWS Device Farm API ReferenceListSamples

ListSamplesGets information about samples, given an AWS Device Farm job ARN.




arn (p. 149)

The Amazon Resource Name (ARN) of the job used to list samples.

Type: String


Pattern: ârn:.+



Type: String


Required: No

Response Syntax{ "nextToken": "string", "samples": [ { "arn": "string", "type": "string", "url": "string" } ]}





nextToken (p. 149)


Type: String

Length Constraints: Minimum length of 4. Maximum length of 1024.samples (p. 149)

Information about the samples.

Type: Array of Sample (p. 299) objects


ArgumentException










• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python


https://docs.aws.amazon.com/goto/aws-cli/devicefarm-2015-06-23/ListSamples

https://docs.aws.amazon.com/goto/DotNetSDKV3/devicefarm-2015-06-23/ListSamples

https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/ListSamples

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/ListSamples

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/ListSamples

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/devicefarm-2015-06-23/ListSamples

https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/ListSamples

https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/ListSamples




https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/ListSamples

AWS Device Farm API ReferenceListSuites

ListSuitesGets information about test suites for a given job.




arn (p. 152)

The job's Amazon Resource Name (ARN).

Type: String


Pattern: ârn:.+



Type: String


Required: No

Response Syntax{ "nextToken": "string", "suites": [ { "arn": "string", "counters": { "errored": number, "failed": number, "passed": number, "skipped": number, "stopped": number, "total": number, "warned": number



}, "created": number, "deviceMinutes": { "metered": number, "total": number, "unmetered": number }, "message": "string", "name": "string", "result": "string", "started": number, "status": "string", "stopped": number, "type": "string" } ]}



nextToken (p. 152)


Type: String

Length Constraints: Minimum length of 4. Maximum length of 1024.suites (p. 152)

Information about the suites.

Type: Array of Suite (p. 306) objects


ArgumentException















https://docs.aws.amazon.com/goto/aws-cli/devicefarm-2015-06-23/ListSuites

https://docs.aws.amazon.com/goto/DotNetSDKV3/devicefarm-2015-06-23/ListSuites

https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/ListSuites

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/ListSuites

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/ListSuites

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/devicefarm-2015-06-23/ListSuites

https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/ListSuites

https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/ListSuites

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/ListSuites

AWS Device Farm API ReferenceListTagsForResource

ListTagsForResourceList the tags for an AWS Device Farm resource.

Request Syntax{ "ResourceARN": "string"}



ResourceARN (p. 155)

The Amazon Resource Name (ARN) of the resource or resources for which to list tags. You canassociate tags with the following Device Farm resources: PROJECT, RUN, NETWORK_PROFILE,INSTANCE_PROFILE, DEVICE_INSTANCE, SESSION, DEVICE_POOL, DEVICE, andVPCE_CONFIGURATION.

Type: String



Required: Yes

Response Syntax{ "Tags": [ { "Key": "string", "Value": "string" } ]}



Tags (p. 155)

The tags to add to the resource. A tag is an array of key-value pairs. Tag keys can have a maximumcharacter length of 128 characters. Tag values can have a maximum length of 256 characters.

Type: Array of Tag (p. 309) objects



Array Members: Maximum number of 150 items.


ArgumentException










https://docs.aws.amazon.com/goto/aws-cli/devicefarm-2015-06-23/ListTagsForResource

https://docs.aws.amazon.com/goto/DotNetSDKV3/devicefarm-2015-06-23/ListTagsForResource

https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/ListTagsForResource

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/ListTagsForResource

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/ListTagsForResource

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/devicefarm-2015-06-23/ListTagsForResource

https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/ListTagsForResource

https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/ListTagsForResource

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/ListTagsForResource

AWS Device Farm API ReferenceListTestGridProjects

ListTestGridProjectsGets a list of all Selenium testing projects in your account.

Request Syntax{ "maxResult": number, "nextToken": "string"}



maxResult (p. 157)

Return no more than this number of results.

Type: Integer



From a response, used to continue a paginated listing.

Type: String


Required: No

Response Syntax{ "nextToken": "string", "testGridProjects": [ { "arn": "string", "created": number, "description": "string", "name": "string" } ]}





nextToken (p. 157)

Used for pagination. Pass into ListTestGridProjects (p. 157) to get more results in a paginatedrequest.

Type: String

Length Constraints: Minimum length of 4. Maximum length of 1024.testGridProjects (p. 157)

The list of TestGridProjects, based on a ListTestGridProjectsRequest (p. 266).

Type: Array of TestGridProject (p. 313) objects


ArgumentException









https://docs.aws.amazon.com/goto/aws-cli/devicefarm-2015-06-23/ListTestGridProjects

https://docs.aws.amazon.com/goto/DotNetSDKV3/devicefarm-2015-06-23/ListTestGridProjects

https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/ListTestGridProjects

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/ListTestGridProjects

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/ListTestGridProjects

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/devicefarm-2015-06-23/ListTestGridProjects

https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/ListTestGridProjects

https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/ListTestGridProjects

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/ListTestGridProjects

AWS Device Farm API ReferenceListTestGridSessionActions

ListTestGridSessionActionsReturns a list of the actions taken in a TestGridSession (p. 314).

Request Syntax{ "maxResult": number, "nextToken": "string", "sessionArn": "string"}



maxResult (p. 159)

The maximum number of sessions to return per response.

Type: Integer



Pagination token.

Type: String



The ARN of the session to retrieve.

Type: String



Required: Yes

Response Syntax{ "actions": [ { "action": "string",



"duration": number, "requestMethod": "string", "started": number, "statusCode": "string" } ], "nextToken": "string"}



actions (p. 159)

The action taken by the session.

Type: Array of TestGridSessionAction (p. 316) objectsnextToken (p. 159)

Pagination token.

Type: String



ArgumentException











https://docs.aws.amazon.com/goto/aws-cli/devicefarm-2015-06-23/ListTestGridSessionActions

https://docs.aws.amazon.com/goto/DotNetSDKV3/devicefarm-2015-06-23/ListTestGridSessionActions

https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/ListTestGridSessionActions




https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/ListTestGridSessionActions

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/ListTestGridSessionActions

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/devicefarm-2015-06-23/ListTestGridSessionActions

https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/ListTestGridSessionActions

https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/ListTestGridSessionActions

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/ListTestGridSessionActions

AWS Device Farm API ReferenceListTestGridSessionArtifacts

ListTestGridSessionArtifactsRetrieves a list of artifacts created during the session.

Request Syntax{ "maxResult": number, "nextToken": "string", "sessionArn": "string", "type": "string"}



maxResult (p. 162)

The maximum number of results to be returned by a request.

Type: Integer



Pagination token.

Type: String



The ARN of a TestGridSession (p. 314).

Type: String




Limit results to a specified type of artifact.

Type: String

Valid Values: VIDEO | LOG

Required: No



Response Syntax{ "artifacts": [ { "filename": "string", "type": "string", "url": "string" } ], "nextToken": "string"}



artifacts (p. 163)

A list of test grid session artifacts for a TestGridSession (p. 314).

Type: Array of TestGridSessionArtifact (p. 317) objectsnextToken (p. 163)

Pagination token.

Type: String



ArgumentException













https://docs.aws.amazon.com/goto/aws-cli/devicefarm-2015-06-23/ListTestGridSessionArtifacts

https://docs.aws.amazon.com/goto/DotNetSDKV3/devicefarm-2015-06-23/ListTestGridSessionArtifacts

https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/ListTestGridSessionArtifacts

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/ListTestGridSessionArtifacts

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/ListTestGridSessionArtifacts

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/devicefarm-2015-06-23/ListTestGridSessionArtifacts

https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/ListTestGridSessionArtifacts

https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/ListTestGridSessionArtifacts

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/ListTestGridSessionArtifacts

AWS Device Farm API ReferenceListTestGridSessions

ListTestGridSessionsRetrieves a list of sessions for a TestGridProject (p. 313).

Request Syntax{ "creationTimeAfter": number, "creationTimeBefore": number, "endTimeAfter": number, "endTimeBefore": number, "maxResult": number, "nextToken": "string", "projectArn": "string", "status": "string"}



creationTimeAfter (p. 165)

Return only sessions created after this time.

Type: Timestamp

Required: NocreationTimeBefore (p. 165)

Return only sessions created before this time.

Type: Timestamp

Required: NoendTimeAfter (p. 165)

Return only sessions that ended after this time.

Type: Timestamp

Required: NoendTimeBefore (p. 165)

Return only sessions that ended before this time.

Type: Timestamp

Required: NomaxResult (p. 165)

Return only this many results at a time.

Type: Integer





Pagination token.

Type: String



ARN of a TestGridProject (p. 313).

Type: String



Required: Yesstatus (p. 165)

Return only sessions in this state.

Type: String

Valid Values: ACTIVE | CLOSED | ERRORED

Required: No

Response Syntax{ "nextToken": "string", "testGridSessions": [ { "arn": "string", "billingMinutes": number, "created": number, "ended": number, "seleniumProperties": "string", "status": "string" } ]}



nextToken (p. 166)

Pagination token.



Type: String

Length Constraints: Minimum length of 4. Maximum length of 1024.testGridSessions (p. 166)

The sessions that match the criteria in a ListTestGridSessionsRequest (p. 267).

Type: Array of TestGridSession (p. 314) objects


ArgumentException











https://docs.aws.amazon.com/goto/aws-cli/devicefarm-2015-06-23/ListTestGridSessions

https://docs.aws.amazon.com/goto/DotNetSDKV3/devicefarm-2015-06-23/ListTestGridSessions

https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/ListTestGridSessions

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/ListTestGridSessions

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/ListTestGridSessions

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/devicefarm-2015-06-23/ListTestGridSessions

https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/ListTestGridSessions

https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/ListTestGridSessions

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/ListTestGridSessions

AWS Device Farm API ReferenceListTests

ListTestsGets information about tests in a given test suite.




arn (p. 168)

The test suite's Amazon Resource Name (ARN).

Type: String


Pattern: ârn:.+



Type: String


Required: No

Response Syntax{ "nextToken": "string", "tests": [ { "arn": "string", "counters": { "errored": number, "failed": number, "passed": number, "skipped": number, "stopped": number, "total": number, "warned": number



}, "created": number, "deviceMinutes": { "metered": number, "total": number, "unmetered": number }, "message": "string", "name": "string", "result": "string", "started": number, "status": "string", "stopped": number, "type": "string" } ]}



nextToken (p. 168)


Type: String

Length Constraints: Minimum length of 4. Maximum length of 1024.tests (p. 168)

Information about the tests.

Type: Array of Test (p. 310) objects


ArgumentException















https://docs.aws.amazon.com/goto/aws-cli/devicefarm-2015-06-23/ListTests

https://docs.aws.amazon.com/goto/DotNetSDKV3/devicefarm-2015-06-23/ListTests

https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/ListTests

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/ListTests

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/ListTests

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/devicefarm-2015-06-23/ListTests

https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/ListTests

https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/ListTests

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/ListTests

AWS Device Farm API ReferenceListUniqueProblems

ListUniqueProblemsGets information about unique problems, such as exceptions or crashes.

Unique problems are defined as a single instance of an error across a run, job, or suite. For example,if a call in your application consistently raises an exception (OutOfBoundsException inMyActivity.java:386), ListUniqueProblems returns a single entry instead of many individualentries for that exception.




arn (p. 171)

The unique problems' ARNs.

Type: String


Pattern: ârn:.+



Type: String


Required: No

Response Syntax{ "nextToken": "string", "uniqueProblems": { "string" : [ { "message": "string", "problems": [ { "device": {



"arn": "string", "availability": "string", "carrier": "string", "cpu": { "architecture": "string", "clock": number, "frequency": "string" }, "fleetName": "string", "fleetType": "string", "formFactor": "string", "heapSize": number, "image": "string", "instances": [ { "arn": "string", "deviceArn": "string", "instanceProfile": { "arn": "string", "description": "string", "excludeAppPackagesFromCleanup": [ "string" ], "name": "string", "packageCleanup": boolean, "rebootAfterUse": boolean }, "labels": [ "string" ], "status": "string", "udid": "string" } ], "manufacturer": "string", "memory": number, "model": "string", "modelId": "string", "name": "string", "os": "string", "platform": "string", "radio": "string", "remoteAccessEnabled": boolean, "remoteDebugEnabled": boolean, "resolution": { "height": number, "width": number } }, "job": { "arn": "string", "name": "string" }, "message": "string", "result": "string", "run": { "arn": "string", "name": "string" }, "suite": { "arn": "string", "name": "string" }, "test": { "arn": "string", "name": "string" } } ] }



] }}



nextToken (p. 171)


Type: String

Length Constraints: Minimum length of 4. Maximum length of 1024.uniqueProblems (p. 171)

Information about the unique problems.

Allowed values include:• PENDING• PASSED• WARNED• FAILED• SKIPPED• ERRORED• STOPPED

Type: String to array of UniqueProblem (p. 319) objects map

Valid Keys: PENDING | PASSED | WARNED | FAILED | SKIPPED | ERRORED | STOPPED


ArgumentException















https://docs.aws.amazon.com/goto/aws-cli/devicefarm-2015-06-23/ListUniqueProblems

https://docs.aws.amazon.com/goto/DotNetSDKV3/devicefarm-2015-06-23/ListUniqueProblems

https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/ListUniqueProblems

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/ListUniqueProblems

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/ListUniqueProblems

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/devicefarm-2015-06-23/ListUniqueProblems

https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/ListUniqueProblems

https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/ListUniqueProblems

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/ListUniqueProblems

AWS Device Farm API ReferenceListUploads

ListUploadsGets information about uploads, given an AWS Device Farm project ARN.




arn (p. 175)

The Amazon Resource Name (ARN) of the project for which you want to list uploads.

Type: String


Pattern: ârn:.+



Type: String



The type of upload.

Must be one of the following values:• ANDROID_APP• IOS_APP• WEB_APP• EXTERNAL_DATA• APPIUM_JAVA_JUNIT_TEST_PACKAGE• APPIUM_JAVA_TESTNG_TEST_PACKAGE• APPIUM_PYTHON_TEST_PACKAGE• APPIUM_NODE_TEST_PACKAGE• APPIUM_RUBY_TEST_PACKAGE



• APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE• APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE• APPIUM_WEB_PYTHON_TEST_PACKAGE• APPIUM_WEB_NODE_TEST_PACKAGE• APPIUM_WEB_RUBY_TEST_PACKAGE• CALABASH_TEST_PACKAGE• INSTRUMENTATION_TEST_PACKAGE• UIAUTOMATION_TEST_PACKAGE• UIAUTOMATOR_TEST_PACKAGE• XCTEST_TEST_PACKAGE• XCTEST_UI_TEST_PACKAGE• APPIUM_JAVA_JUNIT_TEST_SPEC• APPIUM_JAVA_TESTNG_TEST_SPEC• APPIUM_PYTHON_TEST_SPEC• APPIUM_NODE_TEST_SPEC• APPIUM_RUBY_TEST_SPEC• APPIUM_WEB_JAVA_JUNIT_TEST_SPEC• APPIUM_WEB_JAVA_TESTNG_TEST_SPEC• APPIUM_WEB_PYTHON_TEST_SPEC• APPIUM_WEB_NODE_TEST_SPEC• APPIUM_WEB_RUBY_TEST_SPEC• INSTRUMENTATION_TEST_SPEC• XCTEST_UI_TEST_SPEC

Type: String

Valid Values: ANDROID_APP | IOS_APP | WEB_APP | EXTERNAL_DATA |APPIUM_JAVA_JUNIT_TEST_PACKAGE | APPIUM_JAVA_TESTNG_TEST_PACKAGE| APPIUM_PYTHON_TEST_PACKAGE | APPIUM_NODE_TEST_PACKAGE |APPIUM_RUBY_TEST_PACKAGE | APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE |APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE | APPIUM_WEB_PYTHON_TEST_PACKAGE| APPIUM_WEB_NODE_TEST_PACKAGE | APPIUM_WEB_RUBY_TEST_PACKAGE| CALABASH_TEST_PACKAGE | INSTRUMENTATION_TEST_PACKAGE |UIAUTOMATION_TEST_PACKAGE | UIAUTOMATOR_TEST_PACKAGE |XCTEST_TEST_PACKAGE | XCTEST_UI_TEST_PACKAGE | APPIUM_JAVA_JUNIT_TEST_SPEC| APPIUM_JAVA_TESTNG_TEST_SPEC | APPIUM_PYTHON_TEST_SPEC| APPIUM_NODE_TEST_SPEC | APPIUM_RUBY_TEST_SPEC |APPIUM_WEB_JAVA_JUNIT_TEST_SPEC | APPIUM_WEB_JAVA_TESTNG_TEST_SPEC| APPIUM_WEB_PYTHON_TEST_SPEC | APPIUM_WEB_NODE_TEST_SPEC |APPIUM_WEB_RUBY_TEST_SPEC | INSTRUMENTATION_TEST_SPEC | XCTEST_UI_TEST_SPEC

Required: No

Response Syntax{ "nextToken": "string", "uploads": [ { "arn": "string", "category": "string",



"contentType": "string", "created": number, "message": "string", "metadata": "string", "name": "string", "status": "string", "type": "string", "url": "string" } ]}



nextToken (p. 176)


Type: String

Length Constraints: Minimum length of 4. Maximum length of 1024.uploads (p. 176)

Information about the uploads.

Type: Array of Upload (p. 320) objects


ArgumentException














https://docs.aws.amazon.com/goto/aws-cli/devicefarm-2015-06-23/ListUploads

https://docs.aws.amazon.com/goto/DotNetSDKV3/devicefarm-2015-06-23/ListUploads

https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/ListUploads

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/ListUploads

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/ListUploads

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/devicefarm-2015-06-23/ListUploads

https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/ListUploads

https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/ListUploads

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/ListUploads

AWS Device Farm API ReferenceListVPCEConfigurations

ListVPCEConfigurationsReturns information about all Amazon Virtual Private Cloud (VPC) endpoint configurations in the AWSaccount.




maxResults (p. 179)


Type: Integer



Type: String


Required: No

Response Syntax{ "nextToken": "string", "vpceConfigurations": [ { "arn": "string", "serviceDnsName": "string", "vpceConfigurationDescription": "string", "vpceConfigurationName": "string", "vpceServiceName": "string" } ]}





nextToken (p. 179)


Type: String

Length Constraints: Minimum length of 4. Maximum length of 1024.vpceConfigurations (p. 179)

An array of VPCEConfiguration objects that contain information about your VPC endpointconfiguration.

Type: Array of VPCEConfiguration (p. 323) objects


ArgumentException








https://docs.aws.amazon.com/goto/aws-cli/devicefarm-2015-06-23/ListVPCEConfigurations

https://docs.aws.amazon.com/goto/DotNetSDKV3/devicefarm-2015-06-23/ListVPCEConfigurations

https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/ListVPCEConfigurations

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/ListVPCEConfigurations

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/ListVPCEConfigurations

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/devicefarm-2015-06-23/ListVPCEConfigurations

https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/ListVPCEConfigurations

https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/ListVPCEConfigurations

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/ListVPCEConfigurations

AWS Device Farm API ReferencePurchaseOffering

PurchaseOfferingImmediately purchases offerings for an AWS account. Offerings renew with the latest total purchasedquantity for an offering, unless the renewal was overridden. The API returns a NotEligible error if theuser is not permitted to invoke the operation. If you must be able to invoke this operation, contact [email protected].

Request Syntax{ "offeringId": "string", "offeringPromotionId": "string", "quantity": number}



offeringId (p. 181)

The ID of the offering.

Type: String

Length Constraints: Minimum length of 32.

Required: NoofferingPromotionId (p. 181)

The ID of the offering promotion to be applied to the purchase.

Type: String


Required: Noquantity (p. 181)

The number of device slots to purchase in an offering request.

Type: Integer

Required: No

Response Syntax{ "offeringTransaction": { "cost": { "amount": number,





"currencyCode": "string" }, "createdOn": number, "offeringPromotionId": "string", "offeringStatus": { "effectiveOn": number, "offering": { "description": "string", "id": "string", "platform": "string", "recurringCharges": [ { "cost": { "amount": number, "currencyCode": "string" }, "frequency": "string" } ], "type": "string" }, "quantity": number, "type": "string" }, "transactionId": "string" }}



offeringTransaction (p. 181)

Represents the offering transaction for the purchase result.

Type: OfferingTransaction (p. 277) object


ArgumentException









NotFoundException





Example

The following example purchases one unmetered iOS device.

Sample Request

{ "transactions": [ "purchase": { "offeringId": "offering-id-ios", "quantity": 1 } ]}

Sample Response

{ "offeringTransaction": { "createdOn": 1458587590.308, "offeringStatus": { "effectiveOn": 1458587590.24, "type": "RECURRING", "offering": { "platform": "IOS", "type": "RECURRING", "id": "offering-id-ios", "description": "iOS Unmetered Device Slot" }, "quantity": 1 }, "cost": { "amount": 80.65, "currencyCode": "USD" }, "transactionId": "transaction-id" }}


• AWS Command Line Interface• AWS SDK for .NET


https://docs.aws.amazon.com/goto/aws-cli/devicefarm-2015-06-23/PurchaseOffering

https://docs.aws.amazon.com/goto/DotNetSDKV3/devicefarm-2015-06-23/PurchaseOffering


• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3


https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/PurchaseOffering

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/PurchaseOffering

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/PurchaseOffering

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/devicefarm-2015-06-23/PurchaseOffering

https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/PurchaseOffering

https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/PurchaseOffering

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/PurchaseOffering

AWS Device Farm API ReferenceRenewOffering

RenewOfferingExplicitly sets the quantity of devices to renew for an offering, starting from the effectiveDate of thenext period. The API returns a NotEligible error if the user is not permitted to invoke the operation. Ifyou must be able to invoke this operation, contact [email protected].

Request Syntax{ "offeringId": "string", "quantity": number}



offeringId (p. 185)

The ID of a request to renew an offering.

Type: String


Required: No

quantity (p. 185)

The quantity requested in an offering renewal.

Type: Integer

Required: No

Response Syntax{ "offeringTransaction": { "cost": { "amount": number, "currencyCode": "string" }, "createdOn": number, "offeringPromotionId": "string", "offeringStatus": { "effectiveOn": number, "offering": { "description": "string", "id": "string", "platform": "string", "recurringCharges": [ {




"cost": { "amount": number, "currencyCode": "string" }, "frequency": "string" } ], "type": "string" }, "quantity": number, "type": "string" }, "transactionId": "string" }}



offeringTransaction (p. 185)

Represents the status of the offering transaction for the renewal.

Type: OfferingTransaction (p. 277) object


ArgumentException






NotEligibleException



NotFoundException








Example

The following example renews the offering for one unmetered iOS device.

Sample Request

{ "transactions": [ "renew": { "offeringId": "offering-id-ios", "quantity": 1, } ]}

Sample Response

{ "offeringTransaction": { "createdOn": 1458596930.431, "offeringStatus": { "effectiveOn": 1459468800.0, "type": "RECURRING", "offering": { "platform": "IOS", "type": "RECURRING", "id": "offering-id-ios", "description": "iOS Unmetered Device Slot" }, "quantity": 1 }, "cost": { "amount": 250.0, "currencyCode": "USD" }, "transactionId": "transaction-id" }}




https://docs.aws.amazon.com/goto/aws-cli/devicefarm-2015-06-23/RenewOffering

https://docs.aws.amazon.com/goto/DotNetSDKV3/devicefarm-2015-06-23/RenewOffering

https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/RenewOffering

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/RenewOffering

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/RenewOffering

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/devicefarm-2015-06-23/RenewOffering

https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/RenewOffering

https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/RenewOffering

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/RenewOffering

AWS Device Farm API ReferenceScheduleRun

ScheduleRunSchedules a run.

Request Syntax

{ "appArn": "string", "configuration": { "auxiliaryApps": [ "string" ], "billingMethod": "string", "customerArtifactPaths": { "androidPaths": [ "string" ], "deviceHostPaths": [ "string" ], "iosPaths": [ "string" ] }, "extraDataPackageArn": "string", "locale": "string", "location": { "latitude": number, "longitude": number }, "networkProfileArn": "string", "radios": { "bluetooth": boolean, "gps": boolean, "nfc": boolean, "wifi": boolean }, "vpceConfigurationArns": [ "string" ] }, "devicePoolArn": "string", "deviceSelectionConfiguration": { "filters": [ { "attribute": "string", "operator": "string", "values": [ "string" ] } ], "maxDevices": number }, "executionConfiguration": { "accountsCleanup": boolean, "appPackagesCleanup": boolean, "jobTimeoutMinutes": number, "skipAppResign": boolean, "videoCapture": boolean }, "name": "string", "projectArn": "string", "test": { "filter": "string", "parameters": { "string" : "string" }, "testPackageArn": "string", "testSpecArn": "string", "type": "string" }}





appArn (p. 188)

The ARN of an application package to run tests against, created with CreateUpload (p. 25). SeeListUploads (p. 175).

Type: String


Pattern: ârn:.+

Required: Noconfiguration (p. 188)

Information about the settings for the run to be scheduled.

Type: ScheduleRunConfiguration (p. 301) object

Required: NodevicePoolArn (p. 188)

The ARN of the device pool for the run to be scheduled.

Type: String


Pattern: ârn:.+

Required: NodeviceSelectionConfiguration (p. 188)

The filter criteria used to dynamically select a set of devices for a test run and the maximum numberof devices to be included in the run.

Either devicePoolArn or deviceSelectionConfiguration is required in a request.

Type: DeviceSelectionConfiguration (p. 255) object

Required: NoexecutionConfiguration (p. 188)

Specifies configuration information about a test run, such as the execution timeout (in minutes).

Type: ExecutionConfiguration (p. 258) object


The name for the run to be scheduled.

Type: String





The ARN of the project for the run to be scheduled.

Type: String


Pattern: ârn:.+

Required: Yestest (p. 188)

Information about the test for the run to be scheduled.

Type: ScheduleRunTest (p. 303) object

Required: Yes

Response Syntax{ "run": { "appUpload": "string", "arn": "string", "billingMethod": "string", "completedJobs": number, "counters": { "errored": number, "failed": number, "passed": number, "skipped": number, "stopped": number, "total": number, "warned": number }, "created": number, "customerArtifactPaths": { "androidPaths": [ "string" ], "deviceHostPaths": [ "string" ], "iosPaths": [ "string" ] }, "deviceMinutes": { "metered": number, "total": number, "unmetered": number }, "devicePoolArn": "string", "deviceSelectionResult": { "filters": [ { "attribute": "string", "operator": "string", "values": [ "string" ] } ], "matchedDevicesCount": number, "maxDevices": number



}, "eventCount": number, "jobTimeoutMinutes": number, "locale": "string", "location": { "latitude": number, "longitude": number }, "message": "string", "name": "string", "networkProfile": { "arn": "string", "description": "string", "downlinkBandwidthBits": number, "downlinkDelayMs": number, "downlinkJitterMs": number, "downlinkLossPercent": number, "name": "string", "type": "string", "uplinkBandwidthBits": number, "uplinkDelayMs": number, "uplinkJitterMs": number, "uplinkLossPercent": number }, "parsingResultUrl": "string", "platform": "string", "radios": { "bluetooth": boolean, "gps": boolean, "nfc": boolean, "wifi": boolean }, "result": "string", "resultCode": "string", "seed": number, "skipAppResign": boolean, "started": number, "status": "string", "stopped": number, "testSpecArn": "string", "totalJobs": number, "type": "string", "webUrl": "string" }}



run (p. 190)

Information about the scheduled run.





ArgumentException


HTTP Status Code: 400IdempotencyException

An entity with the same name already exists.











https://docs.aws.amazon.com/goto/aws-cli/devicefarm-2015-06-23/ScheduleRun

https://docs.aws.amazon.com/goto/DotNetSDKV3/devicefarm-2015-06-23/ScheduleRun

https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/ScheduleRun

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/ScheduleRun

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/ScheduleRun

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/devicefarm-2015-06-23/ScheduleRun

https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/ScheduleRun

https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/ScheduleRun

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/ScheduleRun

AWS Device Farm API ReferenceStopJob

StopJobInitiates a stop request for the current job. AWS Device Farm immediately stops the job on the devicewhere tests have not started. You are not billed for this device. On the device where tests have started,setup suite and teardown suite tests run to completion on the device. You are billed for setup, teardown,and any tests that were in progress or already completed.




arn (p. 193)

Represents the Amazon Resource Name (ARN) of the Device Farm job to stop.

Type: String


Pattern: ârn:.+

Required: Yes

Response Syntax{ "job": { "arn": "string", "counters": { "errored": number, "failed": number, "passed": number, "skipped": number, "stopped": number, "total": number, "warned": number }, "created": number, "device": { "arn": "string", "availability": "string", "carrier": "string", "cpu": { "architecture": "string", "clock": number, "frequency": "string" },



"fleetName": "string", "fleetType": "string", "formFactor": "string", "heapSize": number, "image": "string", "instances": [ { "arn": "string", "deviceArn": "string", "instanceProfile": { "arn": "string", "description": "string", "excludeAppPackagesFromCleanup": [ "string" ], "name": "string", "packageCleanup": boolean, "rebootAfterUse": boolean }, "labels": [ "string" ], "status": "string", "udid": "string" } ], "manufacturer": "string", "memory": number, "model": "string", "modelId": "string", "name": "string", "os": "string", "platform": "string", "radio": "string", "remoteAccessEnabled": boolean, "remoteDebugEnabled": boolean, "resolution": { "height": number, "width": number } }, "deviceMinutes": { "metered": number, "total": number, "unmetered": number }, "instanceArn": "string", "message": "string", "name": "string", "result": "string", "started": number, "status": "string", "stopped": number, "type": "string", "videoCapture": boolean, "videoEndpoint": "string" }}



job (p. 193)

The job that was stopped.



Type: Job (p. 262) object


ArgumentException












https://docs.aws.amazon.com/goto/aws-cli/devicefarm-2015-06-23/StopJob

https://docs.aws.amazon.com/goto/DotNetSDKV3/devicefarm-2015-06-23/StopJob

https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/StopJob

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/StopJob

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/StopJob

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/devicefarm-2015-06-23/StopJob

https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/StopJob

https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/StopJob

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/StopJob

AWS Device Farm API ReferenceStopRemoteAccessSession

StopRemoteAccessSessionEnds a specified remote access session.

Request Syntax

{ "arn": "string"}



arn (p. 196)

The Amazon Resource Name (ARN) of the remote access session to stop.

Type: String


Pattern: ârn:.+

Required: Yes

Response Syntax

{ "remoteAccessSession": { "arn": "string", "billingMethod": "string", "clientId": "string", "created": number, "device": { "arn": "string", "availability": "string", "carrier": "string", "cpu": { "architecture": "string", "clock": number, "frequency": "string" }, "fleetName": "string", "fleetType": "string", "formFactor": "string", "heapSize": number, "image": "string", "instances": [ { "arn": "string", "deviceArn": "string",



"instanceProfile": { "arn": "string", "description": "string", "excludeAppPackagesFromCleanup": [ "string" ], "name": "string", "packageCleanup": boolean, "rebootAfterUse": boolean }, "labels": [ "string" ], "status": "string", "udid": "string" } ], "manufacturer": "string", "memory": number, "model": "string", "modelId": "string", "name": "string", "os": "string", "platform": "string", "radio": "string", "remoteAccessEnabled": boolean, "remoteDebugEnabled": boolean, "resolution": { "height": number, "width": number } }, "deviceMinutes": { "metered": number, "total": number, "unmetered": number }, "deviceUdid": "string", "endpoint": "string", "hostAddress": "string", "instanceArn": "string", "interactionMode": "string", "message": "string", "name": "string", "remoteDebugEnabled": boolean, "remoteRecordAppArn": "string", "remoteRecordEnabled": boolean, "result": "string", "skipAppResign": boolean, "started": number, "status": "string", "stopped": number }}




A container that represents the metadata from the service about the remote access session you arestopping.





ArgumentException












https://docs.aws.amazon.com/goto/aws-cli/devicefarm-2015-06-23/StopRemoteAccessSession

https://docs.aws.amazon.com/goto/DotNetSDKV3/devicefarm-2015-06-23/StopRemoteAccessSession

https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/StopRemoteAccessSession

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/StopRemoteAccessSession

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/StopRemoteAccessSession

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/devicefarm-2015-06-23/StopRemoteAccessSession

https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/StopRemoteAccessSession

https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/StopRemoteAccessSession

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/StopRemoteAccessSession

AWS Device Farm API ReferenceStopRun

StopRunInitiates a stop request for the current test run. AWS Device Farm immediately stops the run on deviceswhere tests have not started. You are not billed for these devices. On devices where tests have startedexecuting, setup suite and teardown suite tests run to completion on those devices. You are billed forsetup, teardown, and any tests that were in progress or already completed.




arn (p. 199)

Represents the Amazon Resource Name (ARN) of the Device Farm run to stop.

Type: String


Pattern: ârn:.+

Required: Yes

Response Syntax{ "run": { "appUpload": "string", "arn": "string", "billingMethod": "string", "completedJobs": number, "counters": { "errored": number, "failed": number, "passed": number, "skipped": number, "stopped": number, "total": number, "warned": number }, "created": number, "customerArtifactPaths": { "androidPaths": [ "string" ], "deviceHostPaths": [ "string" ], "iosPaths": [ "string" ] }, "deviceMinutes": {



"metered": number, "total": number, "unmetered": number }, "devicePoolArn": "string", "deviceSelectionResult": { "filters": [ { "attribute": "string", "operator": "string", "values": [ "string" ] } ], "matchedDevicesCount": number, "maxDevices": number }, "eventCount": number, "jobTimeoutMinutes": number, "locale": "string", "location": { "latitude": number, "longitude": number }, "message": "string", "name": "string", "networkProfile": { "arn": "string", "description": "string", "downlinkBandwidthBits": number, "downlinkDelayMs": number, "downlinkJitterMs": number, "downlinkLossPercent": number, "name": "string", "type": "string", "uplinkBandwidthBits": number, "uplinkDelayMs": number, "uplinkJitterMs": number, "uplinkLossPercent": number }, "parsingResultUrl": "string", "platform": "string", "radios": { "bluetooth": boolean, "gps": boolean, "nfc": boolean, "wifi": boolean }, "result": "string", "resultCode": "string", "seed": number, "skipAppResign": boolean, "started": number, "status": "string", "stopped": number, "testSpecArn": "string", "totalJobs": number, "type": "string", "webUrl": "string" }}





run (p. 199)

The run that was stopped.



ArgumentException












https://docs.aws.amazon.com/goto/aws-cli/devicefarm-2015-06-23/StopRun

https://docs.aws.amazon.com/goto/DotNetSDKV3/devicefarm-2015-06-23/StopRun

https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/StopRun

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/StopRun

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/StopRun

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/devicefarm-2015-06-23/StopRun

https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/StopRun

https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/StopRun

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/StopRun

AWS Device Farm API ReferenceTagResource

TagResourceAssociates the specified tags to a resource with the specified resourceArn. If existing tags on a resourceare not specified in the request parameters, they are not changed. When a resource is deleted, the tagsassociated with that resource are also deleted.

Request Syntax{ "ResourceARN": "string", "Tags": [ { "Key": "string", "Value": "string" } ]}




The Amazon Resource Name (ARN) of the resource or resources to which to add tags. You canassociate tags with the following Device Farm resources: PROJECT, RUN, NETWORK_PROFILE,INSTANCE_PROFILE, DEVICE_INSTANCE, SESSION, DEVICE_POOL, DEVICE, andVPCE_CONFIGURATION.

Type: String



Required: YesTags (p. 202)

The tags to add to the resource. A tag is an array of key-value pairs. Tag keys can have a maximumcharacter length of 128 characters. Tag values can have a maximum length of 256 characters.

Type: Array of Tag (p. 309) objects


Required: Yes





ArgumentException






HTTP Status Code: 400TagPolicyException

The request doesn't comply with the AWS Identity and Access Management (IAM) tag policy. Correctyour request and then retry it.

HTTP Status Code: 400TooManyTagsException

The list of tags on the repository is over the limit. The maximum number of tags that can be appliedto a repository is 50.





https://docs.aws.amazon.com/goto/aws-cli/devicefarm-2015-06-23/TagResource

https://docs.aws.amazon.com/goto/DotNetSDKV3/devicefarm-2015-06-23/TagResource

https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/TagResource

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/TagResource

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/TagResource

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/devicefarm-2015-06-23/TagResource

https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/TagResource

https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/TagResource

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/TagResource

AWS Device Farm API ReferenceUntagResource

UntagResourceDeletes the specified tags from a resource.

Request Syntax{ "ResourceARN": "string", "TagKeys": [ "string" ]}




The Amazon Resource Name (ARN) of the resource or resources from which to deletetags. You can associate tags with the following Device Farm resources: PROJECT, RUN,NETWORK_PROFILE, INSTANCE_PROFILE, DEVICE_INSTANCE, SESSION, DEVICE_POOL, DEVICE,and VPCE_CONFIGURATION.

Type: String



Required: YesTagKeys (p. 204)

The keys of the tags to be removed.




Required: Yes



ArgumentException












https://docs.aws.amazon.com/goto/aws-cli/devicefarm-2015-06-23/UntagResource

https://docs.aws.amazon.com/goto/DotNetSDKV3/devicefarm-2015-06-23/UntagResource

https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/UntagResource

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/UntagResource

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/UntagResource

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/devicefarm-2015-06-23/UntagResource

https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/UntagResource

https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/UntagResource

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/UntagResource

AWS Device Farm API ReferenceUpdateDeviceInstance

UpdateDeviceInstanceUpdates information about a private device instance.

Request Syntax{ "arn": "string", "labels": [ "string" ], "profileArn": "string"}



arn (p. 206)

The Amazon Resource Name (ARN) of the device instance.

Type: String


Pattern: ârn:.+

Required: Yeslabels (p. 206)

An array of strings that you want to associate with the device instance.


Required: NoprofileArn (p. 206)

The ARN of the profile that you want to associate with the device instance.

Type: String


Pattern: ârn:.+

Required: No

Response Syntax{ "deviceInstance": { "arn": "string", "deviceArn": "string",



"instanceProfile": { "arn": "string", "description": "string", "excludeAppPackagesFromCleanup": [ "string" ], "name": "string", "packageCleanup": boolean, "rebootAfterUse": boolean }, "labels": [ "string" ], "status": "string", "udid": "string" }}



deviceInstance (p. 206)

An object that contains information about your device instance.

Type: DeviceInstance (p. 249) object


ArgumentException










• AWS Command Line Interface


https://docs.aws.amazon.com/goto/aws-cli/devicefarm-2015-06-23/UpdateDeviceInstance


• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V3


https://docs.aws.amazon.com/goto/DotNetSDKV3/devicefarm-2015-06-23/UpdateDeviceInstance

https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/UpdateDeviceInstance

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/UpdateDeviceInstance

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/UpdateDeviceInstance

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/devicefarm-2015-06-23/UpdateDeviceInstance

https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/UpdateDeviceInstance

https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/UpdateDeviceInstance

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/UpdateDeviceInstance

AWS Device Farm API ReferenceUpdateDevicePool

UpdateDevicePoolModifies the name, description, and rules in a device pool given the attributes and the pool ARN. Ruleupdates are all-or-nothing, meaning they can only be updated as a whole (or not at all).

Request Syntax{ "arn": "string", "clearMaxDevices": boolean, "description": "string", "maxDevices": number, "name": "string", "rules": [ { "attribute": "string", "operator": "string", "value": "string" } ]}



arn (p. 209)

The Amazon Resource Name (ARN) of the Device Farm device pool to update.

Type: String


Pattern: ârn:.+

Required: YesclearMaxDevices (p. 209)

Sets whether the maxDevices parameter applies to your device pool. If you set this parameter totrue, the maxDevices parameter does not apply, and Device Farm does not limit the number ofdevices that it adds to your device pool. In this case, Device Farm adds all available devices that meetthe criteria specified in the rules parameter.

If you use this parameter in your request, you cannot use the maxDevices parameter in the samerequest.

Type: Boolean

Required: Nodescription (p. 209)

A description of the device pool to update.

Type: String




Required: NomaxDevices (p. 209)

The number of devices that Device Farm can add to your device pool. Device Farm adds devices thatare available and that meet the criteria that you assign for the rules parameter. Depending on howmany devices meet these constraints, your device pool might contain fewer devices than the valuefor this parameter.


If you use this parameter in your request, you cannot use the clearMaxDevices parameter in thesame request.

Type: Integer


A string that represents the name of the device pool to update.

Type: String


Required: Norules (p. 209)

Represents the rules to modify for the device pool. Updating rules is optional. If you update rules foryour request, the update replaces the existing rules.


Required: No

Response Syntax{ "devicePool": { "arn": "string", "description": "string", "maxDevices": number, "name": "string", "rules": [ { "attribute": "string", "operator": "string", "value": "string" } ], "type": "string" }}





devicePool (p. 210)

The device pool you just updated.



ArgumentException












https://docs.aws.amazon.com/goto/aws-cli/devicefarm-2015-06-23/UpdateDevicePool

https://docs.aws.amazon.com/goto/DotNetSDKV3/devicefarm-2015-06-23/UpdateDevicePool

https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/UpdateDevicePool

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/UpdateDevicePool

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/UpdateDevicePool

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/devicefarm-2015-06-23/UpdateDevicePool

https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/UpdateDevicePool

https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/UpdateDevicePool

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/UpdateDevicePool

AWS Device Farm API ReferenceUpdateInstanceProfile

UpdateInstanceProfileUpdates information about an existing private device instance profile.

Request Syntax{ "arn": "string", "description": "string", "excludeAppPackagesFromCleanup": [ "string" ], "name": "string", "packageCleanup": boolean, "rebootAfterUse": boolean}



arn (p. 212)

The Amazon Resource Name (ARN) of the instance profile.

Type: String


Pattern: ârn:.+

Required: Yesdescription (p. 212)

The updated description for your instance profile.

Type: String


Required: NoexcludeAppPackagesFromCleanup (p. 212)

An array of strings that specifies the list of app packages that should not be cleaned up from thedevice after a test run is over.

The list of packages is only considered if you set packageCleanup to true.



The updated name for your instance profile.

Type: String




Required: NopackageCleanup (p. 212)

The updated choice for whether you want to specify package cleanup. The default value is false forprivate devices.

Type: Boolean

Required: NorebootAfterUse (p. 212)

The updated choice for whether you want to reboot the device after use. The default value is true.

Type: Boolean

Required: No





An object that contains information about your instance profile.



ArgumentException














https://docs.aws.amazon.com/goto/aws-cli/devicefarm-2015-06-23/UpdateInstanceProfile

https://docs.aws.amazon.com/goto/DotNetSDKV3/devicefarm-2015-06-23/UpdateInstanceProfile

https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/UpdateInstanceProfile

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/UpdateInstanceProfile

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/UpdateInstanceProfile

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/devicefarm-2015-06-23/UpdateInstanceProfile

https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/UpdateInstanceProfile

https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/UpdateInstanceProfile

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/UpdateInstanceProfile

AWS Device Farm API ReferenceUpdateNetworkProfile

UpdateNetworkProfileUpdates the network profile.

Request Syntax{ "arn": "string", "description": "string", "downlinkBandwidthBits": number, "downlinkDelayMs": number, "downlinkJitterMs": number, "downlinkLossPercent": number, "name": "string", "type": "string", "uplinkBandwidthBits": number, "uplinkDelayMs": number, "uplinkJitterMs": number, "uplinkLossPercent": number}



arn (p. 215)

The Amazon Resource Name (ARN) of the project for which you want to update network profilesettings.

Type: String


Pattern: ârn:.+

Required: Yesdescription (p. 215)

The description of the network profile about which you are returning information.

Type: String


Required: NodownlinkBandwidthBits (p. 215)


Type: Long

Required: NodownlinkDelayMs (p. 215)




Type: Long

Required: NodownlinkJitterMs (p. 215)


Type: Long

Required: NodownlinkLossPercent (p. 215)


Type: Integer



The name of the network profile about which you are returning information.

Type: String



The type of network profile to return information about. Valid values are listed here.

Type: String


Required: NouplinkBandwidthBits (p. 215)


Type: Long

Required: NouplinkDelayMs (p. 215)


Type: Long

Required: NouplinkJitterMs (p. 215)


Type: Long

Required: NouplinkLossPercent (p. 215)




Type: Integer


Required: No

Response Syntax{ "networkProfile": { "arn": "string", "description": "string", "downlinkBandwidthBits": number, "downlinkDelayMs": number, "downlinkJitterMs": number, "downlinkLossPercent": number, "name": "string", "type": "string", "uplinkBandwidthBits": number, "uplinkDelayMs": number, "uplinkJitterMs": number, "uplinkLossPercent": number }}




A list of the available network profiles.



ArgumentException















https://docs.aws.amazon.com/goto/aws-cli/devicefarm-2015-06-23/UpdateNetworkProfile

https://docs.aws.amazon.com/goto/DotNetSDKV3/devicefarm-2015-06-23/UpdateNetworkProfile

https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/UpdateNetworkProfile

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/UpdateNetworkProfile

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/UpdateNetworkProfile

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/devicefarm-2015-06-23/UpdateNetworkProfile

https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/UpdateNetworkProfile

https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/UpdateNetworkProfile

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/UpdateNetworkProfile

AWS Device Farm API ReferenceUpdateProject

UpdateProjectModifies the specified project name, given the project ARN and a new name.

Request Syntax{ "arn": "string", "defaultJobTimeoutMinutes": number, "name": "string"}



arn (p. 219)

The Amazon Resource Name (ARN) of the project whose name to update.

Type: String


Pattern: ârn:.+

Required: YesdefaultJobTimeoutMinutes (p. 219)

The number of minutes a test run in the project executes before it times out.

Type: Integer


A string that represents the new name of the project that you are updating.

Type: String


Required: No

Response Syntax{ "project": { "arn": "string", "created": number, "defaultJobTimeoutMinutes": number, "name": "string"



}}



project (p. 219)

The project to update.



ArgumentException












https://docs.aws.amazon.com/goto/aws-cli/devicefarm-2015-06-23/UpdateProject

https://docs.aws.amazon.com/goto/DotNetSDKV3/devicefarm-2015-06-23/UpdateProject

https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/UpdateProject

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/UpdateProject

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/UpdateProject

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/devicefarm-2015-06-23/UpdateProject

https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/UpdateProject

https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/UpdateProject

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/UpdateProject



AWS Device Farm API ReferenceUpdateTestGridProject

UpdateTestGridProjectChange details of a project.

Request Syntax{ "description": "string", "name": "string", "projectArn": "string"}



description (p. 222)

Human-readable description for the project.

Type: String


Pattern: .*\S.*


Human-readable name for the project.

Type: String


Pattern: .*\S.*


ARN of the project to update.

Type: String



Required: Yes

Response Syntax{



"testGridProject": { "arn": "string", "created": number, "description": "string", "name": "string" }}




The project, including updated information.



ArgumentException











https://docs.aws.amazon.com/goto/aws-cli/devicefarm-2015-06-23/UpdateTestGridProject

https://docs.aws.amazon.com/goto/DotNetSDKV3/devicefarm-2015-06-23/UpdateTestGridProject

https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/UpdateTestGridProject

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/UpdateTestGridProject

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/UpdateTestGridProject

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/devicefarm-2015-06-23/UpdateTestGridProject

https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/UpdateTestGridProject

https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/UpdateTestGridProject

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/UpdateTestGridProject



AWS Device Farm API ReferenceUpdateUpload

UpdateUploadUpdates an uploaded test spec.

Request Syntax{ "arn": "string", "contentType": "string", "editContent": boolean, "name": "string"}



arn (p. 225)

The Amazon Resource Name (ARN) of the uploaded test spec.

Type: String


Pattern: ârn:.+

Required: Yes

contentType (p. 225)

The upload's content type (for example, application/x-yaml).

Type: String


Required: No

editContent (p. 225)

Set to true if the YAML file has changed and must be updated. Otherwise, set to false.

Type: Boolean

Required: No

name (p. 225)

The upload's test spec file name. The name must not contain any forward slashes (/). The test specfile name must end with the .yaml or .yml file extension.

Type: String




Required: No




upload (p. 226)

A test spec uploaded to Device Farm.



ArgumentException






NotFoundException











https://docs.aws.amazon.com/goto/aws-cli/devicefarm-2015-06-23/UpdateUpload

https://docs.aws.amazon.com/goto/DotNetSDKV3/devicefarm-2015-06-23/UpdateUpload

https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/UpdateUpload

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/UpdateUpload

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/UpdateUpload

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/devicefarm-2015-06-23/UpdateUpload

https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/UpdateUpload

https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/UpdateUpload

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/UpdateUpload

AWS Device Farm API ReferenceUpdateVPCEConfiguration

UpdateVPCEConfigurationUpdates information about an Amazon Virtual Private Cloud (VPC) endpoint configuration.

Request Syntax{ "arn": "string", "serviceDnsName": "string", "vpceConfigurationDescription": "string", "vpceConfigurationName": "string", "vpceServiceName": "string"}



arn (p. 228)

The Amazon Resource Name (ARN) of the VPC endpoint configuration you want to update.

Type: String


Pattern: ârn:.+

Required: YesserviceDnsName (p. 228)

The DNS (domain) name used to connect to your private service in your VPC. The DNS name mustnot already be in use on the internet.

Type: String


Required: NovpceConfigurationDescription (p. 228)


Type: String


Required: NovpceConfigurationName (p. 228)

The friendly name you give to your VPC endpoint configuration to manage your configurations moreeasily.

Type: String




Required: NovpceServiceName (p. 228)


Type: String


Required: No








ArgumentException


HTTP Status Code: 400InvalidOperationException

There was an error with the update request, or you do not have sufficient permissions to update thisVPC endpoint configuration.











https://docs.aws.amazon.com/goto/aws-cli/devicefarm-2015-06-23/UpdateVPCEConfiguration

https://docs.aws.amazon.com/goto/DotNetSDKV3/devicefarm-2015-06-23/UpdateVPCEConfiguration

https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/UpdateVPCEConfiguration

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/UpdateVPCEConfiguration

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/UpdateVPCEConfiguration

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/devicefarm-2015-06-23/UpdateVPCEConfiguration

https://docs.aws.amazon.com/goto/SdkForPHPV3/devicefarm-2015-06-23/UpdateVPCEConfiguration

https://docs.aws.amazon.com/goto/boto3/devicefarm-2015-06-23/UpdateVPCEConfiguration

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/UpdateVPCEConfiguration


Data TypesThe AWS Device Farm API contains several data types that various actions use. This section describeseach data type in detail.

NoteThe order of each element in a data type structure is not guaranteed. Applications should notassume a particular order.

The following data types are supported:

• AccountSettings (p. 233)• Artifact (p. 235)• Counters (p. 237)• CPU (p. 239)• CreateRemoteAccessSessionConfiguration (p. 240)• CustomerArtifactPaths (p. 241)• Device (p. 242)• DeviceFilter (p. 246)• DeviceInstance (p. 249)• DeviceMinutes (p. 251)• DevicePool (p. 252)• DevicePoolCompatibilityResult (p. 254)• DeviceSelectionConfiguration (p. 255)• DeviceSelectionResult (p. 257)• ExecutionConfiguration (p. 258)• IncompatibilityMessage (p. 259)• InstanceProfile (p. 260)• Job (p. 262)• ListTestGridProjectsRequest (p. 266)• ListTestGridSessionsRequest (p. 267)• Location (p. 269)• MonetaryAmount (p. 270)• NetworkProfile (p. 271)• Offering (p. 273)• OfferingPromotion (p. 275)• OfferingStatus (p. 276)• OfferingTransaction (p. 277)• Problem (p. 278)• ProblemDetail (p. 280)• Project (p. 281)• Radios (p. 282)• RecurringCharge (p. 283)• RemoteAccessSession (p. 284)• Resolution (p. 289)• Rule (p. 290)



• Run (p. 293)• Sample (p. 299)• ScheduleRunConfiguration (p. 301)• ScheduleRunTest (p. 303)• Suite (p. 306)• Tag (p. 309)• Test (p. 310)• TestGridProject (p. 313)• TestGridSession (p. 314)• TestGridSessionAction (p. 316)• TestGridSessionArtifact (p. 317)• TrialMinutes (p. 318)• UniqueProblem (p. 319)• Upload (p. 320)• VPCEConfiguration (p. 323)


AWS Device Farm API ReferenceAccountSettings

AccountSettingsA container for account-level settings in AWS Device Farm.

ContentsawsAccountNumber

The AWS account number specified in the AccountSettings container.

Type: String


Required: NodefaultJobTimeoutMinutes

The default number of minutes (at the account level) a test run executes before it times out. Thedefault value is 150 minutes.

Type: Integer

Required: NomaxJobTimeoutMinutes

The maximum number of minutes a test run executes before it times out.

Type: Integer

Required: NomaxSlots

The maximum number of device slots that the AWS account can purchase. Each maximum isexpressed as an offering-id:number pair, where the offering-id represents one of the IDsreturned by the ListOfferings command.

Type: String to integer map

Required: NoskipAppResign


For more information about how Device Farm re-signs your apps, see Do you modify my app? in theAWS Device Farm FAQs.

Type: Boolean

Required: NotrialMinutes

Information about an AWS account's usage of free trial device minutes.

Type: TrialMinutes (p. 318) object

Required: No




unmeteredDevices

Returns the unmetered devices you have purchased or want to purchase.


Valid Keys: ANDROID | IOS

Required: NounmeteredRemoteAccessDevices

Returns the unmetered remote access devices you have purchased or want to purchase.


Valid Keys: ANDROID | IOS

Required: No


• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V3


https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/AccountSettings

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/AccountSettings

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/AccountSettings

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/AccountSettings

AWS Device Farm API ReferenceArtifact

ArtifactRepresents the output of a test. Examples of artifacts include logs and screenshots.

Contentsarn

The artifact's ARN.

Type: String


Pattern: ârn:.+

Required: Noextension

The artifact's file extension.

Type: String

Required: Noname

The artifact's name.

Type: String


Required: Notype

The artifact's type.

Allowed values include the following:• UNKNOWN• SCREENSHOT• DEVICE_LOG• MESSAGE_LOG• VIDEO_LOG• RESULT_LOG• SERVICE_LOG• WEBKIT_LOG• INSTRUMENTATION_OUTPUT• EXERCISER_MONKEY_OUTPUT: the artifact (log) generated by an Android fuzz test.• CALABASH_JSON_OUTPUT• CALABASH_PRETTY_OUTPUT• CALABASH_STANDARD_OUTPUT• CALABASH_JAVA_XML_OUTPUT• AUTOMATION_OUTPUT



• APPIUM_SERVER_OUTPUT• APPIUM_JAVA_OUTPUT• APPIUM_JAVA_XML_OUTPUT• APPIUM_PYTHON_OUTPUT• APPIUM_PYTHON_XML_OUTPUT• EXPLORER_EVENT_LOG• EXPLORER_SUMMARY_LOG• APPLICATION_CRASH_REPORT• XCTEST_LOG• VIDEO• CUSTOMER_ARTIFACT• CUSTOMER_ARTIFACT_LOG• TESTSPEC_OUTPUT

Type: String

Valid Values: UNKNOWN | SCREENSHOT | DEVICE_LOG | MESSAGE_LOG | VIDEO_LOG| RESULT_LOG | SERVICE_LOG | WEBKIT_LOG | INSTRUMENTATION_OUTPUT |EXERCISER_MONKEY_OUTPUT | CALABASH_JSON_OUTPUT | CALABASH_PRETTY_OUTPUT| CALABASH_STANDARD_OUTPUT | CALABASH_JAVA_XML_OUTPUT | AUTOMATION_OUTPUT| APPIUM_SERVER_OUTPUT | APPIUM_JAVA_OUTPUT | APPIUM_JAVA_XML_OUTPUT |APPIUM_PYTHON_OUTPUT | APPIUM_PYTHON_XML_OUTPUT | EXPLORER_EVENT_LOG |EXPLORER_SUMMARY_LOG | APPLICATION_CRASH_REPORT | XCTEST_LOG | VIDEO |CUSTOMER_ARTIFACT | CUSTOMER_ARTIFACT_LOG | TESTSPEC_OUTPUT

Required: Nourl

The presigned Amazon S3 URL that can be used with a GET request to download the artifact's file.

Type: String


Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/Artifact

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/Artifact

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/Artifact

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/Artifact

AWS Device Farm API ReferenceCounters

CountersRepresents entity counters.

Contentserrored

The number of errored entities.

Type: Integer

Required: No

failed

The number of failed entities.

Type: Integer

Required: No

passed

The number of passed entities.

Type: Integer

Required: No

skipped

The number of skipped entities.

Type: Integer

Required: No

stopped

The number of stopped entities.

Type: Integer

Required: No

total

The total number of entities.

Type: Integer

Required: No

warned

The number of warned entities.

Type: Integer

Required: No






https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/Counters

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/Counters

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/Counters

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/Counters

AWS Device Farm API ReferenceCPU

CPURepresents the amount of CPU that an app is using on a physical device. Does not represent system-wideCPU usage.

Contentsarchitecture

The CPU's architecture (for example, x86 or ARM).

Type: String

Required: Noclock

The clock speed of the device's CPU, expressed in hertz (Hz). For example, a 1.2 GHz CPU isexpressed as 1200000000.

Type: Double

Required: Nofrequency

The CPU's frequency.

Type: String

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/CPU

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/CPU

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/CPU

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/CPU

AWS Device Farm API ReferenceCreateRemoteAccessSessionConfiguration

CreateRemoteAccessSessionConfigurationConfiguration settings for a remote access session, including billing method.

ContentsbillingMethod

The billing method for the remote access session.

Type: String

Valid Values: METERED | UNMETERED

Required: NovpceConfigurationArns

An array of ARNs included in the VPC endpoint configuration.



Pattern: ârn:.+

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/CreateRemoteAccessSessionConfiguration

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/CreateRemoteAccessSessionConfiguration

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/CreateRemoteAccessSessionConfiguration

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/CreateRemoteAccessSessionConfiguration

AWS Device Farm API ReferenceCustomerArtifactPaths

CustomerArtifactPathsA JSON object that specifies the paths where the artifacts generated by the customer's tests, on thedevice or in the test environment, are pulled from.

Specify deviceHostPaths and optionally specify either iosPaths or androidPaths.

For web app tests, you can specify both iosPaths and androidPaths.

ContentsandroidPaths

Comma-separated list of paths on the Android device where the artifacts generated by thecustomer's tests are pulled from.


Required: NodeviceHostPaths

Comma-separated list of paths in the test execution environment where the artifacts generated bythe customer's tests are pulled from.


Required: NoiosPaths

Comma-separated list of paths on the iOS device where the artifacts generated by the customer'stests are pulled from.


Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/CustomerArtifactPaths

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/CustomerArtifactPaths

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/CustomerArtifactPaths

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/CustomerArtifactPaths

AWS Device Farm API ReferenceDevice

DeviceRepresents a device type that an app is tested against.

Contentsarn

The device's ARN.

Type: String


Pattern: ârn:.+

Required: Noavailability

Indicates how likely a device is available for a test run. Currently available in the ListDevices (p. 111)and GetDevice API methods.

Type: String

Valid Values: TEMPORARY_NOT_AVAILABLE | BUSY | AVAILABLE | HIGHLY_AVAILABLE

Required: Nocarrier

The device's carrier.

Type: String

Required: Nocpu

Information about the device's CPU.

Type: CPU (p. 239) object

Required: NofleetName

The name of the fleet to which this device belongs.

Type: String

Required: NofleetType

The type of fleet to which this device belongs. Possible values are PRIVATE and PUBLIC.

Type: String

Required: NoformFactor

The device's form factor.


AWS Device Farm API ReferenceContents

Allowed values include:• PHONE• TABLET

Type: String

Valid Values: PHONE | TABLET

Required: NoheapSize

The device's heap size, expressed in bytes.

Type: Long

Required: Noimage

The device's image name.

Type: String

Required: Noinstances

The instances that belong to this device.

Type: Array of DeviceInstance (p. 249) objects

Required: Nomanufacturer

The device's manufacturer name.

Type: String

Required: Nomemory

The device's total memory size, expressed in bytes.

Type: Long

Required: Nomodel

The device's model name.

Type: String

Required: NomodelId

The device's model ID.

Type: String

Required: No



name

The device's display name.

Type: String


Required: Noos

The device's operating system type.

Type: String

Required: Noplatform

The device's platform.

Allowed values include:• ANDROID• IOS

Type: String

Valid Values: ANDROID | IOS

Required: Noradio

The device's radio.

Type: String

Required: NoremoteAccessEnabled

Specifies whether remote access has been enabled for the specified device.

Type: Boolean

Required: NoremoteDebugEnabled

This flag is set to true if remote debugging is enabled for the device.


Type: Boolean

Required: Noresolution

The resolution of the device.

Type: Resolution (p. 289) object

Required: No







https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/Device

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/Device

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/Device

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/Device

AWS Device Farm API ReferenceDeviceFilter

DeviceFilterRepresents a device filter used to select a set of devices to be included in a test run. This data structureis passed in as the deviceSelectionConfiguration parameter to ScheduleRun. For an example ofthe JSON request syntax, see ScheduleRun (p. 188).

It is also passed in as the filters parameter to ListDevices. For an example of the JSON requestsyntax, see ListDevices (p. 111).

Contentsattribute

The aspect of a device such as platform or model used as the selection criteria in a device filter.

The supported operators for each attribute are provided in the following list.ARN

The Amazon Resource Name (ARN) of the device (for example, arn:aws:devicefarm:us-west-2::device:12345Example).

Supported operators: EQUALS, IN, NOT_INPLATFORM

The device platform. Valid values are ANDROID or IOS.

Supported operators: EQUALSOS_VERSION

The operating system version (for example, 10.3.2).

Supported operators: EQUALS, GREATER_THAN, GREATER_THAN_OR_EQUALS, IN, LESS_THAN,LESS_THAN_OR_EQUALS, NOT_IN

MODEL

The device model (for example, iPad 5th Gen).

Supported operators: CONTAINS, EQUALS, IN, NOT_INAVAILABILITY

The current availability of the device. Valid values are AVAILABLE, HIGHLY_AVAILABLE, BUSY, orTEMPORARY_NOT_AVAILABLE.

Supported operators: EQUALSFORM_FACTOR

The device form factor. Valid values are PHONE or TABLET.

Supported operators: EQUALSMANUFACTURER

The device manufacturer (for example, Apple).

Supported operators: EQUALS, IN, NOT_INREMOTE_ACCESS_ENABLED

Whether the device is enabled for remote access. Valid values are TRUE or FALSE.



Supported operators: EQUALSREMOTE_DEBUG_ENABLED

Whether the device is enabled for remote debugging. Valid values are TRUE or FALSE.

Supported operators: EQUALS

Because remote debugging is no longer supported, this filter is ignored.INSTANCE_ARN


Supported operators: EQUALS, IN, NOT_ININSTANCE_LABELS

The label of the device instance.

Supported operators: CONTAINSFLEET_TYPE

The fleet type. Valid values are PUBLIC or PRIVATE.


Type: String

Valid Values: ARN | PLATFORM | OS_VERSION | MODEL | AVAILABILITY | FORM_FACTOR| MANUFACTURER | REMOTE_ACCESS_ENABLED | REMOTE_DEBUG_ENABLED | INSTANCE_ARN| INSTANCE_LABELS | FLEET_TYPE

Required: Nooperator

Specifies how Device Farm compares the filter's attribute to the value. See the attribute descriptions.

Type: String

Valid Values: EQUALS | LESS_THAN | LESS_THAN_OR_EQUALS | GREATER_THAN |GREATER_THAN_OR_EQUALS | IN | NOT_IN | CONTAINS

Required: Novalues

An array of one or more filter values used in a device filter.

Operator Values

• The IN and NOT_IN operators can take a values array that has more than one element.• The other operators require an array with a single element.

Attribute Values

• The PLATFORM attribute can be set to ANDROID or IOS.• The AVAILABILITY attribute can be set to AVAILABLE, HIGHLY_AVAILABLE, BUSY, or

TEMPORARY_NOT_AVAILABLE.• The FORM_FACTOR attribute can be set to PHONE or TABLET.• The FLEET_TYPE attribute can be set to PUBLIC or PRIVATE.





Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/DeviceFilter

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/DeviceFilter

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/DeviceFilter

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/DeviceFilter

AWS Device Farm API ReferenceDeviceInstance

DeviceInstanceRepresents the device instance.

Contentsarn


Type: String


Pattern: ârn:.+

Required: NodeviceArn

The ARN of the device.

Type: String


Pattern: ârn:.+

Required: NoinstanceProfile

A object that contains information about the instance profile.


Required: Nolabels

An array of strings that describe the device instance.


Required: Nostatus

The status of the device instance. Valid values are listed here.

Type: String

Valid Values: IN_USE | PREPARING | AVAILABLE | NOT_AVAILABLE

Required: Noudid

Unique device identifier for the device instance.

Type: String

Required: No






https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/DeviceInstance

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/DeviceInstance

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/DeviceInstance

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/DeviceInstance

AWS Device Farm API ReferenceDeviceMinutes

DeviceMinutesRepresents the total (metered or unmetered) minutes used by the resource to run tests. Contains thesum of minutes consumed by all children.

Contentsmetered

When specified, represents only the sum of metered minutes used by the resource to run tests.

Type: Double

Required: Nototal

When specified, represents the total minutes used by the resource to run tests.

Type: Double

Required: Nounmetered

When specified, represents only the sum of unmetered minutes used by the resource to run tests.

Type: Double

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/DeviceMinutes

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/DeviceMinutes

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/DeviceMinutes

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/DeviceMinutes

AWS Device Farm API ReferenceDevicePool

DevicePoolRepresents a collection of device types.

Contentsarn


Type: String


Pattern: ârn:.+

Required: Nodescription

The device pool's description.

Type: String


Required: NomaxDevices

The number of devices that Device Farm can add to your device pool. Device Farm adds devices thatare available and meet the criteria that you assign for the rules parameter. Depending on howmany devices meet these constraints, your device pool might contain fewer devices than the valuefor this parameter.


Type: Integer

Required: Noname

The device pool's name.

Type: String


Required: Norules

Information about the device pool's rules.


Required: Notype

The device pool's type.



Allowed values include:• CURATED: A device pool that is created and managed by AWS Device Farm.• PRIVATE: A device pool that is created and managed by the device pool developer.

Type: String


Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/DevicePool

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/DevicePool

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/DevicePool

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/DevicePool

AWS Device Farm API ReferenceDevicePoolCompatibilityResult

DevicePoolCompatibilityResultRepresents a device pool compatibility result.

Contentscompatible

Whether the result was compatible with the device pool.

Type: Boolean

Required: Nodevice

The device (phone or tablet) to return information about.


Required: NoincompatibilityMessages

Information about the compatibility.

Type: Array of IncompatibilityMessage (p. 259) objects

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/DevicePoolCompatibilityResult

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/DevicePoolCompatibilityResult

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/DevicePoolCompatibilityResult

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/DevicePoolCompatibilityResult

AWS Device Farm API ReferenceDeviceSelectionConfiguration

DeviceSelectionConfigurationRepresents the device filters used in a test run and the maximum number of devices to be includedin the run. It is passed in as the deviceSelectionConfiguration request parameter inScheduleRun (p. 188).

Contentsfilters

Used to dynamically select a set of devices for a test run. A filter is made up of an attribute, anoperator, and one or more values.

• Attribute

The aspect of a device such as platform or model used as the selection criteria in a device filter.

Allowed values include:

• ARN: The Amazon Resource Name (ARN) of the device (for example,arn:aws:devicefarm:us-west-2::device:12345Example).

• PLATFORM: The device platform. Valid values are ANDROID or IOS.

• OS_VERSION: The operating system version (for example, 10.3.2).

• MODEL: The device model (for example, iPad 5th Gen).

• AVAILABILITY: The current availability of the device. Valid values are AVAILABLE,HIGHLY_AVAILABLE, BUSY, or TEMPORARY_NOT_AVAILABLE.

• FORM_FACTOR: The device form factor. Valid values are PHONE or TABLET.

• MANUFACTURER: The device manufacturer (for example, Apple).

• REMOTE_ACCESS_ENABLED: Whether the device is enabled for remote access. Valid values areTRUE or FALSE.

• REMOTE_DEBUG_ENABLED: Whether the device is enabled for remote debugging. Valid valuesare TRUE or FALSE. Because remote debugging is no longer supported, this filter is ignored.

• INSTANCE_ARN: The Amazon Resource Name (ARN) of the device instance.

• INSTANCE_LABELS: The label of the device instance.

• FLEET_TYPE: The fleet type. Valid values are PUBLIC or PRIVATE.

• Operator

The filter operator.

• The EQUALS operator is available for every attribute except INSTANCE_LABELS.

• The CONTAINS operator is available for the INSTANCE_LABELS and MODEL attributes.

• The IN and NOT_IN operators are available for the ARN, OS_VERSION, MODEL,MANUFACTURER, and INSTANCE_ARN attributes.

• The LESS_THAN, GREATER_THAN, LESS_THAN_OR_EQUALS, and GREATER_THAN_OR_EQUALSoperators are also available for the OS_VERSION attribute.

• Values

An array of one or more filter values.

Operator Values

• The IN and NOT_IN operators can take a values array that has more than one element.

• The other operators require an array with a single element.API Version 2015-06-23

255



Attribute Values

• The PLATFORM attribute can be set to ANDROID or IOS.• The AVAILABILITY attribute can be set to AVAILABLE, HIGHLY_AVAILABLE, BUSY, or

TEMPORARY_NOT_AVAILABLE.• The FORM_FACTOR attribute can be set to PHONE or TABLET.• The FLEET_TYPE attribute can be set to PUBLIC or PRIVATE.


Required: YesmaxDevices

The maximum number of devices to be included in a test run.

Type: Integer

Required: Yes




https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/DeviceSelectionConfiguration

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/DeviceSelectionConfiguration

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/DeviceSelectionConfiguration

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/DeviceSelectionConfiguration

AWS Device Farm API ReferenceDeviceSelectionResult

DeviceSelectionResultContains the run results requested by the device selection configuration and how many devices werereturned. For an example of the JSON response syntax, see ScheduleRun (p. 188).

Contentsfilters

The filters in a device selection result.


Required: NomatchedDevicesCount

The number of devices that matched the device filter selection criteria.

Type: Integer

Required: NomaxDevices

The maximum number of devices to be selected by a device filter and included in a test run.

Type: Integer

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/DeviceSelectionResult

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/DeviceSelectionResult

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/DeviceSelectionResult

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/DeviceSelectionResult

AWS Device Farm API ReferenceExecutionConfiguration

ExecutionConfigurationRepresents configuration information about a test run, such as the execution timeout (in minutes).

ContentsaccountsCleanup

True if account cleanup is enabled at the beginning of the test. Otherwise, false.

Type: Boolean

Required: NoappPackagesCleanup

True if app package cleanup is enabled at the beginning of the test. Otherwise, false.

Type: Boolean

Required: NojobTimeoutMinutes

The number of minutes a test run executes before it times out.

Type: Integer




Type: Boolean

Required: NovideoCapture

Set to true to enable video capture. Otherwise, set to false. The default is true.

Type: Boolean

Required: No





https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/ExecutionConfiguration

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/ExecutionConfiguration

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/ExecutionConfiguration

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/ExecutionConfiguration

AWS Device Farm API ReferenceIncompatibilityMessage

IncompatibilityMessageRepresents information about incompatibility.

Contentsmessage

A message about the incompatibility.

Type: String


Required: Notype

The type of incompatibility.

Allowed values include:• ARN• FORM_FACTOR (for example, phone or tablet)• MANUFACTURER• PLATFORM (for example, Android or iOS)• REMOTE_ACCESS_ENABLED• APPIUM_VERSION

Type: String

Valid Values: ARN | PLATFORM | FORM_FACTOR | MANUFACTURER |REMOTE_ACCESS_ENABLED | REMOTE_DEBUG_ENABLED | APPIUM_VERSION | INSTANCE_ARN| INSTANCE_LABELS | FLEET_TYPE | OS_VERSION | MODEL | AVAILABILITY

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/IncompatibilityMessage

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/IncompatibilityMessage

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/IncompatibilityMessage

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/IncompatibilityMessage

AWS Device Farm API ReferenceInstanceProfile

InstanceProfileRepresents the instance profile.

Contentsarn

The Amazon Resource Name (ARN) of the instance profile.

Type: String


Pattern: ârn:.+


The description of the instance profile.

Type: String


Required: NoexcludeAppPackagesFromCleanup

An array of strings containing the list of app packages that should not be cleaned up from the deviceafter a test run completes.

The list of packages is considered only if you set packageCleanup to true.


Required: Noname

The name of the instance profile.

Type: String


Required: NopackageCleanup

When set to true, Device Farm removes app packages after a test run. The default value is falsefor private devices.

Type: Boolean

Required: NorebootAfterUse

When set to true, Device Farm reboots the instance after a test run. The default value is true.

Type: Boolean



Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/InstanceProfile

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/InstanceProfile

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/InstanceProfile

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/InstanceProfile

AWS Device Farm API ReferenceJob

JobRepresents a device.

Contentsarn

The job's ARN.

Type: String


Pattern: ârn:.+

Required: Nocounters

The job's result counters.

Type: Counters (p. 237) object

Required: Nocreated

When the job was created.

Type: Timestamp

Required: Nodevice

The device (phone or tablet).


Required: NodeviceMinutes

Represents the total (metered or unmetered) minutes used by the job.

Type: DeviceMinutes (p. 251) object

Required: NoinstanceArn

The ARN of the instance.

Type: String


Pattern: ârn:.+

Required: Nomessage

A message about the job's result.



Type: String


Required: Noname

The job's name.

Type: String


Required: Noresult

The job's result.


Type: String

Valid Values: PENDING | PASSED | WARNED | FAILED | SKIPPED | ERRORED | STOPPED

Required: Nostarted

The job's start time.

Type: Timestamp

Required: Nostatus

The job's status.

Allowed values include:• PENDING• PENDING_CONCURRENCY• PENDING_DEVICE• PROCESSING• SCHEDULING• PREPARING• RUNNING• COMPLETED• STOPPING

Type: String



Valid Values: PENDING | PENDING_CONCURRENCY | PENDING_DEVICE | PROCESSING |SCHEDULING | PREPARING | RUNNING | COMPLETED | STOPPING

Required: Nostopped

The job's stop time.

Type: Timestamp

Required: Notype

The job's type.

Allowed values include the following:• BUILTIN_FUZZ• BUILTIN_EXPLORER. For Android, an app explorer that traverses an Android app, interacting with

it and capturing screenshots at the same time.• APPIUM_JAVA_JUNIT• APPIUM_JAVA_TESTNG• APPIUM_PYTHON• APPIUM_NODE• APPIUM_RUBY• APPIUM_WEB_JAVA_JUNIT• APPIUM_WEB_JAVA_TESTNG• APPIUM_WEB_PYTHON• APPIUM_WEB_NODE• APPIUM_WEB_RUBY• CALABASH• INSTRUMENTATION• UIAUTOMATION• UIAUTOMATOR• XCTEST• XCTEST_UI

Type: String


Required: NovideoCapture

This value is set to true if video capture is enabled. Otherwise, it is set to false.

Type: Boolean

Required: No



videoEndpoint

The endpoint for streaming device video.

Type: String

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/Job

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/Job

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/Job

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/Job

AWS Device Farm API ReferenceListTestGridProjectsRequest

ListTestGridProjectsRequestContentsmaxResult

Return no more than this number of results.

Type: Integer


Required: NonextToken

From a response, used to continue a paginated listing.

Type: String


Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/ListTestGridProjectsRequest

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/ListTestGridProjectsRequest

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/ListTestGridProjectsRequest

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/ListTestGridProjectsRequest

AWS Device Farm API ReferenceListTestGridSessionsRequest

ListTestGridSessionsRequestContentscreationTimeAfter

Return only sessions created after this time.

Type: Timestamp

Required: NocreationTimeBefore

Return only sessions created before this time.

Type: Timestamp

Required: NoendTimeAfter

Return only sessions that ended after this time.

Type: Timestamp

Required: NoendTimeBefore

Return only sessions that ended before this time.

Type: Timestamp

Required: NomaxResult

Return only this many results at a time.

Type: Integer


Required: NonextToken

Pagination token.

Type: String


Required: NoprojectArn

ARN of a TestGridProject (p. 313).

Type: String





Required: Yesstatus

Return only sessions in this state.

Type: String


Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/ListTestGridSessionsRequest

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/ListTestGridSessionsRequest

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/ListTestGridSessionsRequest

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/ListTestGridSessionsRequest

AWS Device Farm API ReferenceLocation

LocationRepresents a latitude and longitude pair, expressed in geographic coordinate system degrees (forexample, 47.6204, -122.3491).

Elevation is currently not supported.

Contentslatitude

The latitude.

Type: Double

Required: Yeslongitude

The longitude.

Type: Double

Required: Yes




https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/Location

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/Location

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/Location

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/Location

AWS Device Farm API ReferenceMonetaryAmount

MonetaryAmountA number that represents the monetary amount for an offering or transaction.

Contentsamount

The numerical amount of an offering or transaction.

Type: Double

Required: NocurrencyCode

The currency code of a monetary amount. For example, USD means U.S. dollars.

Type: String

Valid Values: USD

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/MonetaryAmount

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/MonetaryAmount

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/MonetaryAmount

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/MonetaryAmount

AWS Device Farm API ReferenceNetworkProfile

NetworkProfileAn array of settings that describes characteristics of a network profile.

Contentsarn

The Amazon Resource Name (ARN) of the network profile.

Type: String


Pattern: ârn:.+


The description of the network profile.

Type: String


Required: NodownlinkBandwidthBits


Type: Long

Required: NodownlinkDelayMs


Type: Long

Required: NodownlinkJitterMs


Type: Long

Required: NodownlinkLossPercent


Type: Integer


Required: Noname

The name of the network profile.



Type: String


Required: Notype

The type of network profile. Valid values are listed here.

Type: String


Required: NouplinkBandwidthBits


Type: Long

Required: NouplinkDelayMs


Type: Long

Required: NouplinkJitterMs


Type: Long

Required: NouplinkLossPercent


Type: Integer


Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/NetworkProfile

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/NetworkProfile

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/NetworkProfile

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/NetworkProfile

AWS Device Farm API ReferenceOffering

OfferingRepresents the metadata of a device offering.

Contentsdescription

A string that describes the offering.

Type: String


Required: Noid

The ID that corresponds to a device offering.

Type: String



The platform of the device (for example, ANDROID or IOS).

Type: String


Required: NorecurringCharges

Specifies whether there are recurring charges for the offering.

Type: Array of RecurringCharge (p. 283) objects

Required: Notype

The type of offering (for example, RECURRING) for a device.

Type: String

Valid Values: RECURRING

Required: No


• AWS SDK for C++• AWS SDK for Go


https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/Offering

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/Offering


• AWS SDK for Java• AWS SDK for Ruby V3


https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/Offering

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/Offering

AWS Device Farm API ReferenceOfferingPromotion

OfferingPromotionRepresents information about an offering promotion.

Contentsdescription

A string that describes the offering promotion.

Type: String


Required: Noid

The ID of the offering promotion.

Type: String


Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/OfferingPromotion

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/OfferingPromotion

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/OfferingPromotion

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/OfferingPromotion

AWS Device Farm API ReferenceOfferingStatus

OfferingStatusThe status of the offering.

ContentseffectiveOn

The date on which the offering is effective.

Type: Timestamp

Required: Nooffering

Represents the metadata of an offering status.

Type: Offering (p. 273) object

Required: Noquantity

The number of available devices in the offering.

Type: Integer

Required: Notype

The type specified for the offering status.

Type: String

Valid Values: PURCHASE | RENEW | SYSTEM

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/OfferingStatus

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/OfferingStatus

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/OfferingStatus

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/OfferingStatus

AWS Device Farm API ReferenceOfferingTransaction

OfferingTransactionRepresents the metadata of an offering transaction.

Contentscost

The cost of an offering transaction.

Type: MonetaryAmount (p. 270) object

Required: NocreatedOn

The date on which an offering transaction was created.

Type: Timestamp

Required: NoofferingPromotionId

The ID that corresponds to a device offering promotion.

Type: String


Required: NoofferingStatus

The status of an offering transaction.

Type: OfferingStatus (p. 276) object

Required: NotransactionId

The transaction ID of the offering transaction.

Type: String


Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/OfferingTransaction

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/OfferingTransaction

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/OfferingTransaction

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/OfferingTransaction

AWS Device Farm API ReferenceProblem

ProblemRepresents a specific warning or failure.

Contentsdevice

Information about the associated device.


Required: Nojob

Information about the associated job.

Type: ProblemDetail (p. 280) object

Required: Nomessage

A message about the problem's result.

Type: String


Required: Noresult

The problem's result.


Type: String


Required: Norun

Information about the associated run.


Required: Nosuite

Information about the associated suite.




Required: Notest

Information about the associated test.


Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/Problem

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/Problem

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/Problem

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/Problem

AWS Device Farm API ReferenceProblemDetail

ProblemDetailInformation about a problem detail.

Contentsarn

The problem detail's ARN.

Type: String


Pattern: ârn:.+

Required: Noname

The problem detail's name.

Type: String


Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/ProblemDetail

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/ProblemDetail

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/ProblemDetail

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/ProblemDetail

AWS Device Farm API ReferenceProject

ProjectRepresents an operating-system neutral workspace for running and managing tests.

Contentsarn

The project's ARN.

Type: String


Pattern: ârn:.+

Required: Nocreated

When the project was created.

Type: Timestamp

Required: NodefaultJobTimeoutMinutes

The default number of minutes (at the project level) a test run executes before it times out. Thedefault value is 150 minutes.

Type: Integer

Required: Noname

The project's name.

Type: String


Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/Project

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/Project

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/Project

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/Project

AWS Device Farm API ReferenceRadios

RadiosRepresents the set of radios and their states on a device. Examples of radios include Wi-Fi, GPS,Bluetooth, and NFC.

Contentsbluetooth

True if Bluetooth is enabled at the beginning of the test. Otherwise, false.

Type: Boolean

Required: Nogps

True if GPS is enabled at the beginning of the test. Otherwise, false.

Type: Boolean

Required: Nonfc

True if NFC is enabled at the beginning of the test. Otherwise, false.

Type: Boolean

Required: Nowifi

True if Wi-Fi is enabled at the beginning of the test. Otherwise, false.

Type: Boolean

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/Radios

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/Radios

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/Radios

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/Radios

AWS Device Farm API ReferenceRecurringCharge

RecurringChargeSpecifies whether charges for devices are recurring.

Contentscost

The cost of the recurring charge.

Type: MonetaryAmount (p. 270) object

Required: Nofrequency

The frequency in which charges recur.

Type: String

Valid Values: MONTHLY

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/RecurringCharge

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/RecurringCharge

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/RecurringCharge

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/RecurringCharge

AWS Device Farm API ReferenceRemoteAccessSession

RemoteAccessSessionRepresents information about the remote access session.

Contentsarn

The Amazon Resource Name (ARN) of the remote access session.

Type: String


Pattern: ârn:.+

Required: NobillingMethod

The billing method of the remote access session. Possible values include METERED or UNMETERED.For more information about metered devices, see AWS Device Farm terminology.

Type: String


Required: NoclientId

Unique identifier of your client for the remote access session. Only returned if remote debugging isenabled for the remote access session.


Type: String


Required: Nocreated

The date and time the remote access session was created.

Type: Timestamp

Required: Nodevice

The device (phone or tablet) used in the remote access session.



The number of minutes a device is used in a remote access session (including setup and teardownminutes).


https://docs.aws.amazon.com/devicefarm/latest/developerguide/welcome.html#welcome-terminology




Required: NodeviceUdid

Unique device identifier for the remote device. Only returned if remote debugging is enabled for theremote access session.


Type: String

Required: Noendpoint

The endpoint for the remote access sesssion.

Type: String

Required: NohostAddress

IP address of the EC2 host where you need to connect to remotely debug devices. Only returned ifremote debugging is enabled for the remote access session.


Type: String

Length Constraints: Maximum length of 1024.

Required: NoinstanceArn

The ARN of the instance.

Type: String


Pattern: ârn:.+

Required: NointeractionMode

The interaction mode of the remote access session. Valid values are:• INTERACTIVE: You can interact with the iOS device by viewing, touching, and rotating the screen.

You cannot run XCUITest framework-based tests in this mode.• NO_VIDEO: You are connected to the device, but cannot interact with it or view the screen. This

mode has the fastest test execution speed. You can run XCUITest framework-based tests in thismode.

• VIDEO_ONLY: You can view the screen, but cannot touch or rotate it. You can run XCUITestframework-based tests and watch the screen in this mode.

Type: String


Valid Values: INTERACTIVE | NO_VIDEO | VIDEO_ONLY





Required: Nomessage

A message about the remote access session.

Type: String


Required: Noname

The name of the remote access session.

Type: String


Required: NoremoteDebugEnabled

This flag is set to true if remote debugging is enabled for the remote access session.


Type: Boolean

Required: NoremoteRecordAppArn

The ARN for the app to be recorded in the remote access session.

Type: String


Pattern: ârn:.+

Required: NoremoteRecordEnabled

This flag is set to true if remote recording is enabled for the remote access session.

Type: Boolean

Required: Noresult

The result of the remote access session. Can be any of the following:• PENDING.• PASSED.• WARNED.• FAILED.• SKIPPED.• ERRORED.• STOPPED.

Type: String








Type: Boolean

Required: Nostarted

The date and time the remote access session was started.

Type: Timestamp

Required: Nostatus

The status of the remote access session. Can be any of the following:• PENDING.• PENDING_CONCURRENCY.• PENDING_DEVICE.• PROCESSING.• SCHEDULING.• PREPARING.• RUNNING.• COMPLETED.• STOPPING.

Type: String


Required: Nostopped

The date and time the remote access session was stopped.

Type: Timestamp

Required: No


• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java



https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/RemoteAccessSession

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/RemoteAccessSession

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/RemoteAccessSession




https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/RemoteAccessSession

AWS Device Farm API ReferenceResolution

ResolutionRepresents the screen resolution of a device in height and width, expressed in pixels.

Contentsheight

The screen resolution's height, expressed in pixels.

Type: Integer

Required: Nowidth

The screen resolution's width, expressed in pixels.

Type: Integer

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/Resolution

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/Resolution

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/Resolution

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/Resolution

AWS Device Farm API ReferenceRule

RuleRepresents a condition for a device pool.

Contentsattribute

The rule's stringified attribute. For example, specify the value as "\"abc\"".

The supported operators for each attribute are provided in the following list.APPIUM_VERSION

The Appium version for the test.

Supported operators: CONTAINSARN

The Amazon Resource Name (ARN) of the device (for example, arn:aws:devicefarm:us-west-2::device:12345Example.

Supported operators: EQUALS, IN, NOT_INAVAILABILITY

The current availability of the device. Valid values are AVAILABLE, HIGHLY_AVAILABLE, BUSY, orTEMPORARY_NOT_AVAILABLE.

Supported operators: EQUALSFLEET_TYPE

The fleet type. Valid values are PUBLIC or PRIVATE.

Supported operators: EQUALSFORM_FACTOR

The device form factor. Valid values are PHONE or TABLET.

Supported operators: EQUALS, IN, NOT_ININSTANCE_ARN


Supported operators: IN, NOT_ININSTANCE_LABELS

The label of the device instance.

Supported operators: CONTAINSMANUFACTURER

The device manufacturer (for example, Apple).

Supported operators: EQUALS, IN, NOT_INMODEL

The device model, such as Apple iPad Air 2 or Google Pixel.



Supported operators: CONTAINS, EQUALS, IN, NOT_INOS_VERSION

The operating system version (for example, 10.3.2).

Supported operators: EQUALS, GREATER_THAN, GREATER_THAN_OR_EQUALS, IN, LESS_THAN,LESS_THAN_OR_EQUALS, NOT_IN

PLATFORM

The device platform. Valid values are ANDROID or IOS.

Supported operators: EQUALS, IN, NOT_INREMOTE_ACCESS_ENABLED

Whether the device is enabled for remote access. Valid values are TRUE or FALSE.

Supported operators: EQUALSREMOTE_DEBUG_ENABLED

Whether the device is enabled for remote debugging. Valid values are TRUE or FALSE.


Because remote debugging is no longer supported, this filter is ignored.

Type: String

Valid Values: ARN | PLATFORM | FORM_FACTOR | MANUFACTURER |REMOTE_ACCESS_ENABLED | REMOTE_DEBUG_ENABLED | APPIUM_VERSION | INSTANCE_ARN| INSTANCE_LABELS | FLEET_TYPE | OS_VERSION | MODEL | AVAILABILITY

Required: Nooperator

Specifies how Device Farm compares the rule's attribute to the value. For the operators that aresupported by each attribute, see the attribute descriptions.

Type: String

Valid Values: EQUALS | LESS_THAN | LESS_THAN_OR_EQUALS | GREATER_THAN |GREATER_THAN_OR_EQUALS | IN | NOT_IN | CONTAINS

Required: Novalue

The rule's value.

Type: String

Required: No


• AWS SDK for C++• AWS SDK for Go



https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/Rule

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/Rule


• AWS SDK for Java• AWS SDK for Ruby V3


https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/Rule

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/Rule

AWS Device Farm API ReferenceRun

RunRepresents a test run on a set of devices with a given app package, test parameters, and so on.

ContentsappUpload

An app to upload or that has been uploaded.

Type: String


Pattern: ârn:.+

Required: Noarn

The run's ARN.

Type: String


Pattern: ârn:.+


Specifies the billing method for a test run: metered or unmetered. If the parameter is not specified,the default value is metered.

NoteIf you have unmetered device slots, you must set this to unmetered to use them.Otherwise, the run is counted toward metered device minutes.

Type: String


Required: NocompletedJobs

The total number of completed jobs.

Type: Integer


The run's result counters.


Required: Nocreated

When the run was created.



Type: Timestamp

Required: NocustomerArtifactPaths

Output CustomerArtifactPaths object for the test run.

Type: CustomerArtifactPaths (p. 241) object


Represents the total (metered or unmetered) minutes used by the test run.


Required: NodevicePoolArn

The ARN of the device pool for the run.

Type: String


Pattern: ârn:.+

Required: NodeviceSelectionResult

The results of a device filter used to select the devices for a test run.

Type: DeviceSelectionResult (p. 257) object

Required: NoeventCount

For fuzz tests, this is the number of events, between 1 and 10000, that the UI fuzz test shouldperform.

Type: Integer

Required: NojobTimeoutMinutes

The number of minutes the job executes before it times out.

Type: Integer

Required: Nolocale

Information about the locale that is used for the run.

Type: String

Required: Nolocation

Information about the location that is used for the run.



Type: Location (p. 269) object

Required: Nomessage

A message about the run's result.

Type: String


Required: Noname

The run's name.

Type: String


Required: NonetworkProfile

The network profile being used for a test run.


Required: NoparsingResultUrl

Read-only URL for an object in an S3 bucket where you can get the parsing results of the testpackage. If the test package doesn't parse, the reason why it doesn't parse appears in the file thatthis URL points to.

Type: String


The run's platform.

Allowed values include:• ANDROID• IOS

Type: String


Required: Noradios

Information about the radio states for the run.

Type: Radios (p. 282) object

Required: Noresult

The run's result.




Type: String


Required: NoresultCode

Supporting field for the result field. Set only if result is SKIPPED. PARSING_FAILED if the result isskipped because of test package parsing failure.

Type: String

Valid Values: PARSING_FAILED | VPC_ENDPOINT_SETUP_FAILED

Required: Noseed

For fuzz tests, this is a seed to use for randomizing the UI fuzz test. Using the same seed valuebetween tests ensures identical event sequences.

Type: Integer




Type: Boolean

Required: Nostarted

The run's start time.

Type: Timestamp

Required: Nostatus

The run's status.

Allowed values include:• PENDING• PENDING_CONCURRENCY




• PENDING_DEVICE• PROCESSING• SCHEDULING• PREPARING• RUNNING• COMPLETED• STOPPING

Type: String


Required: Nostopped

The run's stop time.

Type: Timestamp

Required: NotestSpecArn

The ARN of the YAML-formatted test specification for the run.

Type: String


Pattern: ârn:.+

Required: NototalJobs

The total number of jobs for the run.

Type: Integer

Required: Notype

The run's type.

Must be one of the following values:• BUILTIN_FUZZ• BUILTIN_EXPLORER

NoteFor Android, an app explorer that traverses an Android app, interacting with it andcapturing screenshots at the same time.

• APPIUM_JAVA_JUNIT• APPIUM_JAVA_TESTNG• APPIUM_PYTHON• APPIUM_NODE• APPIUM_RUBY• APPIUM_WEB_JAVA_JUNIT



• APPIUM_WEB_JAVA_TESTNG• APPIUM_WEB_PYTHON• APPIUM_WEB_NODE• APPIUM_WEB_RUBY• CALABASH• INSTRUMENTATION• UIAUTOMATION• UIAUTOMATOR• XCTEST• XCTEST_UI

Type: String


Required: NowebUrl

The Device Farm console URL for the recording of the run.

Type: String

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/Run

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/Run

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/Run

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/Run

AWS Device Farm API ReferenceSample

SampleRepresents a sample of performance data.

Contentsarn

The sample's ARN.

Type: String


Pattern: ârn:.+

Required: No

type

The sample's type.

Must be one of the following values:

• CPU: A CPU sample type. This is expressed as the app processing CPU time (including childprocesses) as reported by process, as a percentage.

• MEMORY: A memory usage sample type. This is expressed as the total proportional set size of anapp process, in kilobytes.

• NATIVE_AVG_DRAWTIME

• NATIVE_FPS

• NATIVE_FRAMES

• NATIVE_MAX_DRAWTIME

• NATIVE_MIN_DRAWTIME

• OPENGL_AVG_DRAWTIME

• OPENGL_FPS

• OPENGL_FRAMES

• OPENGL_MAX_DRAWTIME

• OPENGL_MIN_DRAWTIME

• RX

• RX_RATE: The total number of bytes per second (TCP and UDP) that are sent, by app process.

• THREADS: A threads sample type. This is expressed as the total number of threads per appprocess.

• TX

• TX_RATE: The total number of bytes per second (TCP and UDP) that are received, by app process.

Type: String

Valid Values: CPU | MEMORY | THREADS | RX_RATE | TX_RATE | RX | TX |NATIVE_FRAMES | NATIVE_FPS | NATIVE_MIN_DRAWTIME | NATIVE_AVG_DRAWTIME |NATIVE_MAX_DRAWTIME | OPENGL_FRAMES | OPENGL_FPS | OPENGL_MIN_DRAWTIME |OPENGL_AVG_DRAWTIME | OPENGL_MAX_DRAWTIME

Required: No



url

The presigned Amazon S3 URL that can be used with a GET request to download the sample's file.

Type: String


Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/Sample

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/Sample

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/Sample

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/Sample

AWS Device Farm API ReferenceScheduleRunConfiguration

ScheduleRunConfigurationRepresents the settings for a run. Includes things like location, radio states, auxiliary apps, and networkprofiles.

ContentsauxiliaryApps

A list of upload ARNs for app packages to be installed with your app.



Pattern: ârn:.+


Specifies the billing method for a test run: metered or unmetered. If the parameter is not specified,the default value is metered.

NoteIf you have purchased unmetered device slots, you must set this parameter to unmeteredto make use of them. Otherwise, your run counts against your metered time.

Type: String


Required: NocustomerArtifactPaths

Input CustomerArtifactPaths object for the scheduled run configuration.

Type: CustomerArtifactPaths (p. 241) object

Required: NoextraDataPackageArn

The ARN of the extra data for the run. The extra data is a .zip file that AWS Device Farm extracts toexternal data for Android or the app's sandbox for iOS.

Type: String


Pattern: ârn:.+

Required: Nolocale

Information about the locale that is used for the run.

Type: String

Required: No



location

Information about the location that is used for the run.

Type: Location (p. 269) object

Required: NonetworkProfileArn

Reserved for internal use.

Type: String


Pattern: ârn:.+

Required: Noradios

Information about the radio states for the run.

Type: Radios (p. 282) object

Required: NovpceConfigurationArns

An array of ARNs for your VPC endpoint configurations.



Pattern: ârn:.+

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/ScheduleRunConfiguration

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/ScheduleRunConfiguration

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/ScheduleRunConfiguration

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/ScheduleRunConfiguration

AWS Device Farm API ReferenceScheduleRunTest

ScheduleRunTestRepresents test settings. This data structure is passed in as the test parameter to ScheduleRun. For anexample of the JSON request syntax, see ScheduleRun (p. 188).

Contentsfilter

The test's filter.

Type: String


Required: Noparameters

The test's parameters, such as test framework parameters and fixture settings. Parameters arerepresented by name-value pairs of strings.

For all tests:• app_performance_monitoring: Performance monitoring is enabled by default. Set this

parameter to false to disable it.

For Calabash tests:• profile: A cucumber profile (for example, my_profile_name).• tags: You can limit execution to features or scenarios that have (or don't have) certain tags (for

example, @smoke or @smoke,~@wip).

For Appium tests (all types):• appium_version: The Appium version. Currently supported values are 1.6.5 (and later), latest, and

default.• latest runs the latest Appium version supported by Device Farm (1.9.1).• For default, Device Farm selects a compatible version of Appium for the device. The current

behavior is to run 1.7.2 on Android devices and iOS 9 and earlier and 1.7.2 for iOS 10 and later.• This behavior is subject to change.

For fuzz tests (Android only):• event_count: The number of events, between 1 and 10000, that the UI fuzz test should perform.• throttle: The time, in ms, between 0 and 1000, that the UI fuzz test should wait between events.• seed: A seed to use for randomizing the UI fuzz test. Using the same seed value between tests

ensures identical event sequences.

For Explorer tests:• username: A user name to use if the Explorer encounters a login form. If not supplied, no user

name is inserted.• password: A password to use if the Explorer encounters a login form. If not supplied, no password

is inserted.

For Instrumentation:• filter: A test filter string. Examples:

• Running a single test case: com.android.abc.Test1



• Running a single test: com.android.abc.Test1#smoke• Running multiple tests: com.android.abc.Test1,com.android.abc.Test2

For XCTest and XCTestUI:• filter: A test filter string. Examples:

• Running a single test class: LoginTests• Running a multiple test classes: LoginTests,SmokeTests• Running a single test: LoginTests/testValid• Running multiple tests: LoginTests/testValid,LoginTests/testInvalid

For UIAutomator:• filter: A test filter string. Examples:

• Running a single test case: com.android.abc.Test1• Running a single test: com.android.abc.Test1#smoke• Running multiple tests: com.android.abc.Test1,com.android.abc.Test2

Type: String to string map

Required: NotestPackageArn

The ARN of the uploaded test to be run.

Type: String


Pattern: ârn:.+

Required: NotestSpecArn

The ARN of the YAML-formatted test specification.

Type: String


Pattern: ârn:.+

Required: Notype

The test's type.

Must be one of the following values:• BUILTIN_FUZZ• BUILTIN_EXPLORER. For Android, an app explorer that traverses an Android app, interacting with

it and capturing screenshots at the same time.• APPIUM_JAVA_JUNIT• APPIUM_JAVA_TESTNG• APPIUM_PYTHON• APPIUM_NODE• APPIUM_RUBY• APPIUM_WEB_JAVA_JUNIT



• APPIUM_WEB_JAVA_TESTNG• APPIUM_WEB_PYTHON• APPIUM_WEB_NODE• APPIUM_WEB_RUBY• CALABASH• INSTRUMENTATION• UIAUTOMATION• UIAUTOMATOR• XCTEST• XCTEST_UI

Type: String


Required: Yes




https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/ScheduleRunTest

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/ScheduleRunTest

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/ScheduleRunTest

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/ScheduleRunTest

AWS Device Farm API ReferenceSuite

SuiteRepresents a collection of one or more tests.

Contentsarn

The suite's ARN.

Type: String


Pattern: ârn:.+


The suite's result counters.


Required: Nocreated

When the suite was created.

Type: Timestamp


Represents the total (metered or unmetered) minutes used by the test suite.


Required: Nomessage

A message about the suite's result.

Type: String


Required: Noname

The suite's name.

Type: String


Required: Noresult

The suite's result.




Type: String


Required: Nostarted

The suite's start time.

Type: Timestamp

Required: Nostatus

The suite's status.


Type: String


Required: Nostopped

The suite's stop time.

Type: Timestamp

Required: Notype

The suite's type.

Must be one of the following values:• BUILTIN_FUZZ



• BUILTIN_EXPLORER

NoteOnly available for Android; an app explorer that traverses an Android app, interactingwith it and capturing screenshots at the same time.

• APPIUM_JAVA_JUNIT• APPIUM_JAVA_TESTNG• APPIUM_PYTHON• APPIUM_NODE• APPIUM_RUBY• APPIUM_WEB_JAVA_JUNIT• APPIUM_WEB_JAVA_TESTNG• APPIUM_WEB_PYTHON• APPIUM_WEB_NODE• APPIUM_WEB_RUBY• CALABASH• INSTRUMENTATION• UIAUTOMATION• UIAUTOMATOR• XCTEST• XCTEST_UI

Type: String


Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/Suite

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/Suite

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/Suite

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/Suite

AWS Device Farm API ReferenceTag

TagThe metadata that you apply to a resource to help you categorize and organize it. Each tag consists of akey and an optional value, both of which you define. Tag keys can have a maximum character length of128 characters. Tag values can have a maximum length of 256 characters.

ContentsKey

One part of a key-value pair that makes up a tag. A key is a general label that acts like a categoryfor more specific tag values.

Type: String


Required: YesValue

The optional part of a key-value pair that makes up a tag. A value acts as a descriptor in a tagcategory (key).

Type: String


Required: Yes




https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/Tag

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/Tag

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/Tag

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/Tag

AWS Device Farm API ReferenceTest

TestRepresents a condition that is evaluated.

Contentsarn

The test's ARN.

Type: String


Pattern: ârn:.+


The test's result counters.


Required: Nocreated

When the test was created.

Type: Timestamp


Represents the total (metered or unmetered) minutes used by the test.


Required: Nomessage

A message about the test's result.

Type: String


Required: Noname

The test's name.

Type: String


Required: Noresult

The test's result.




Type: String


Required: Nostarted

The test's start time.

Type: Timestamp

Required: Nostatus

The test's status.


Type: String


Required: Nostopped

The test's stop time.

Type: Timestamp

Required: Notype

The test's type.

Must be one of the following values:• BUILTIN_FUZZ



• BUILTIN_EXPLORER

NoteFor Android, an app explorer that traverses an Android app, interacting with it andcapturing screenshots at the same time.

• APPIUM_JAVA_JUNIT• APPIUM_JAVA_TESTNG• APPIUM_PYTHON• APPIUM_NODE• APPIUM_RUBY• APPIUM_WEB_JAVA_JUNIT• APPIUM_WEB_JAVA_TESTNG• APPIUM_WEB_PYTHON• APPIUM_WEB_NODE• APPIUM_WEB_RUBY• CALABASH• INSTRUMENTATION• UIAUTOMATION• UIAUTOMATOR• XCTEST• XCTEST_UI

Type: String


Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/Test

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/Test

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/Test

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/Test

AWS Device Farm API ReferenceTestGridProject

TestGridProjectA Selenium testing project. Projects are used to collect and collate sessions.

Contentsarn

The ARN for the project.

Type: String



Required: Nocreated

When the project was created.

Type: Timestamp


A human-readable description for the project.

Type: String

Required: Noname

A human-readable name for the project.

Type: String

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/TestGridProject

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/TestGridProject

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/TestGridProject

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/TestGridProject

AWS Device Farm API ReferenceTestGridSession

TestGridSessionA TestGridSession (p. 314) is a single instance of a browser launched from the URL provided by a call toCreateTestGridUrl (p. 23).

Contentsarn

The ARN of the session.

Type: String



Required: No

billingMinutes

The number of billed minutes that were used for this session.

Type: Double

Required: No

created

The time that the session was started.

Type: Timestamp

Required: No

ended

The time the session ended.

Type: Timestamp

Required: No

seleniumProperties

A JSON object of options and parameters passed to the Selenium WebDriver.

Type: String

Required: No

status

The state of the session.

Type: String


Required: No






https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/TestGridSession

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/TestGridSession

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/TestGridSession

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/TestGridSession

AWS Device Farm API ReferenceTestGridSessionAction

TestGridSessionActionAn action taken by a TestGridSession (p. 314) browser instance.

Contentsaction

The action taken by the session.

Type: String

Required: Noduration

The time, in milliseconds, that the action took to complete in the browser.

Type: Long

Required: NorequestMethod

HTTP method that the browser used to make the request.

Type: String

Required: Nostarted

The time that the session invoked the action.

Type: Timestamp

Required: NostatusCode

HTTP status code returned to the browser when the action was taken.

Type: String

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/TestGridSessionAction

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/TestGridSessionAction

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/TestGridSessionAction

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/TestGridSessionAction

AWS Device Farm API ReferenceTestGridSessionArtifact

TestGridSessionArtifactArtifacts are video and other files that are produced in the process of running a browser in an automatedcontext.

NoteVideo elements might be broken up into multiple artifacts as they grow in size during creation.

Contentsfilename

The file name of the artifact.

Type: String

Required: Notype

The kind of artifact.

Type: String

Valid Values: UNKNOWN | VIDEO | SELENIUM_LOG

Required: Nourl

A semi-stable URL to the content of the object.

Type: String

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/TestGridSessionArtifact

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/TestGridSessionArtifact

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/TestGridSessionArtifact

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/TestGridSessionArtifact

AWS Device Farm API ReferenceTrialMinutes

TrialMinutesRepresents information about free trial device minutes for an AWS account.

Contentsremaining

The number of free trial minutes remaining in the account.

Type: Double

Required: Nototal

The total number of free trial minutes that the account started with.

Type: Double

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/TrialMinutes

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/TrialMinutes

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/TrialMinutes

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/TrialMinutes

AWS Device Farm API ReferenceUniqueProblem

UniqueProblemA collection of one or more problems, grouped by their result.

Contentsmessage

A message about the unique problems' result.

Type: String


Required: Noproblems

Information about the problems.

Type: Array of Problem (p. 278) objects

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/UniqueProblem

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/UniqueProblem

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/UniqueProblem

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/UniqueProblem

AWS Device Farm API ReferenceUpload

UploadAn app or a set of one or more tests to upload or that have been uploaded.

Contentsarn

The upload's ARN.

Type: String


Pattern: ârn:.+

Required: Nocategory

The upload's category. Allowed values include:• CURATED: An upload managed by AWS Device Farm.• PRIVATE: An upload managed by the AWS Device Farm customer.

Type: String


Required: NocontentType

The upload's content type (for example, application/octet-stream).

Type: String


Required: Nocreated

When the upload was created.

Type: Timestamp

Required: Nomessage

A message about the upload's result.

Type: String


Required: Nometadata

The upload's metadata. For example, for Android, this contains information that is parsed from themanifest and is displayed in the AWS Device Farm console after the associated app is uploaded.



Type: String


Required: Noname

The upload's file name.

Type: String


Required: Nostatus

The upload's status.

Must be one of the following values:• FAILED• INITIALIZED• PROCESSING• SUCCEEDED

Type: String

Valid Values: INITIALIZED | PROCESSING | SUCCEEDED | FAILED

Required: Notype

The upload's type.

Must be one of the following values:• ANDROID_APP• IOS_APP• WEB_APP• EXTERNAL_DATA• APPIUM_JAVA_JUNIT_TEST_PACKAGE• APPIUM_JAVA_TESTNG_TEST_PACKAGE• APPIUM_PYTHON_TEST_PACKAGE• APPIUM_NODE_TEST_PACKAGE• APPIUM_RUBY_TEST_PACKAGE• APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE• APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE• APPIUM_WEB_PYTHON_TEST_PACKAGE• APPIUM_WEB_NODE_TEST_PACKAGE• APPIUM_WEB_RUBY_TEST_PACKAGE• CALABASH_TEST_PACKAGE• INSTRUMENTATION_TEST_PACKAGE• UIAUTOMATION_TEST_PACKAGE• UIAUTOMATOR_TEST_PACKAGE• XCTEST_TEST_PACKAGE



• XCTEST_UI_TEST_PACKAGE• APPIUM_JAVA_JUNIT_TEST_SPEC• APPIUM_JAVA_TESTNG_TEST_SPEC• APPIUM_PYTHON_TEST_SPEC• APPIUM_NODE_TEST_SPEC• APPIUM_RUBY_TEST_SPEC• APPIUM_WEB_JAVA_JUNIT_TEST_SPEC• APPIUM_WEB_JAVA_TESTNG_TEST_SPEC• APPIUM_WEB_PYTHON_TEST_SPEC• APPIUM_WEB_NODE_TEST_SPEC• APPIUM_WEB_RUBY_TEST_SPEC• INSTRUMENTATION_TEST_SPEC• XCTEST_UI_TEST_SPEC

Type: String

Valid Values: ANDROID_APP | IOS_APP | WEB_APP | EXTERNAL_DATA |APPIUM_JAVA_JUNIT_TEST_PACKAGE | APPIUM_JAVA_TESTNG_TEST_PACKAGE| APPIUM_PYTHON_TEST_PACKAGE | APPIUM_NODE_TEST_PACKAGE |APPIUM_RUBY_TEST_PACKAGE | APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE |APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE | APPIUM_WEB_PYTHON_TEST_PACKAGE| APPIUM_WEB_NODE_TEST_PACKAGE | APPIUM_WEB_RUBY_TEST_PACKAGE| CALABASH_TEST_PACKAGE | INSTRUMENTATION_TEST_PACKAGE |UIAUTOMATION_TEST_PACKAGE | UIAUTOMATOR_TEST_PACKAGE |XCTEST_TEST_PACKAGE | XCTEST_UI_TEST_PACKAGE | APPIUM_JAVA_JUNIT_TEST_SPEC| APPIUM_JAVA_TESTNG_TEST_SPEC | APPIUM_PYTHON_TEST_SPEC| APPIUM_NODE_TEST_SPEC | APPIUM_RUBY_TEST_SPEC |APPIUM_WEB_JAVA_JUNIT_TEST_SPEC | APPIUM_WEB_JAVA_TESTNG_TEST_SPEC| APPIUM_WEB_PYTHON_TEST_SPEC | APPIUM_WEB_NODE_TEST_SPEC |APPIUM_WEB_RUBY_TEST_SPEC | INSTRUMENTATION_TEST_SPEC | XCTEST_UI_TEST_SPEC

Required: Nourl

The presigned Amazon S3 URL that was used to store a file using a PUT request.

Type: String


Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/Upload

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/Upload

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/Upload

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/Upload

AWS Device Farm API ReferenceVPCEConfiguration

VPCEConfigurationRepresents an Amazon Virtual Private Cloud (VPC) endpoint configuration.

Contentsarn

The Amazon Resource Name (ARN) of the VPC endpoint configuration.

Type: String


Pattern: ârn:.+

Required: NoserviceDnsName

The DNS name that maps to the private IP address of the service you want to access.

Type: String


Required: NovpceConfigurationDescription


Type: String


Required: NovpceConfigurationName

The friendly name you give to your VPC endpoint configuration to manage your configurations moreeasily.

Type: String


Required: NovpceServiceName


Type: String


Required: No






https://docs.aws.amazon.com/goto/SdkForCpp/devicefarm-2015-06-23/VPCEConfiguration

https://docs.aws.amazon.com/goto/SdkForGoV1/devicefarm-2015-06-23/VPCEConfiguration

https://docs.aws.amazon.com/goto/SdkForJava/devicefarm-2015-06-23/VPCEConfiguration

https://docs.aws.amazon.com/goto/SdkForRubyV3/devicefarm-2015-06-23/VPCEConfiguration


Common ParametersThe following list contains the parameters that all actions use for signing Signature Version 4 requestswith a query string. Any action-specific parameters are listed in the topic for that action. For moreinformation about Signature Version 4, see Signature Version 4 Signing Process in the Amazon WebServices General Reference.

Action

The action to be performed.

Type: string

Required: YesVersion

The API version that the request is written for, expressed in the format YYYY-MM-DD.

Type: string

Required: YesX-Amz-Algorithm

The hash algorithm that you used to create the request signature.

Condition: Specify this parameter when you include authentication information in a query stringinstead of in the HTTP authorization header.

Type: string

Valid Values: AWS4-HMAC-SHA256

Required: ConditionalX-Amz-Credential

The credential scope value, which is a string that includes your access key, the date, the region youare targeting, the service you are requesting, and a termination string ("aws4_request"). The value isexpressed in the following format: access_key/YYYYMMDD/region/service/aws4_request.

For more information, see Task 2: Create a String to Sign for Signature Version 4 in the Amazon WebServices General Reference.


Type: string

Required: ConditionalX-Amz-Date

The date that is used to create the signature. The format must be ISO 8601 basic format(YYYYMMDD'T'HHMMSS'Z'). For example, the following date time is a valid X-Amz-Date value:20120325T120000Z.

Condition: X-Amz-Date is optional for all requests; it can be used to override the date used forsigning requests. If the Date header is specified in the ISO 8601 basic format, X-Amz-Date is


http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html

http://docs.aws.amazon.com/general/latest/gr/sigv4-create-string-to-sign.html


not required. When X-Amz-Date is used, it always overrides the value of the Date header. Formore information, see Handling Dates in Signature Version 4 in the Amazon Web Services GeneralReference.

Type: string

Required: ConditionalX-Amz-Security-Token

The temporary security token that was obtained through a call to AWS Security Token Service (AWSSTS). For a list of services that support temporary security credentials from AWS Security TokenService, go to AWS Services That Work with IAM in the IAM User Guide.

Condition: If you're using temporary security credentials from the AWS Security Token Service, youmust include the security token.

Type: string

Required: ConditionalX-Amz-Signature

Specifies the hex-encoded signature that was calculated from the string to sign and the derivedsigning key.


Type: string

Required: ConditionalX-Amz-SignedHeaders

Specifies all the HTTP headers that were included as part of the canonical request. For moreinformation about specifying signed headers, see Task 1: Create a Canonical Request For SignatureVersion 4 in the Amazon Web Services General Reference.


Type: string

Required: Conditional


http://docs.aws.amazon.com/general/latest/gr/sigv4-date-handling.html

http://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-services-that-work-with-iam.html

http://docs.aws.amazon.com/general/latest/gr/sigv4-create-canonical-request.html

http://docs.aws.amazon.com/general/latest/gr/sigv4-create-canonical-request.html


Common ErrorsThis section lists the errors common to the API actions of all AWS services. For errors specific to an APIaction for this service, see the topic for that API action.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 400IncompleteSignature

The request signature does not conform to AWS standards.

HTTP Status Code: 400InternalFailure

The request processing has failed because of an unknown error, exception or failure.

HTTP Status Code: 500InvalidAction

The action or operation requested is invalid. Verify that the action is typed correctly.

HTTP Status Code: 400InvalidClientTokenId

The X.509 certificate or AWS access key ID provided does not exist in our records.

HTTP Status Code: 403InvalidParameterCombination

Parameters that must not be used together were used together.

HTTP Status Code: 400InvalidParameterValue

An invalid or out-of-range value was supplied for the input parameter.

HTTP Status Code: 400InvalidQueryParameter

The AWS query string is malformed or does not adhere to AWS standards.

HTTP Status Code: 400MalformedQueryString

The query string contains a syntax error.

HTTP Status Code: 404MissingAction

The request is missing an action or a required parameter.




MissingAuthenticationToken

The request must contain either a valid (registered) AWS access key ID or X.509 certificate.

HTTP Status Code: 403MissingParameter

A required parameter for the specified action is not supplied.

HTTP Status Code: 400OptInRequired

The AWS access key ID needs a subscription for the service.

HTTP Status Code: 403RequestExpired

The request reached the service more than 15 minutes after the date stamp on the request or morethan 15 minutes after the request expiration date (such as for pre-signed URLs), or the date stampon the request is more than 15 minutes in the future.

HTTP Status Code: 400ServiceUnavailable

The request has failed due to a temporary failure of the server.

HTTP Status Code: 503ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 400ValidationError

The input fails to satisfy the constraints specified by an AWS service.



Documents

AWS Device Farm · 2020-02-05 · AWS Device Farm API Reference Table of Contents Welcome..... 1 Actions..... 2