diff --git a/.changes/3.82.6 b/.changes/3.82.6 new file mode 100644 index 0000000000..9726851c8f --- /dev/null +++ b/.changes/3.82.6 @@ -0,0 +1,12 @@ +[ + { + "type": "api-change", + "category": "DeviceFarm", + "description": "\"This release provides support for running Appium Node.js and Appium Ruby tests on AWS Device Farm." + }, + { + "type": "enhancement", + "category": "ECS", + "description": "Documentation updates for Amazon ECS tagging feature." + } +] \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md index b398cdf086..0454f8e2e7 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,10 @@ # CHANGELOG +## next release + +* `Aws\DeviceFarm` - "This release provides support for running Appium Node.js and Appium Ruby tests on AWS Device Farm. +* `Aws\ECS` - Documentation updates for Amazon ECS tagging feature. + ## 3.82.5 - 2019-01-03 * `Aws\IoTAnalytics` - ListDatasetContents now has a filter to limit results by date scheduled. diff --git a/src/data/devicefarm/2015-06-23/api-2.json b/src/data/devicefarm/2015-06-23/api-2.json index 89268f95ba..8fa08d8fce 100644 --- a/src/data/devicefarm/2015-06-23/api-2.json +++ b/src/data/devicefarm/2015-06-23/api-2.json @@ -2777,9 +2777,13 @@ "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", @@ -2988,9 +2992,13 @@ "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", @@ -3000,9 +3008,13 @@ "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" ] diff --git a/src/data/devicefarm/2015-06-23/api-2.json.php b/src/data/devicefarm/2015-06-23/api-2.json.php index 80249fb177..be34085e13 100644 --- a/src/data/devicefarm/2015-06-23/api-2.json.php +++ b/src/data/devicefarm/2015-06-23/api-2.json.php @@ -1,3 +1,3 @@ '2.0', 'metadata' => [ 'apiVersion' => '2015-06-23', 'endpointPrefix' => 'devicefarm', 'jsonVersion' => '1.1', 'protocol' => 'json', 'serviceFullName' => 'AWS Device Farm', 'serviceId' => 'Device Farm', 'signatureVersion' => 'v4', 'targetPrefix' => 'DeviceFarm_20150623', 'uid' => 'devicefarm-2015-06-23', ], 'operations' => [ 'CreateDevicePool' => [ 'name' => 'CreateDevicePool', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDevicePoolRequest', ], 'output' => [ 'shape' => 'CreateDevicePoolResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'CreateInstanceProfile' => [ 'name' => 'CreateInstanceProfile', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateInstanceProfileRequest', ], 'output' => [ 'shape' => 'CreateInstanceProfileResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'CreateNetworkProfile' => [ 'name' => 'CreateNetworkProfile', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateNetworkProfileRequest', ], 'output' => [ 'shape' => 'CreateNetworkProfileResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'CreateProject' => [ 'name' => 'CreateProject', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateProjectRequest', ], 'output' => [ 'shape' => 'CreateProjectResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'CreateRemoteAccessSession' => [ 'name' => 'CreateRemoteAccessSession', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateRemoteAccessSessionRequest', ], 'output' => [ 'shape' => 'CreateRemoteAccessSessionResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'CreateUpload' => [ 'name' => 'CreateUpload', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateUploadRequest', ], 'output' => [ 'shape' => 'CreateUploadResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'CreateVPCEConfiguration' => [ 'name' => 'CreateVPCEConfiguration', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateVPCEConfigurationRequest', ], 'output' => [ 'shape' => 'CreateVPCEConfigurationResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'DeleteDevicePool' => [ 'name' => 'DeleteDevicePool', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteDevicePoolRequest', ], 'output' => [ 'shape' => 'DeleteDevicePoolResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'DeleteInstanceProfile' => [ 'name' => 'DeleteInstanceProfile', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteInstanceProfileRequest', ], 'output' => [ 'shape' => 'DeleteInstanceProfileResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'DeleteNetworkProfile' => [ 'name' => 'DeleteNetworkProfile', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteNetworkProfileRequest', ], 'output' => [ 'shape' => 'DeleteNetworkProfileResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'DeleteProject' => [ 'name' => 'DeleteProject', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteProjectRequest', ], 'output' => [ 'shape' => 'DeleteProjectResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'DeleteRemoteAccessSession' => [ 'name' => 'DeleteRemoteAccessSession', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteRemoteAccessSessionRequest', ], 'output' => [ 'shape' => 'DeleteRemoteAccessSessionResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'DeleteRun' => [ 'name' => 'DeleteRun', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteRunRequest', ], 'output' => [ 'shape' => 'DeleteRunResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'DeleteUpload' => [ 'name' => 'DeleteUpload', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteUploadRequest', ], 'output' => [ 'shape' => 'DeleteUploadResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'DeleteVPCEConfiguration' => [ 'name' => 'DeleteVPCEConfiguration', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteVPCEConfigurationRequest', ], 'output' => [ 'shape' => 'DeleteVPCEConfigurationResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ServiceAccountException', ], [ 'shape' => 'InvalidOperationException', ], ], ], 'GetAccountSettings' => [ 'name' => 'GetAccountSettings', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetAccountSettingsRequest', ], 'output' => [ 'shape' => 'GetAccountSettingsResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'GetDevice' => [ 'name' => 'GetDevice', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetDeviceRequest', ], 'output' => [ 'shape' => 'GetDeviceResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'GetDeviceInstance' => [ 'name' => 'GetDeviceInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetDeviceInstanceRequest', ], 'output' => [ 'shape' => 'GetDeviceInstanceResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'GetDevicePool' => [ 'name' => 'GetDevicePool', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetDevicePoolRequest', ], 'output' => [ 'shape' => 'GetDevicePoolResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'GetDevicePoolCompatibility' => [ 'name' => 'GetDevicePoolCompatibility', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetDevicePoolCompatibilityRequest', ], 'output' => [ 'shape' => 'GetDevicePoolCompatibilityResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'GetInstanceProfile' => [ 'name' => 'GetInstanceProfile', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetInstanceProfileRequest', ], 'output' => [ 'shape' => 'GetInstanceProfileResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'GetJob' => [ 'name' => 'GetJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetJobRequest', ], 'output' => [ 'shape' => 'GetJobResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'GetNetworkProfile' => [ 'name' => 'GetNetworkProfile', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetNetworkProfileRequest', ], 'output' => [ 'shape' => 'GetNetworkProfileResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'GetOfferingStatus' => [ 'name' => 'GetOfferingStatus', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetOfferingStatusRequest', ], 'output' => [ 'shape' => 'GetOfferingStatusResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'NotEligibleException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'GetProject' => [ 'name' => 'GetProject', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetProjectRequest', ], 'output' => [ 'shape' => 'GetProjectResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'GetRemoteAccessSession' => [ 'name' => 'GetRemoteAccessSession', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetRemoteAccessSessionRequest', ], 'output' => [ 'shape' => 'GetRemoteAccessSessionResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'GetRun' => [ 'name' => 'GetRun', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetRunRequest', ], 'output' => [ 'shape' => 'GetRunResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'GetSuite' => [ 'name' => 'GetSuite', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetSuiteRequest', ], 'output' => [ 'shape' => 'GetSuiteResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'GetTest' => [ 'name' => 'GetTest', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetTestRequest', ], 'output' => [ 'shape' => 'GetTestResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'GetUpload' => [ 'name' => 'GetUpload', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetUploadRequest', ], 'output' => [ 'shape' => 'GetUploadResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'GetVPCEConfiguration' => [ 'name' => 'GetVPCEConfiguration', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetVPCEConfigurationRequest', ], 'output' => [ 'shape' => 'GetVPCEConfigurationResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'InstallToRemoteAccessSession' => [ 'name' => 'InstallToRemoteAccessSession', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'InstallToRemoteAccessSessionRequest', ], 'output' => [ 'shape' => 'InstallToRemoteAccessSessionResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'ListArtifacts' => [ 'name' => 'ListArtifacts', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListArtifactsRequest', ], 'output' => [ 'shape' => 'ListArtifactsResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'ListDeviceInstances' => [ 'name' => 'ListDeviceInstances', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListDeviceInstancesRequest', ], 'output' => [ 'shape' => 'ListDeviceInstancesResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'ListDevicePools' => [ 'name' => 'ListDevicePools', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListDevicePoolsRequest', ], 'output' => [ 'shape' => 'ListDevicePoolsResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'ListDevices' => [ 'name' => 'ListDevices', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListDevicesRequest', ], 'output' => [ 'shape' => 'ListDevicesResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'ListInstanceProfiles' => [ 'name' => 'ListInstanceProfiles', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListInstanceProfilesRequest', ], 'output' => [ 'shape' => 'ListInstanceProfilesResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'ListJobs' => [ 'name' => 'ListJobs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListJobsRequest', ], 'output' => [ 'shape' => 'ListJobsResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'ListNetworkProfiles' => [ 'name' => 'ListNetworkProfiles', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListNetworkProfilesRequest', ], 'output' => [ 'shape' => 'ListNetworkProfilesResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'ListOfferingPromotions' => [ 'name' => 'ListOfferingPromotions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListOfferingPromotionsRequest', ], 'output' => [ 'shape' => 'ListOfferingPromotionsResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'NotEligibleException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'ListOfferingTransactions' => [ 'name' => 'ListOfferingTransactions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListOfferingTransactionsRequest', ], 'output' => [ 'shape' => 'ListOfferingTransactionsResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'NotEligibleException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'ListOfferings' => [ 'name' => 'ListOfferings', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListOfferingsRequest', ], 'output' => [ 'shape' => 'ListOfferingsResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'NotEligibleException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'ListProjects' => [ 'name' => 'ListProjects', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListProjectsRequest', ], 'output' => [ 'shape' => 'ListProjectsResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'ListRemoteAccessSessions' => [ 'name' => 'ListRemoteAccessSessions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListRemoteAccessSessionsRequest', ], 'output' => [ 'shape' => 'ListRemoteAccessSessionsResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'ListRuns' => [ 'name' => 'ListRuns', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListRunsRequest', ], 'output' => [ 'shape' => 'ListRunsResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'ListSamples' => [ 'name' => 'ListSamples', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListSamplesRequest', ], 'output' => [ 'shape' => 'ListSamplesResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'ListSuites' => [ 'name' => 'ListSuites', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListSuitesRequest', ], 'output' => [ 'shape' => 'ListSuitesResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'ListTests' => [ 'name' => 'ListTests', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListTestsRequest', ], 'output' => [ 'shape' => 'ListTestsResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'ListUniqueProblems' => [ 'name' => 'ListUniqueProblems', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListUniqueProblemsRequest', ], 'output' => [ 'shape' => 'ListUniqueProblemsResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'ListUploads' => [ 'name' => 'ListUploads', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListUploadsRequest', ], 'output' => [ 'shape' => 'ListUploadsResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'ListVPCEConfigurations' => [ 'name' => 'ListVPCEConfigurations', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListVPCEConfigurationsRequest', ], 'output' => [ 'shape' => 'ListVPCEConfigurationsResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'PurchaseOffering' => [ 'name' => 'PurchaseOffering', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PurchaseOfferingRequest', ], 'output' => [ 'shape' => 'PurchaseOfferingResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'NotEligibleException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'RenewOffering' => [ 'name' => 'RenewOffering', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RenewOfferingRequest', ], 'output' => [ 'shape' => 'RenewOfferingResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'NotEligibleException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'ScheduleRun' => [ 'name' => 'ScheduleRun', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ScheduleRunRequest', ], 'output' => [ 'shape' => 'ScheduleRunResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'IdempotencyException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'StopJob' => [ 'name' => 'StopJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopJobRequest', ], 'output' => [ 'shape' => 'StopJobResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'StopRemoteAccessSession' => [ 'name' => 'StopRemoteAccessSession', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopRemoteAccessSessionRequest', ], 'output' => [ 'shape' => 'StopRemoteAccessSessionResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'StopRun' => [ 'name' => 'StopRun', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopRunRequest', ], 'output' => [ 'shape' => 'StopRunResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'UpdateDeviceInstance' => [ 'name' => 'UpdateDeviceInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateDeviceInstanceRequest', ], 'output' => [ 'shape' => 'UpdateDeviceInstanceResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'UpdateDevicePool' => [ 'name' => 'UpdateDevicePool', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateDevicePoolRequest', ], 'output' => [ 'shape' => 'UpdateDevicePoolResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'UpdateInstanceProfile' => [ 'name' => 'UpdateInstanceProfile', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateInstanceProfileRequest', ], 'output' => [ 'shape' => 'UpdateInstanceProfileResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'UpdateNetworkProfile' => [ 'name' => 'UpdateNetworkProfile', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateNetworkProfileRequest', ], 'output' => [ 'shape' => 'UpdateNetworkProfileResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'UpdateProject' => [ 'name' => 'UpdateProject', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateProjectRequest', ], 'output' => [ 'shape' => 'UpdateProjectResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'UpdateUpload' => [ 'name' => 'UpdateUpload', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateUploadRequest', ], 'output' => [ 'shape' => 'UpdateUploadResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'UpdateVPCEConfiguration' => [ 'name' => 'UpdateVPCEConfiguration', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateVPCEConfigurationRequest', ], 'output' => [ 'shape' => 'UpdateVPCEConfigurationResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ServiceAccountException', ], [ 'shape' => 'InvalidOperationException', ], ], ], ], 'shapes' => [ 'AWSAccountNumber' => [ 'type' => 'string', 'max' => 16, 'min' => 2, ], 'AccountSettings' => [ 'type' => 'structure', 'members' => [ 'awsAccountNumber' => [ 'shape' => 'AWSAccountNumber', ], 'unmeteredDevices' => [ 'shape' => 'PurchasedDevicesMap', ], 'unmeteredRemoteAccessDevices' => [ 'shape' => 'PurchasedDevicesMap', ], 'maxJobTimeoutMinutes' => [ 'shape' => 'JobTimeoutMinutes', ], 'trialMinutes' => [ 'shape' => 'TrialMinutes', ], 'maxSlots' => [ 'shape' => 'MaxSlotMap', ], 'defaultJobTimeoutMinutes' => [ 'shape' => 'JobTimeoutMinutes', ], 'skipAppResign' => [ 'shape' => 'SkipAppResign', ], ], ], 'AccountsCleanup' => [ 'type' => 'boolean', ], 'AmazonResourceName' => [ 'type' => 'string', 'min' => 32, ], 'AmazonResourceNames' => [ 'type' => 'list', 'member' => [ 'shape' => 'AmazonResourceName', ], ], 'AndroidPaths' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'AppPackagesCleanup' => [ 'type' => 'boolean', ], 'ArgumentException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'Message', ], ], 'exception' => true, ], 'Artifact' => [ 'type' => 'structure', 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], 'name' => [ 'shape' => 'Name', ], 'type' => [ 'shape' => 'ArtifactType', ], 'extension' => [ 'shape' => 'String', ], 'url' => [ 'shape' => 'URL', ], ], ], 'ArtifactCategory' => [ 'type' => 'string', 'enum' => [ 'SCREENSHOT', 'FILE', 'LOG', ], ], 'ArtifactType' => [ 'type' => 'string', 'enum' => [ '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', ], ], 'Artifacts' => [ 'type' => 'list', 'member' => [ 'shape' => 'Artifact', ], ], 'BillingMethod' => [ 'type' => 'string', 'enum' => [ 'METERED', 'UNMETERED', ], ], 'Boolean' => [ 'type' => 'boolean', ], 'CPU' => [ 'type' => 'structure', 'members' => [ 'frequency' => [ 'shape' => 'String', ], 'architecture' => [ 'shape' => 'String', ], 'clock' => [ 'shape' => 'Double', ], ], ], 'ClientId' => [ 'type' => 'string', 'max' => 64, 'min' => 0, ], 'ContentType' => [ 'type' => 'string', 'max' => 64, 'min' => 0, ], 'Counters' => [ 'type' => 'structure', 'members' => [ 'total' => [ 'shape' => 'Integer', ], 'passed' => [ 'shape' => 'Integer', ], 'failed' => [ 'shape' => 'Integer', ], 'warned' => [ 'shape' => 'Integer', ], 'errored' => [ 'shape' => 'Integer', ], 'stopped' => [ 'shape' => 'Integer', ], 'skipped' => [ 'shape' => 'Integer', ], ], ], 'CreateDevicePoolRequest' => [ 'type' => 'structure', 'required' => [ 'projectArn', 'name', 'rules', ], 'members' => [ 'projectArn' => [ 'shape' => 'AmazonResourceName', ], 'name' => [ 'shape' => 'Name', ], 'description' => [ 'shape' => 'Message', ], 'rules' => [ 'shape' => 'Rules', ], ], ], 'CreateDevicePoolResult' => [ 'type' => 'structure', 'members' => [ 'devicePool' => [ 'shape' => 'DevicePool', ], ], ], 'CreateInstanceProfileRequest' => [ 'type' => 'structure', 'required' => [ 'name', ], 'members' => [ 'name' => [ 'shape' => 'Name', ], 'description' => [ 'shape' => 'Message', ], 'packageCleanup' => [ 'shape' => 'Boolean', ], 'excludeAppPackagesFromCleanup' => [ 'shape' => 'PackageIds', ], 'rebootAfterUse' => [ 'shape' => 'Boolean', ], ], ], 'CreateInstanceProfileResult' => [ 'type' => 'structure', 'members' => [ 'instanceProfile' => [ 'shape' => 'InstanceProfile', ], ], ], 'CreateNetworkProfileRequest' => [ 'type' => 'structure', 'required' => [ 'projectArn', 'name', ], 'members' => [ 'projectArn' => [ 'shape' => 'AmazonResourceName', ], 'name' => [ 'shape' => 'Name', ], 'description' => [ 'shape' => 'Message', ], 'type' => [ 'shape' => 'NetworkProfileType', ], 'uplinkBandwidthBits' => [ 'shape' => 'Long', ], 'downlinkBandwidthBits' => [ 'shape' => 'Long', ], 'uplinkDelayMs' => [ 'shape' => 'Long', ], 'downlinkDelayMs' => [ 'shape' => 'Long', ], 'uplinkJitterMs' => [ 'shape' => 'Long', ], 'downlinkJitterMs' => [ 'shape' => 'Long', ], 'uplinkLossPercent' => [ 'shape' => 'PercentInteger', ], 'downlinkLossPercent' => [ 'shape' => 'PercentInteger', ], ], ], 'CreateNetworkProfileResult' => [ 'type' => 'structure', 'members' => [ 'networkProfile' => [ 'shape' => 'NetworkProfile', ], ], ], 'CreateProjectRequest' => [ 'type' => 'structure', 'required' => [ 'name', ], 'members' => [ 'name' => [ 'shape' => 'Name', ], 'defaultJobTimeoutMinutes' => [ 'shape' => 'JobTimeoutMinutes', ], ], ], 'CreateProjectResult' => [ 'type' => 'structure', 'members' => [ 'project' => [ 'shape' => 'Project', ], ], ], 'CreateRemoteAccessSessionConfiguration' => [ 'type' => 'structure', 'members' => [ 'billingMethod' => [ 'shape' => 'BillingMethod', ], 'vpceConfigurationArns' => [ 'shape' => 'AmazonResourceNames', ], ], ], 'CreateRemoteAccessSessionRequest' => [ 'type' => 'structure', 'required' => [ 'projectArn', 'deviceArn', ], 'members' => [ 'projectArn' => [ 'shape' => 'AmazonResourceName', ], 'deviceArn' => [ 'shape' => 'AmazonResourceName', ], 'instanceArn' => [ 'shape' => 'AmazonResourceName', ], 'sshPublicKey' => [ 'shape' => 'SshPublicKey', ], 'remoteDebugEnabled' => [ 'shape' => 'Boolean', ], 'remoteRecordEnabled' => [ 'shape' => 'Boolean', ], 'remoteRecordAppArn' => [ 'shape' => 'AmazonResourceName', ], 'name' => [ 'shape' => 'Name', ], 'clientId' => [ 'shape' => 'ClientId', ], 'configuration' => [ 'shape' => 'CreateRemoteAccessSessionConfiguration', ], 'interactionMode' => [ 'shape' => 'InteractionMode', ], 'skipAppResign' => [ 'shape' => 'Boolean', ], ], ], 'CreateRemoteAccessSessionResult' => [ 'type' => 'structure', 'members' => [ 'remoteAccessSession' => [ 'shape' => 'RemoteAccessSession', ], ], ], 'CreateUploadRequest' => [ 'type' => 'structure', 'required' => [ 'projectArn', 'name', 'type', ], 'members' => [ 'projectArn' => [ 'shape' => 'AmazonResourceName', ], 'name' => [ 'shape' => 'Name', ], 'type' => [ 'shape' => 'UploadType', ], 'contentType' => [ 'shape' => 'ContentType', ], ], ], 'CreateUploadResult' => [ 'type' => 'structure', 'members' => [ 'upload' => [ 'shape' => 'Upload', ], ], ], 'CreateVPCEConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'vpceConfigurationName', 'vpceServiceName', 'serviceDnsName', ], 'members' => [ 'vpceConfigurationName' => [ 'shape' => 'VPCEConfigurationName', ], 'vpceServiceName' => [ 'shape' => 'VPCEServiceName', ], 'serviceDnsName' => [ 'shape' => 'ServiceDnsName', ], 'vpceConfigurationDescription' => [ 'shape' => 'VPCEConfigurationDescription', ], ], ], 'CreateVPCEConfigurationResult' => [ 'type' => 'structure', 'members' => [ 'vpceConfiguration' => [ 'shape' => 'VPCEConfiguration', ], ], ], 'CurrencyCode' => [ 'type' => 'string', 'enum' => [ 'USD', ], ], 'CustomerArtifactPaths' => [ 'type' => 'structure', 'members' => [ 'iosPaths' => [ 'shape' => 'IosPaths', ], 'androidPaths' => [ 'shape' => 'AndroidPaths', ], 'deviceHostPaths' => [ 'shape' => 'DeviceHostPaths', ], ], ], 'DateTime' => [ 'type' => 'timestamp', ], 'DeleteDevicePoolRequest' => [ 'type' => 'structure', 'required' => [ 'arn', ], 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], ], ], 'DeleteDevicePoolResult' => [ 'type' => 'structure', 'members' => [], ], 'DeleteInstanceProfileRequest' => [ 'type' => 'structure', 'required' => [ 'arn', ], 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], ], ], 'DeleteInstanceProfileResult' => [ 'type' => 'structure', 'members' => [], ], 'DeleteNetworkProfileRequest' => [ 'type' => 'structure', 'required' => [ 'arn', ], 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], ], ], 'DeleteNetworkProfileResult' => [ 'type' => 'structure', 'members' => [], ], 'DeleteProjectRequest' => [ 'type' => 'structure', 'required' => [ 'arn', ], 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], ], ], 'DeleteProjectResult' => [ 'type' => 'structure', 'members' => [], ], 'DeleteRemoteAccessSessionRequest' => [ 'type' => 'structure', 'required' => [ 'arn', ], 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], ], ], 'DeleteRemoteAccessSessionResult' => [ 'type' => 'structure', 'members' => [], ], 'DeleteRunRequest' => [ 'type' => 'structure', 'required' => [ 'arn', ], 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], ], ], 'DeleteRunResult' => [ 'type' => 'structure', 'members' => [], ], 'DeleteUploadRequest' => [ 'type' => 'structure', 'required' => [ 'arn', ], 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], ], ], 'DeleteUploadResult' => [ 'type' => 'structure', 'members' => [], ], 'DeleteVPCEConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'arn', ], 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], ], ], 'DeleteVPCEConfigurationResult' => [ 'type' => 'structure', 'members' => [], ], 'Device' => [ 'type' => 'structure', 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], 'name' => [ 'shape' => 'Name', ], 'manufacturer' => [ 'shape' => 'String', ], 'model' => [ 'shape' => 'String', ], 'modelId' => [ 'shape' => 'String', ], 'formFactor' => [ 'shape' => 'DeviceFormFactor', ], 'platform' => [ 'shape' => 'DevicePlatform', ], 'os' => [ 'shape' => 'String', ], 'cpu' => [ 'shape' => 'CPU', ], 'resolution' => [ 'shape' => 'Resolution', ], 'heapSize' => [ 'shape' => 'Long', ], 'memory' => [ 'shape' => 'Long', ], 'image' => [ 'shape' => 'String', ], 'carrier' => [ 'shape' => 'String', ], 'radio' => [ 'shape' => 'String', ], 'remoteAccessEnabled' => [ 'shape' => 'Boolean', ], 'remoteDebugEnabled' => [ 'shape' => 'Boolean', ], 'fleetType' => [ 'shape' => 'String', ], 'fleetName' => [ 'shape' => 'String', ], 'instances' => [ 'shape' => 'DeviceInstances', ], 'availability' => [ 'shape' => 'DeviceAvailability', ], ], ], 'DeviceAttribute' => [ 'type' => 'string', 'enum' => [ 'ARN', 'PLATFORM', 'FORM_FACTOR', 'MANUFACTURER', 'REMOTE_ACCESS_ENABLED', 'REMOTE_DEBUG_ENABLED', 'APPIUM_VERSION', 'INSTANCE_ARN', 'INSTANCE_LABELS', 'FLEET_TYPE', ], ], 'DeviceAvailability' => [ 'type' => 'string', 'enum' => [ 'TEMPORARY_NOT_AVAILABLE', 'BUSY', 'AVAILABLE', 'HIGHLY_AVAILABLE', ], ], 'DeviceFilter' => [ 'type' => 'structure', 'members' => [ 'attribute' => [ 'shape' => 'DeviceFilterAttribute', ], 'operator' => [ 'shape' => 'DeviceFilterOperator', ], 'values' => [ 'shape' => 'DeviceFilterValues', ], ], ], 'DeviceFilterAttribute' => [ 'type' => 'string', 'enum' => [ 'ARN', 'PLATFORM', 'OS_VERSION', 'MODEL', 'AVAILABILITY', 'FORM_FACTOR', 'MANUFACTURER', 'REMOTE_ACCESS_ENABLED', 'REMOTE_DEBUG_ENABLED', 'INSTANCE_ARN', 'INSTANCE_LABELS', 'FLEET_TYPE', ], ], 'DeviceFilterOperator' => [ 'type' => 'string', 'enum' => [ 'EQUALS', 'LESS_THAN', 'LESS_THAN_OR_EQUALS', 'GREATER_THAN', 'GREATER_THAN_OR_EQUALS', 'IN', 'NOT_IN', 'CONTAINS', ], ], 'DeviceFilterValues' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'DeviceFilters' => [ 'type' => 'list', 'member' => [ 'shape' => 'DeviceFilter', ], ], 'DeviceFormFactor' => [ 'type' => 'string', 'enum' => [ 'PHONE', 'TABLET', ], ], 'DeviceHostPaths' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'DeviceInstance' => [ 'type' => 'structure', 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], 'deviceArn' => [ 'shape' => 'AmazonResourceName', ], 'labels' => [ 'shape' => 'InstanceLabels', ], 'status' => [ 'shape' => 'InstanceStatus', ], 'udid' => [ 'shape' => 'String', ], 'instanceProfile' => [ 'shape' => 'InstanceProfile', ], ], ], 'DeviceInstances' => [ 'type' => 'list', 'member' => [ 'shape' => 'DeviceInstance', ], ], 'DeviceMinutes' => [ 'type' => 'structure', 'members' => [ 'total' => [ 'shape' => 'Double', ], 'metered' => [ 'shape' => 'Double', ], 'unmetered' => [ 'shape' => 'Double', ], ], ], 'DevicePlatform' => [ 'type' => 'string', 'enum' => [ 'ANDROID', 'IOS', ], ], 'DevicePool' => [ 'type' => 'structure', 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], 'name' => [ 'shape' => 'Name', ], 'description' => [ 'shape' => 'Message', ], 'type' => [ 'shape' => 'DevicePoolType', ], 'rules' => [ 'shape' => 'Rules', ], ], ], 'DevicePoolCompatibilityResult' => [ 'type' => 'structure', 'members' => [ 'device' => [ 'shape' => 'Device', ], 'compatible' => [ 'shape' => 'Boolean', ], 'incompatibilityMessages' => [ 'shape' => 'IncompatibilityMessages', ], ], ], 'DevicePoolCompatibilityResults' => [ 'type' => 'list', 'member' => [ 'shape' => 'DevicePoolCompatibilityResult', ], ], 'DevicePoolType' => [ 'type' => 'string', 'enum' => [ 'CURATED', 'PRIVATE', ], ], 'DevicePools' => [ 'type' => 'list', 'member' => [ 'shape' => 'DevicePool', ], ], 'DeviceSelectionConfiguration' => [ 'type' => 'structure', 'required' => [ 'filters', 'maxDevices', ], 'members' => [ 'filters' => [ 'shape' => 'DeviceFilters', ], 'maxDevices' => [ 'shape' => 'Integer', ], ], ], 'DeviceSelectionResult' => [ 'type' => 'structure', 'members' => [ 'filters' => [ 'shape' => 'DeviceFilters', ], 'matchedDevicesCount' => [ 'shape' => 'Integer', ], 'maxDevices' => [ 'shape' => 'Integer', ], ], ], 'Devices' => [ 'type' => 'list', 'member' => [ 'shape' => 'Device', ], ], 'Double' => [ 'type' => 'double', ], 'ExecutionConfiguration' => [ 'type' => 'structure', 'members' => [ 'jobTimeoutMinutes' => [ 'shape' => 'JobTimeoutMinutes', ], 'accountsCleanup' => [ 'shape' => 'AccountsCleanup', ], 'appPackagesCleanup' => [ 'shape' => 'AppPackagesCleanup', ], 'videoCapture' => [ 'shape' => 'VideoCapture', ], 'skipAppResign' => [ 'shape' => 'SkipAppResign', ], ], ], 'ExecutionResult' => [ 'type' => 'string', 'enum' => [ 'PENDING', 'PASSED', 'WARNED', 'FAILED', 'SKIPPED', 'ERRORED', 'STOPPED', ], ], 'ExecutionResultCode' => [ 'type' => 'string', 'enum' => [ 'PARSING_FAILED', 'VPC_ENDPOINT_SETUP_FAILED', ], ], 'ExecutionStatus' => [ 'type' => 'string', 'enum' => [ 'PENDING', 'PENDING_CONCURRENCY', 'PENDING_DEVICE', 'PROCESSING', 'SCHEDULING', 'PREPARING', 'RUNNING', 'COMPLETED', 'STOPPING', ], ], 'Filter' => [ 'type' => 'string', 'max' => 8192, 'min' => 0, ], 'GetAccountSettingsRequest' => [ 'type' => 'structure', 'members' => [], ], 'GetAccountSettingsResult' => [ 'type' => 'structure', 'members' => [ 'accountSettings' => [ 'shape' => 'AccountSettings', ], ], ], 'GetDeviceInstanceRequest' => [ 'type' => 'structure', 'required' => [ 'arn', ], 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], ], ], 'GetDeviceInstanceResult' => [ 'type' => 'structure', 'members' => [ 'deviceInstance' => [ 'shape' => 'DeviceInstance', ], ], ], 'GetDevicePoolCompatibilityRequest' => [ 'type' => 'structure', 'required' => [ 'devicePoolArn', ], 'members' => [ 'devicePoolArn' => [ 'shape' => 'AmazonResourceName', ], 'appArn' => [ 'shape' => 'AmazonResourceName', ], 'testType' => [ 'shape' => 'TestType', ], 'test' => [ 'shape' => 'ScheduleRunTest', ], 'configuration' => [ 'shape' => 'ScheduleRunConfiguration', ], ], ], 'GetDevicePoolCompatibilityResult' => [ 'type' => 'structure', 'members' => [ 'compatibleDevices' => [ 'shape' => 'DevicePoolCompatibilityResults', ], 'incompatibleDevices' => [ 'shape' => 'DevicePoolCompatibilityResults', ], ], ], 'GetDevicePoolRequest' => [ 'type' => 'structure', 'required' => [ 'arn', ], 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], ], ], 'GetDevicePoolResult' => [ 'type' => 'structure', 'members' => [ 'devicePool' => [ 'shape' => 'DevicePool', ], ], ], 'GetDeviceRequest' => [ 'type' => 'structure', 'required' => [ 'arn', ], 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], ], ], 'GetDeviceResult' => [ 'type' => 'structure', 'members' => [ 'device' => [ 'shape' => 'Device', ], ], ], 'GetInstanceProfileRequest' => [ 'type' => 'structure', 'required' => [ 'arn', ], 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], ], ], 'GetInstanceProfileResult' => [ 'type' => 'structure', 'members' => [ 'instanceProfile' => [ 'shape' => 'InstanceProfile', ], ], ], 'GetJobRequest' => [ 'type' => 'structure', 'required' => [ 'arn', ], 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], ], ], 'GetJobResult' => [ 'type' => 'structure', 'members' => [ 'job' => [ 'shape' => 'Job', ], ], ], 'GetNetworkProfileRequest' => [ 'type' => 'structure', 'required' => [ 'arn', ], 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], ], ], 'GetNetworkProfileResult' => [ 'type' => 'structure', 'members' => [ 'networkProfile' => [ 'shape' => 'NetworkProfile', ], ], ], 'GetOfferingStatusRequest' => [ 'type' => 'structure', 'members' => [ 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'GetOfferingStatusResult' => [ 'type' => 'structure', 'members' => [ 'current' => [ 'shape' => 'OfferingStatusMap', ], 'nextPeriod' => [ 'shape' => 'OfferingStatusMap', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'GetProjectRequest' => [ 'type' => 'structure', 'required' => [ 'arn', ], 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], ], ], 'GetProjectResult' => [ 'type' => 'structure', 'members' => [ 'project' => [ 'shape' => 'Project', ], ], ], 'GetRemoteAccessSessionRequest' => [ 'type' => 'structure', 'required' => [ 'arn', ], 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], ], ], 'GetRemoteAccessSessionResult' => [ 'type' => 'structure', 'members' => [ 'remoteAccessSession' => [ 'shape' => 'RemoteAccessSession', ], ], ], 'GetRunRequest' => [ 'type' => 'structure', 'required' => [ 'arn', ], 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], ], ], 'GetRunResult' => [ 'type' => 'structure', 'members' => [ 'run' => [ 'shape' => 'Run', ], ], ], 'GetSuiteRequest' => [ 'type' => 'structure', 'required' => [ 'arn', ], 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], ], ], 'GetSuiteResult' => [ 'type' => 'structure', 'members' => [ 'suite' => [ 'shape' => 'Suite', ], ], ], 'GetTestRequest' => [ 'type' => 'structure', 'required' => [ 'arn', ], 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], ], ], 'GetTestResult' => [ 'type' => 'structure', 'members' => [ 'test' => [ 'shape' => 'Test', ], ], ], 'GetUploadRequest' => [ 'type' => 'structure', 'required' => [ 'arn', ], 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], ], ], 'GetUploadResult' => [ 'type' => 'structure', 'members' => [ 'upload' => [ 'shape' => 'Upload', ], ], ], 'GetVPCEConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'arn', ], 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], ], ], 'GetVPCEConfigurationResult' => [ 'type' => 'structure', 'members' => [ 'vpceConfiguration' => [ 'shape' => 'VPCEConfiguration', ], ], ], 'HostAddress' => [ 'type' => 'string', 'max' => 1024, ], 'IdempotencyException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'Message', ], ], 'exception' => true, ], 'IncompatibilityMessage' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'Message', ], 'type' => [ 'shape' => 'DeviceAttribute', ], ], ], 'IncompatibilityMessages' => [ 'type' => 'list', 'member' => [ 'shape' => 'IncompatibilityMessage', ], ], 'InstallToRemoteAccessSessionRequest' => [ 'type' => 'structure', 'required' => [ 'remoteAccessSessionArn', 'appArn', ], 'members' => [ 'remoteAccessSessionArn' => [ 'shape' => 'AmazonResourceName', ], 'appArn' => [ 'shape' => 'AmazonResourceName', ], ], ], 'InstallToRemoteAccessSessionResult' => [ 'type' => 'structure', 'members' => [ 'appUpload' => [ 'shape' => 'Upload', ], ], ], 'InstanceLabels' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'InstanceProfile' => [ 'type' => 'structure', 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], 'packageCleanup' => [ 'shape' => 'Boolean', ], 'excludeAppPackagesFromCleanup' => [ 'shape' => 'PackageIds', ], 'rebootAfterUse' => [ 'shape' => 'Boolean', ], 'name' => [ 'shape' => 'Name', ], 'description' => [ 'shape' => 'Message', ], ], ], 'InstanceProfiles' => [ 'type' => 'list', 'member' => [ 'shape' => 'InstanceProfile', ], ], 'InstanceStatus' => [ 'type' => 'string', 'enum' => [ 'IN_USE', 'PREPARING', 'AVAILABLE', 'NOT_AVAILABLE', ], ], 'Integer' => [ 'type' => 'integer', ], 'InteractionMode' => [ 'type' => 'string', 'enum' => [ 'INTERACTIVE', 'NO_VIDEO', 'VIDEO_ONLY', ], 'max' => 64, 'min' => 0, ], 'InvalidOperationException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'Message', ], ], 'exception' => true, ], 'IosPaths' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'Job' => [ 'type' => 'structure', 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], 'name' => [ 'shape' => 'Name', ], 'type' => [ 'shape' => 'TestType', ], 'created' => [ 'shape' => 'DateTime', ], 'status' => [ 'shape' => 'ExecutionStatus', ], 'result' => [ 'shape' => 'ExecutionResult', ], 'started' => [ 'shape' => 'DateTime', ], 'stopped' => [ 'shape' => 'DateTime', ], 'counters' => [ 'shape' => 'Counters', ], 'message' => [ 'shape' => 'Message', ], 'device' => [ 'shape' => 'Device', ], 'instanceArn' => [ 'shape' => 'AmazonResourceName', ], 'deviceMinutes' => [ 'shape' => 'DeviceMinutes', ], 'videoEndpoint' => [ 'shape' => 'String', ], 'videoCapture' => [ 'shape' => 'VideoCapture', ], ], ], 'JobTimeoutMinutes' => [ 'type' => 'integer', ], 'Jobs' => [ 'type' => 'list', 'member' => [ 'shape' => 'Job', ], ], 'LimitExceededException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'Message', ], ], 'exception' => true, ], 'ListArtifactsRequest' => [ 'type' => 'structure', 'required' => [ 'arn', 'type', ], 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], 'type' => [ 'shape' => 'ArtifactCategory', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListArtifactsResult' => [ 'type' => 'structure', 'members' => [ 'artifacts' => [ 'shape' => 'Artifacts', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListDeviceInstancesRequest' => [ 'type' => 'structure', 'members' => [ 'maxResults' => [ 'shape' => 'Integer', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListDeviceInstancesResult' => [ 'type' => 'structure', 'members' => [ 'deviceInstances' => [ 'shape' => 'DeviceInstances', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListDevicePoolsRequest' => [ 'type' => 'structure', 'required' => [ 'arn', ], 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], 'type' => [ 'shape' => 'DevicePoolType', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListDevicePoolsResult' => [ 'type' => 'structure', 'members' => [ 'devicePools' => [ 'shape' => 'DevicePools', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListDevicesRequest' => [ 'type' => 'structure', 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], 'filters' => [ 'shape' => 'DeviceFilters', ], ], ], 'ListDevicesResult' => [ 'type' => 'structure', 'members' => [ 'devices' => [ 'shape' => 'Devices', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListInstanceProfilesRequest' => [ 'type' => 'structure', 'members' => [ 'maxResults' => [ 'shape' => 'Integer', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListInstanceProfilesResult' => [ 'type' => 'structure', 'members' => [ 'instanceProfiles' => [ 'shape' => 'InstanceProfiles', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListJobsRequest' => [ 'type' => 'structure', 'required' => [ 'arn', ], 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListJobsResult' => [ 'type' => 'structure', 'members' => [ 'jobs' => [ 'shape' => 'Jobs', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListNetworkProfilesRequest' => [ 'type' => 'structure', 'required' => [ 'arn', ], 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], 'type' => [ 'shape' => 'NetworkProfileType', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListNetworkProfilesResult' => [ 'type' => 'structure', 'members' => [ 'networkProfiles' => [ 'shape' => 'NetworkProfiles', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListOfferingPromotionsRequest' => [ 'type' => 'structure', 'members' => [ 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListOfferingPromotionsResult' => [ 'type' => 'structure', 'members' => [ 'offeringPromotions' => [ 'shape' => 'OfferingPromotions', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListOfferingTransactionsRequest' => [ 'type' => 'structure', 'members' => [ 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListOfferingTransactionsResult' => [ 'type' => 'structure', 'members' => [ 'offeringTransactions' => [ 'shape' => 'OfferingTransactions', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListOfferingsRequest' => [ 'type' => 'structure', 'members' => [ 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListOfferingsResult' => [ 'type' => 'structure', 'members' => [ 'offerings' => [ 'shape' => 'Offerings', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListProjectsRequest' => [ 'type' => 'structure', 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListProjectsResult' => [ 'type' => 'structure', 'members' => [ 'projects' => [ 'shape' => 'Projects', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListRemoteAccessSessionsRequest' => [ 'type' => 'structure', 'required' => [ 'arn', ], 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListRemoteAccessSessionsResult' => [ 'type' => 'structure', 'members' => [ 'remoteAccessSessions' => [ 'shape' => 'RemoteAccessSessions', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListRunsRequest' => [ 'type' => 'structure', 'required' => [ 'arn', ], 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListRunsResult' => [ 'type' => 'structure', 'members' => [ 'runs' => [ 'shape' => 'Runs', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListSamplesRequest' => [ 'type' => 'structure', 'required' => [ 'arn', ], 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListSamplesResult' => [ 'type' => 'structure', 'members' => [ 'samples' => [ 'shape' => 'Samples', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListSuitesRequest' => [ 'type' => 'structure', 'required' => [ 'arn', ], 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListSuitesResult' => [ 'type' => 'structure', 'members' => [ 'suites' => [ 'shape' => 'Suites', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListTestsRequest' => [ 'type' => 'structure', 'required' => [ 'arn', ], 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListTestsResult' => [ 'type' => 'structure', 'members' => [ 'tests' => [ 'shape' => 'Tests', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListUniqueProblemsRequest' => [ 'type' => 'structure', 'required' => [ 'arn', ], 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListUniqueProblemsResult' => [ 'type' => 'structure', 'members' => [ 'uniqueProblems' => [ 'shape' => 'UniqueProblemsByExecutionResultMap', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListUploadsRequest' => [ 'type' => 'structure', 'required' => [ 'arn', ], 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], 'type' => [ 'shape' => 'UploadType', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListUploadsResult' => [ 'type' => 'structure', 'members' => [ 'uploads' => [ 'shape' => 'Uploads', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListVPCEConfigurationsRequest' => [ 'type' => 'structure', 'members' => [ 'maxResults' => [ 'shape' => 'Integer', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListVPCEConfigurationsResult' => [ 'type' => 'structure', 'members' => [ 'vpceConfigurations' => [ 'shape' => 'VPCEConfigurations', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'Location' => [ 'type' => 'structure', 'required' => [ 'latitude', 'longitude', ], 'members' => [ 'latitude' => [ 'shape' => 'Double', ], 'longitude' => [ 'shape' => 'Double', ], ], ], 'Long' => [ 'type' => 'long', ], 'MaxSlotMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'String', ], 'value' => [ 'shape' => 'Integer', ], ], 'Message' => [ 'type' => 'string', 'max' => 16384, 'min' => 0, ], 'Metadata' => [ 'type' => 'string', 'max' => 8192, 'min' => 0, ], 'MonetaryAmount' => [ 'type' => 'structure', 'members' => [ 'amount' => [ 'shape' => 'Double', ], 'currencyCode' => [ 'shape' => 'CurrencyCode', ], ], ], 'Name' => [ 'type' => 'string', 'max' => 256, 'min' => 0, ], 'NetworkProfile' => [ 'type' => 'structure', 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], 'name' => [ 'shape' => 'Name', ], 'description' => [ 'shape' => 'Message', ], 'type' => [ 'shape' => 'NetworkProfileType', ], 'uplinkBandwidthBits' => [ 'shape' => 'Long', ], 'downlinkBandwidthBits' => [ 'shape' => 'Long', ], 'uplinkDelayMs' => [ 'shape' => 'Long', ], 'downlinkDelayMs' => [ 'shape' => 'Long', ], 'uplinkJitterMs' => [ 'shape' => 'Long', ], 'downlinkJitterMs' => [ 'shape' => 'Long', ], 'uplinkLossPercent' => [ 'shape' => 'PercentInteger', ], 'downlinkLossPercent' => [ 'shape' => 'PercentInteger', ], ], ], 'NetworkProfileType' => [ 'type' => 'string', 'enum' => [ 'CURATED', 'PRIVATE', ], ], 'NetworkProfiles' => [ 'type' => 'list', 'member' => [ 'shape' => 'NetworkProfile', ], ], 'NotEligibleException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'Message', ], ], 'exception' => true, ], 'NotFoundException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'Message', ], ], 'exception' => true, ], 'Offering' => [ 'type' => 'structure', 'members' => [ 'id' => [ 'shape' => 'OfferingIdentifier', ], 'description' => [ 'shape' => 'Message', ], 'type' => [ 'shape' => 'OfferingType', ], 'platform' => [ 'shape' => 'DevicePlatform', ], 'recurringCharges' => [ 'shape' => 'RecurringCharges', ], ], ], 'OfferingIdentifier' => [ 'type' => 'string', 'min' => 32, ], 'OfferingPromotion' => [ 'type' => 'structure', 'members' => [ 'id' => [ 'shape' => 'OfferingPromotionIdentifier', ], 'description' => [ 'shape' => 'Message', ], ], ], 'OfferingPromotionIdentifier' => [ 'type' => 'string', 'min' => 4, ], 'OfferingPromotions' => [ 'type' => 'list', 'member' => [ 'shape' => 'OfferingPromotion', ], ], 'OfferingStatus' => [ 'type' => 'structure', 'members' => [ 'type' => [ 'shape' => 'OfferingTransactionType', ], 'offering' => [ 'shape' => 'Offering', ], 'quantity' => [ 'shape' => 'Integer', ], 'effectiveOn' => [ 'shape' => 'DateTime', ], ], ], 'OfferingStatusMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'OfferingIdentifier', ], 'value' => [ 'shape' => 'OfferingStatus', ], ], 'OfferingTransaction' => [ 'type' => 'structure', 'members' => [ 'offeringStatus' => [ 'shape' => 'OfferingStatus', ], 'transactionId' => [ 'shape' => 'TransactionIdentifier', ], 'offeringPromotionId' => [ 'shape' => 'OfferingPromotionIdentifier', ], 'createdOn' => [ 'shape' => 'DateTime', ], 'cost' => [ 'shape' => 'MonetaryAmount', ], ], ], 'OfferingTransactionType' => [ 'type' => 'string', 'enum' => [ 'PURCHASE', 'RENEW', 'SYSTEM', ], ], 'OfferingTransactions' => [ 'type' => 'list', 'member' => [ 'shape' => 'OfferingTransaction', ], ], 'OfferingType' => [ 'type' => 'string', 'enum' => [ 'RECURRING', ], ], 'Offerings' => [ 'type' => 'list', 'member' => [ 'shape' => 'Offering', ], ], 'PackageIds' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'PaginationToken' => [ 'type' => 'string', 'max' => 1024, 'min' => 4, ], 'PercentInteger' => [ 'type' => 'integer', 'max' => 100, 'min' => 0, ], 'Problem' => [ 'type' => 'structure', 'members' => [ 'run' => [ 'shape' => 'ProblemDetail', ], 'job' => [ 'shape' => 'ProblemDetail', ], 'suite' => [ 'shape' => 'ProblemDetail', ], 'test' => [ 'shape' => 'ProblemDetail', ], 'device' => [ 'shape' => 'Device', ], 'result' => [ 'shape' => 'ExecutionResult', ], 'message' => [ 'shape' => 'Message', ], ], ], 'ProblemDetail' => [ 'type' => 'structure', 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], 'name' => [ 'shape' => 'Name', ], ], ], 'Problems' => [ 'type' => 'list', 'member' => [ 'shape' => 'Problem', ], ], 'Project' => [ 'type' => 'structure', 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], 'name' => [ 'shape' => 'Name', ], 'defaultJobTimeoutMinutes' => [ 'shape' => 'JobTimeoutMinutes', ], 'created' => [ 'shape' => 'DateTime', ], ], ], 'Projects' => [ 'type' => 'list', 'member' => [ 'shape' => 'Project', ], ], 'PurchaseOfferingRequest' => [ 'type' => 'structure', 'members' => [ 'offeringId' => [ 'shape' => 'OfferingIdentifier', ], 'quantity' => [ 'shape' => 'Integer', ], 'offeringPromotionId' => [ 'shape' => 'OfferingPromotionIdentifier', ], ], ], 'PurchaseOfferingResult' => [ 'type' => 'structure', 'members' => [ 'offeringTransaction' => [ 'shape' => 'OfferingTransaction', ], ], ], 'PurchasedDevicesMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'DevicePlatform', ], 'value' => [ 'shape' => 'Integer', ], ], 'Radios' => [ 'type' => 'structure', 'members' => [ 'wifi' => [ 'shape' => 'Boolean', ], 'bluetooth' => [ 'shape' => 'Boolean', ], 'nfc' => [ 'shape' => 'Boolean', ], 'gps' => [ 'shape' => 'Boolean', ], ], ], 'RecurringCharge' => [ 'type' => 'structure', 'members' => [ 'cost' => [ 'shape' => 'MonetaryAmount', ], 'frequency' => [ 'shape' => 'RecurringChargeFrequency', ], ], ], 'RecurringChargeFrequency' => [ 'type' => 'string', 'enum' => [ 'MONTHLY', ], ], 'RecurringCharges' => [ 'type' => 'list', 'member' => [ 'shape' => 'RecurringCharge', ], ], 'RemoteAccessSession' => [ 'type' => 'structure', 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], 'name' => [ 'shape' => 'Name', ], 'created' => [ 'shape' => 'DateTime', ], 'status' => [ 'shape' => 'ExecutionStatus', ], 'result' => [ 'shape' => 'ExecutionResult', ], 'message' => [ 'shape' => 'Message', ], 'started' => [ 'shape' => 'DateTime', ], 'stopped' => [ 'shape' => 'DateTime', ], 'device' => [ 'shape' => 'Device', ], 'instanceArn' => [ 'shape' => 'AmazonResourceName', ], 'remoteDebugEnabled' => [ 'shape' => 'Boolean', ], 'remoteRecordEnabled' => [ 'shape' => 'Boolean', ], 'remoteRecordAppArn' => [ 'shape' => 'AmazonResourceName', ], 'hostAddress' => [ 'shape' => 'HostAddress', ], 'clientId' => [ 'shape' => 'ClientId', ], 'billingMethod' => [ 'shape' => 'BillingMethod', ], 'deviceMinutes' => [ 'shape' => 'DeviceMinutes', ], 'endpoint' => [ 'shape' => 'String', ], 'deviceUdid' => [ 'shape' => 'String', ], 'interactionMode' => [ 'shape' => 'InteractionMode', ], 'skipAppResign' => [ 'shape' => 'SkipAppResign', ], ], ], 'RemoteAccessSessions' => [ 'type' => 'list', 'member' => [ 'shape' => 'RemoteAccessSession', ], ], 'RenewOfferingRequest' => [ 'type' => 'structure', 'members' => [ 'offeringId' => [ 'shape' => 'OfferingIdentifier', ], 'quantity' => [ 'shape' => 'Integer', ], ], ], 'RenewOfferingResult' => [ 'type' => 'structure', 'members' => [ 'offeringTransaction' => [ 'shape' => 'OfferingTransaction', ], ], ], 'Resolution' => [ 'type' => 'structure', 'members' => [ 'width' => [ 'shape' => 'Integer', ], 'height' => [ 'shape' => 'Integer', ], ], ], 'Rule' => [ 'type' => 'structure', 'members' => [ 'attribute' => [ 'shape' => 'DeviceAttribute', ], 'operator' => [ 'shape' => 'RuleOperator', ], 'value' => [ 'shape' => 'String', ], ], ], 'RuleOperator' => [ 'type' => 'string', 'enum' => [ 'EQUALS', 'LESS_THAN', 'GREATER_THAN', 'IN', 'NOT_IN', 'CONTAINS', ], ], 'Rules' => [ 'type' => 'list', 'member' => [ 'shape' => 'Rule', ], ], 'Run' => [ 'type' => 'structure', 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], 'name' => [ 'shape' => 'Name', ], 'type' => [ 'shape' => 'TestType', ], 'platform' => [ 'shape' => 'DevicePlatform', ], 'created' => [ 'shape' => 'DateTime', ], 'status' => [ 'shape' => 'ExecutionStatus', ], 'result' => [ 'shape' => 'ExecutionResult', ], 'started' => [ 'shape' => 'DateTime', ], 'stopped' => [ 'shape' => 'DateTime', ], 'counters' => [ 'shape' => 'Counters', ], 'message' => [ 'shape' => 'Message', ], 'totalJobs' => [ 'shape' => 'Integer', ], 'completedJobs' => [ 'shape' => 'Integer', ], 'billingMethod' => [ 'shape' => 'BillingMethod', ], 'deviceMinutes' => [ 'shape' => 'DeviceMinutes', ], 'networkProfile' => [ 'shape' => 'NetworkProfile', ], 'parsingResultUrl' => [ 'shape' => 'String', ], 'resultCode' => [ 'shape' => 'ExecutionResultCode', ], 'seed' => [ 'shape' => 'Integer', ], 'appUpload' => [ 'shape' => 'AmazonResourceName', ], 'eventCount' => [ 'shape' => 'Integer', ], 'jobTimeoutMinutes' => [ 'shape' => 'JobTimeoutMinutes', ], 'devicePoolArn' => [ 'shape' => 'AmazonResourceName', ], 'locale' => [ 'shape' => 'String', ], 'radios' => [ 'shape' => 'Radios', ], 'location' => [ 'shape' => 'Location', ], 'customerArtifactPaths' => [ 'shape' => 'CustomerArtifactPaths', ], 'webUrl' => [ 'shape' => 'String', ], 'skipAppResign' => [ 'shape' => 'SkipAppResign', ], 'testSpecArn' => [ 'shape' => 'AmazonResourceName', ], 'deviceSelectionResult' => [ 'shape' => 'DeviceSelectionResult', ], ], ], 'Runs' => [ 'type' => 'list', 'member' => [ 'shape' => 'Run', ], ], 'Sample' => [ 'type' => 'structure', 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], 'type' => [ 'shape' => 'SampleType', ], 'url' => [ 'shape' => 'URL', ], ], ], 'SampleType' => [ 'type' => 'string', 'enum' => [ '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', ], ], 'Samples' => [ 'type' => 'list', 'member' => [ 'shape' => 'Sample', ], ], 'ScheduleRunConfiguration' => [ 'type' => 'structure', 'members' => [ 'extraDataPackageArn' => [ 'shape' => 'AmazonResourceName', ], 'networkProfileArn' => [ 'shape' => 'AmazonResourceName', ], 'locale' => [ 'shape' => 'String', ], 'location' => [ 'shape' => 'Location', ], 'vpceConfigurationArns' => [ 'shape' => 'AmazonResourceNames', ], 'customerArtifactPaths' => [ 'shape' => 'CustomerArtifactPaths', ], 'radios' => [ 'shape' => 'Radios', ], 'auxiliaryApps' => [ 'shape' => 'AmazonResourceNames', ], 'billingMethod' => [ 'shape' => 'BillingMethod', ], ], ], 'ScheduleRunRequest' => [ 'type' => 'structure', 'required' => [ 'projectArn', 'test', ], 'members' => [ 'projectArn' => [ 'shape' => 'AmazonResourceName', ], 'appArn' => [ 'shape' => 'AmazonResourceName', ], 'devicePoolArn' => [ 'shape' => 'AmazonResourceName', ], 'deviceSelectionConfiguration' => [ 'shape' => 'DeviceSelectionConfiguration', ], 'name' => [ 'shape' => 'Name', ], 'test' => [ 'shape' => 'ScheduleRunTest', ], 'configuration' => [ 'shape' => 'ScheduleRunConfiguration', ], 'executionConfiguration' => [ 'shape' => 'ExecutionConfiguration', ], ], ], 'ScheduleRunResult' => [ 'type' => 'structure', 'members' => [ 'run' => [ 'shape' => 'Run', ], ], ], 'ScheduleRunTest' => [ 'type' => 'structure', 'required' => [ 'type', ], 'members' => [ 'type' => [ 'shape' => 'TestType', ], 'testPackageArn' => [ 'shape' => 'AmazonResourceName', ], 'testSpecArn' => [ 'shape' => 'AmazonResourceName', ], 'filter' => [ 'shape' => 'Filter', ], 'parameters' => [ 'shape' => 'TestParameters', ], ], ], 'ServiceAccountException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'Message', ], ], 'exception' => true, ], 'ServiceDnsName' => [ 'type' => 'string', 'max' => 2048, 'min' => 0, ], 'SkipAppResign' => [ 'type' => 'boolean', ], 'SshPublicKey' => [ 'type' => 'string', 'max' => 8192, 'min' => 0, ], 'StopJobRequest' => [ 'type' => 'structure', 'required' => [ 'arn', ], 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], ], ], 'StopJobResult' => [ 'type' => 'structure', 'members' => [ 'job' => [ 'shape' => 'Job', ], ], ], 'StopRemoteAccessSessionRequest' => [ 'type' => 'structure', 'required' => [ 'arn', ], 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], ], ], 'StopRemoteAccessSessionResult' => [ 'type' => 'structure', 'members' => [ 'remoteAccessSession' => [ 'shape' => 'RemoteAccessSession', ], ], ], 'StopRunRequest' => [ 'type' => 'structure', 'required' => [ 'arn', ], 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], ], ], 'StopRunResult' => [ 'type' => 'structure', 'members' => [ 'run' => [ 'shape' => 'Run', ], ], ], 'String' => [ 'type' => 'string', ], 'Suite' => [ 'type' => 'structure', 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], 'name' => [ 'shape' => 'Name', ], 'type' => [ 'shape' => 'TestType', ], 'created' => [ 'shape' => 'DateTime', ], 'status' => [ 'shape' => 'ExecutionStatus', ], 'result' => [ 'shape' => 'ExecutionResult', ], 'started' => [ 'shape' => 'DateTime', ], 'stopped' => [ 'shape' => 'DateTime', ], 'counters' => [ 'shape' => 'Counters', ], 'message' => [ 'shape' => 'Message', ], 'deviceMinutes' => [ 'shape' => 'DeviceMinutes', ], ], ], 'Suites' => [ 'type' => 'list', 'member' => [ 'shape' => 'Suite', ], ], 'Test' => [ 'type' => 'structure', 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], 'name' => [ 'shape' => 'Name', ], 'type' => [ 'shape' => 'TestType', ], 'created' => [ 'shape' => 'DateTime', ], 'status' => [ 'shape' => 'ExecutionStatus', ], 'result' => [ 'shape' => 'ExecutionResult', ], 'started' => [ 'shape' => 'DateTime', ], 'stopped' => [ 'shape' => 'DateTime', ], 'counters' => [ 'shape' => 'Counters', ], 'message' => [ 'shape' => 'Message', ], 'deviceMinutes' => [ 'shape' => 'DeviceMinutes', ], ], ], 'TestParameters' => [ 'type' => 'map', 'key' => [ 'shape' => 'String', ], 'value' => [ 'shape' => 'String', ], ], 'TestType' => [ 'type' => 'string', 'enum' => [ 'BUILTIN_FUZZ', 'BUILTIN_EXPLORER', 'WEB_PERFORMANCE_PROFILE', 'APPIUM_JAVA_JUNIT', 'APPIUM_JAVA_TESTNG', 'APPIUM_PYTHON', 'APPIUM_WEB_JAVA_JUNIT', 'APPIUM_WEB_JAVA_TESTNG', 'APPIUM_WEB_PYTHON', 'CALABASH', 'INSTRUMENTATION', 'UIAUTOMATION', 'UIAUTOMATOR', 'XCTEST', 'XCTEST_UI', 'REMOTE_ACCESS_RECORD', 'REMOTE_ACCESS_REPLAY', ], ], 'Tests' => [ 'type' => 'list', 'member' => [ 'shape' => 'Test', ], ], 'TransactionIdentifier' => [ 'type' => 'string', 'min' => 32, ], 'TrialMinutes' => [ 'type' => 'structure', 'members' => [ 'total' => [ 'shape' => 'Double', ], 'remaining' => [ 'shape' => 'Double', ], ], ], 'URL' => [ 'type' => 'string', 'max' => 2048, 'min' => 0, ], 'UniqueProblem' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'Message', ], 'problems' => [ 'shape' => 'Problems', ], ], ], 'UniqueProblems' => [ 'type' => 'list', 'member' => [ 'shape' => 'UniqueProblem', ], ], 'UniqueProblemsByExecutionResultMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'ExecutionResult', ], 'value' => [ 'shape' => 'UniqueProblems', ], ], 'UpdateDeviceInstanceRequest' => [ 'type' => 'structure', 'required' => [ 'arn', ], 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], 'profileArn' => [ 'shape' => 'AmazonResourceName', ], 'labels' => [ 'shape' => 'InstanceLabels', ], ], ], 'UpdateDeviceInstanceResult' => [ 'type' => 'structure', 'members' => [ 'deviceInstance' => [ 'shape' => 'DeviceInstance', ], ], ], 'UpdateDevicePoolRequest' => [ 'type' => 'structure', 'required' => [ 'arn', ], 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], 'name' => [ 'shape' => 'Name', ], 'description' => [ 'shape' => 'Message', ], 'rules' => [ 'shape' => 'Rules', ], ], ], 'UpdateDevicePoolResult' => [ 'type' => 'structure', 'members' => [ 'devicePool' => [ 'shape' => 'DevicePool', ], ], ], 'UpdateInstanceProfileRequest' => [ 'type' => 'structure', 'required' => [ 'arn', ], 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], 'name' => [ 'shape' => 'Name', ], 'description' => [ 'shape' => 'Message', ], 'packageCleanup' => [ 'shape' => 'Boolean', ], 'excludeAppPackagesFromCleanup' => [ 'shape' => 'PackageIds', ], 'rebootAfterUse' => [ 'shape' => 'Boolean', ], ], ], 'UpdateInstanceProfileResult' => [ 'type' => 'structure', 'members' => [ 'instanceProfile' => [ 'shape' => 'InstanceProfile', ], ], ], 'UpdateNetworkProfileRequest' => [ 'type' => 'structure', 'required' => [ 'arn', ], 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], 'name' => [ 'shape' => 'Name', ], 'description' => [ 'shape' => 'Message', ], 'type' => [ 'shape' => 'NetworkProfileType', ], 'uplinkBandwidthBits' => [ 'shape' => 'Long', ], 'downlinkBandwidthBits' => [ 'shape' => 'Long', ], 'uplinkDelayMs' => [ 'shape' => 'Long', ], 'downlinkDelayMs' => [ 'shape' => 'Long', ], 'uplinkJitterMs' => [ 'shape' => 'Long', ], 'downlinkJitterMs' => [ 'shape' => 'Long', ], 'uplinkLossPercent' => [ 'shape' => 'PercentInteger', ], 'downlinkLossPercent' => [ 'shape' => 'PercentInteger', ], ], ], 'UpdateNetworkProfileResult' => [ 'type' => 'structure', 'members' => [ 'networkProfile' => [ 'shape' => 'NetworkProfile', ], ], ], 'UpdateProjectRequest' => [ 'type' => 'structure', 'required' => [ 'arn', ], 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], 'name' => [ 'shape' => 'Name', ], 'defaultJobTimeoutMinutes' => [ 'shape' => 'JobTimeoutMinutes', ], ], ], 'UpdateProjectResult' => [ 'type' => 'structure', 'members' => [ 'project' => [ 'shape' => 'Project', ], ], ], 'UpdateUploadRequest' => [ 'type' => 'structure', 'required' => [ 'arn', ], 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], 'name' => [ 'shape' => 'Name', ], 'contentType' => [ 'shape' => 'ContentType', ], 'editContent' => [ 'shape' => 'Boolean', ], ], ], 'UpdateUploadResult' => [ 'type' => 'structure', 'members' => [ 'upload' => [ 'shape' => 'Upload', ], ], ], 'UpdateVPCEConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'arn', ], 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], 'vpceConfigurationName' => [ 'shape' => 'VPCEConfigurationName', ], 'vpceServiceName' => [ 'shape' => 'VPCEServiceName', ], 'serviceDnsName' => [ 'shape' => 'ServiceDnsName', ], 'vpceConfigurationDescription' => [ 'shape' => 'VPCEConfigurationDescription', ], ], ], 'UpdateVPCEConfigurationResult' => [ 'type' => 'structure', 'members' => [ 'vpceConfiguration' => [ 'shape' => 'VPCEConfiguration', ], ], ], 'Upload' => [ 'type' => 'structure', 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], 'name' => [ 'shape' => 'Name', ], 'created' => [ 'shape' => 'DateTime', ], 'type' => [ 'shape' => 'UploadType', ], 'status' => [ 'shape' => 'UploadStatus', ], 'url' => [ 'shape' => 'URL', ], 'metadata' => [ 'shape' => 'Metadata', ], 'contentType' => [ 'shape' => 'ContentType', ], 'message' => [ 'shape' => 'Message', ], 'category' => [ 'shape' => 'UploadCategory', ], ], ], 'UploadCategory' => [ 'type' => 'string', 'enum' => [ 'CURATED', 'PRIVATE', ], ], 'UploadStatus' => [ 'type' => 'string', 'enum' => [ 'INITIALIZED', 'PROCESSING', 'SUCCEEDED', 'FAILED', ], ], 'UploadType' => [ 'type' => 'string', 'enum' => [ 'ANDROID_APP', 'IOS_APP', 'WEB_APP', 'EXTERNAL_DATA', 'APPIUM_JAVA_JUNIT_TEST_PACKAGE', 'APPIUM_JAVA_TESTNG_TEST_PACKAGE', 'APPIUM_PYTHON_TEST_PACKAGE', 'APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE', 'APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE', 'APPIUM_WEB_PYTHON_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_WEB_JAVA_JUNIT_TEST_SPEC', 'APPIUM_WEB_JAVA_TESTNG_TEST_SPEC', 'APPIUM_WEB_PYTHON_TEST_SPEC', 'INSTRUMENTATION_TEST_SPEC', 'XCTEST_UI_TEST_SPEC', ], ], 'Uploads' => [ 'type' => 'list', 'member' => [ 'shape' => 'Upload', ], ], 'VPCEConfiguration' => [ 'type' => 'structure', 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], 'vpceConfigurationName' => [ 'shape' => 'VPCEConfigurationName', ], 'vpceServiceName' => [ 'shape' => 'VPCEServiceName', ], 'serviceDnsName' => [ 'shape' => 'ServiceDnsName', ], 'vpceConfigurationDescription' => [ 'shape' => 'VPCEConfigurationDescription', ], ], ], 'VPCEConfigurationDescription' => [ 'type' => 'string', 'max' => 2048, 'min' => 0, ], 'VPCEConfigurationName' => [ 'type' => 'string', 'max' => 1024, 'min' => 0, ], 'VPCEConfigurations' => [ 'type' => 'list', 'member' => [ 'shape' => 'VPCEConfiguration', ], ], 'VPCEServiceName' => [ 'type' => 'string', 'max' => 2048, 'min' => 0, ], 'VideoCapture' => [ 'type' => 'boolean', ], ],]; +return [ 'version' => '2.0', 'metadata' => [ 'apiVersion' => '2015-06-23', 'endpointPrefix' => 'devicefarm', 'jsonVersion' => '1.1', 'protocol' => 'json', 'serviceFullName' => 'AWS Device Farm', 'serviceId' => 'Device Farm', 'signatureVersion' => 'v4', 'targetPrefix' => 'DeviceFarm_20150623', 'uid' => 'devicefarm-2015-06-23', ], 'operations' => [ 'CreateDevicePool' => [ 'name' => 'CreateDevicePool', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDevicePoolRequest', ], 'output' => [ 'shape' => 'CreateDevicePoolResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'CreateInstanceProfile' => [ 'name' => 'CreateInstanceProfile', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateInstanceProfileRequest', ], 'output' => [ 'shape' => 'CreateInstanceProfileResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'CreateNetworkProfile' => [ 'name' => 'CreateNetworkProfile', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateNetworkProfileRequest', ], 'output' => [ 'shape' => 'CreateNetworkProfileResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'CreateProject' => [ 'name' => 'CreateProject', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateProjectRequest', ], 'output' => [ 'shape' => 'CreateProjectResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'CreateRemoteAccessSession' => [ 'name' => 'CreateRemoteAccessSession', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateRemoteAccessSessionRequest', ], 'output' => [ 'shape' => 'CreateRemoteAccessSessionResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'CreateUpload' => [ 'name' => 'CreateUpload', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateUploadRequest', ], 'output' => [ 'shape' => 'CreateUploadResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'CreateVPCEConfiguration' => [ 'name' => 'CreateVPCEConfiguration', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateVPCEConfigurationRequest', ], 'output' => [ 'shape' => 'CreateVPCEConfigurationResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'DeleteDevicePool' => [ 'name' => 'DeleteDevicePool', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteDevicePoolRequest', ], 'output' => [ 'shape' => 'DeleteDevicePoolResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'DeleteInstanceProfile' => [ 'name' => 'DeleteInstanceProfile', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteInstanceProfileRequest', ], 'output' => [ 'shape' => 'DeleteInstanceProfileResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'DeleteNetworkProfile' => [ 'name' => 'DeleteNetworkProfile', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteNetworkProfileRequest', ], 'output' => [ 'shape' => 'DeleteNetworkProfileResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'DeleteProject' => [ 'name' => 'DeleteProject', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteProjectRequest', ], 'output' => [ 'shape' => 'DeleteProjectResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'DeleteRemoteAccessSession' => [ 'name' => 'DeleteRemoteAccessSession', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteRemoteAccessSessionRequest', ], 'output' => [ 'shape' => 'DeleteRemoteAccessSessionResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'DeleteRun' => [ 'name' => 'DeleteRun', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteRunRequest', ], 'output' => [ 'shape' => 'DeleteRunResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'DeleteUpload' => [ 'name' => 'DeleteUpload', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteUploadRequest', ], 'output' => [ 'shape' => 'DeleteUploadResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'DeleteVPCEConfiguration' => [ 'name' => 'DeleteVPCEConfiguration', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteVPCEConfigurationRequest', ], 'output' => [ 'shape' => 'DeleteVPCEConfigurationResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ServiceAccountException', ], [ 'shape' => 'InvalidOperationException', ], ], ], 'GetAccountSettings' => [ 'name' => 'GetAccountSettings', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetAccountSettingsRequest', ], 'output' => [ 'shape' => 'GetAccountSettingsResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'GetDevice' => [ 'name' => 'GetDevice', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetDeviceRequest', ], 'output' => [ 'shape' => 'GetDeviceResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'GetDeviceInstance' => [ 'name' => 'GetDeviceInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetDeviceInstanceRequest', ], 'output' => [ 'shape' => 'GetDeviceInstanceResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'GetDevicePool' => [ 'name' => 'GetDevicePool', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetDevicePoolRequest', ], 'output' => [ 'shape' => 'GetDevicePoolResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'GetDevicePoolCompatibility' => [ 'name' => 'GetDevicePoolCompatibility', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetDevicePoolCompatibilityRequest', ], 'output' => [ 'shape' => 'GetDevicePoolCompatibilityResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'GetInstanceProfile' => [ 'name' => 'GetInstanceProfile', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetInstanceProfileRequest', ], 'output' => [ 'shape' => 'GetInstanceProfileResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'GetJob' => [ 'name' => 'GetJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetJobRequest', ], 'output' => [ 'shape' => 'GetJobResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'GetNetworkProfile' => [ 'name' => 'GetNetworkProfile', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetNetworkProfileRequest', ], 'output' => [ 'shape' => 'GetNetworkProfileResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'GetOfferingStatus' => [ 'name' => 'GetOfferingStatus', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetOfferingStatusRequest', ], 'output' => [ 'shape' => 'GetOfferingStatusResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'NotEligibleException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'GetProject' => [ 'name' => 'GetProject', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetProjectRequest', ], 'output' => [ 'shape' => 'GetProjectResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'GetRemoteAccessSession' => [ 'name' => 'GetRemoteAccessSession', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetRemoteAccessSessionRequest', ], 'output' => [ 'shape' => 'GetRemoteAccessSessionResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'GetRun' => [ 'name' => 'GetRun', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetRunRequest', ], 'output' => [ 'shape' => 'GetRunResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'GetSuite' => [ 'name' => 'GetSuite', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetSuiteRequest', ], 'output' => [ 'shape' => 'GetSuiteResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'GetTest' => [ 'name' => 'GetTest', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetTestRequest', ], 'output' => [ 'shape' => 'GetTestResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'GetUpload' => [ 'name' => 'GetUpload', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetUploadRequest', ], 'output' => [ 'shape' => 'GetUploadResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'GetVPCEConfiguration' => [ 'name' => 'GetVPCEConfiguration', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'GetVPCEConfigurationRequest', ], 'output' => [ 'shape' => 'GetVPCEConfigurationResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'InstallToRemoteAccessSession' => [ 'name' => 'InstallToRemoteAccessSession', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'InstallToRemoteAccessSessionRequest', ], 'output' => [ 'shape' => 'InstallToRemoteAccessSessionResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'ListArtifacts' => [ 'name' => 'ListArtifacts', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListArtifactsRequest', ], 'output' => [ 'shape' => 'ListArtifactsResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'ListDeviceInstances' => [ 'name' => 'ListDeviceInstances', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListDeviceInstancesRequest', ], 'output' => [ 'shape' => 'ListDeviceInstancesResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'ListDevicePools' => [ 'name' => 'ListDevicePools', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListDevicePoolsRequest', ], 'output' => [ 'shape' => 'ListDevicePoolsResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'ListDevices' => [ 'name' => 'ListDevices', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListDevicesRequest', ], 'output' => [ 'shape' => 'ListDevicesResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'ListInstanceProfiles' => [ 'name' => 'ListInstanceProfiles', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListInstanceProfilesRequest', ], 'output' => [ 'shape' => 'ListInstanceProfilesResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'ListJobs' => [ 'name' => 'ListJobs', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListJobsRequest', ], 'output' => [ 'shape' => 'ListJobsResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'ListNetworkProfiles' => [ 'name' => 'ListNetworkProfiles', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListNetworkProfilesRequest', ], 'output' => [ 'shape' => 'ListNetworkProfilesResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'ListOfferingPromotions' => [ 'name' => 'ListOfferingPromotions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListOfferingPromotionsRequest', ], 'output' => [ 'shape' => 'ListOfferingPromotionsResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'NotEligibleException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'ListOfferingTransactions' => [ 'name' => 'ListOfferingTransactions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListOfferingTransactionsRequest', ], 'output' => [ 'shape' => 'ListOfferingTransactionsResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'NotEligibleException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'ListOfferings' => [ 'name' => 'ListOfferings', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListOfferingsRequest', ], 'output' => [ 'shape' => 'ListOfferingsResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'NotEligibleException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'ListProjects' => [ 'name' => 'ListProjects', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListProjectsRequest', ], 'output' => [ 'shape' => 'ListProjectsResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'ListRemoteAccessSessions' => [ 'name' => 'ListRemoteAccessSessions', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListRemoteAccessSessionsRequest', ], 'output' => [ 'shape' => 'ListRemoteAccessSessionsResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'ListRuns' => [ 'name' => 'ListRuns', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListRunsRequest', ], 'output' => [ 'shape' => 'ListRunsResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'ListSamples' => [ 'name' => 'ListSamples', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListSamplesRequest', ], 'output' => [ 'shape' => 'ListSamplesResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'ListSuites' => [ 'name' => 'ListSuites', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListSuitesRequest', ], 'output' => [ 'shape' => 'ListSuitesResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'ListTests' => [ 'name' => 'ListTests', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListTestsRequest', ], 'output' => [ 'shape' => 'ListTestsResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'ListUniqueProblems' => [ 'name' => 'ListUniqueProblems', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListUniqueProblemsRequest', ], 'output' => [ 'shape' => 'ListUniqueProblemsResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'ListUploads' => [ 'name' => 'ListUploads', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListUploadsRequest', ], 'output' => [ 'shape' => 'ListUploadsResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'ListVPCEConfigurations' => [ 'name' => 'ListVPCEConfigurations', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListVPCEConfigurationsRequest', ], 'output' => [ 'shape' => 'ListVPCEConfigurationsResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'PurchaseOffering' => [ 'name' => 'PurchaseOffering', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'PurchaseOfferingRequest', ], 'output' => [ 'shape' => 'PurchaseOfferingResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'NotEligibleException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'RenewOffering' => [ 'name' => 'RenewOffering', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'RenewOfferingRequest', ], 'output' => [ 'shape' => 'RenewOfferingResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'NotEligibleException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'ScheduleRun' => [ 'name' => 'ScheduleRun', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ScheduleRunRequest', ], 'output' => [ 'shape' => 'ScheduleRunResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'IdempotencyException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'StopJob' => [ 'name' => 'StopJob', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopJobRequest', ], 'output' => [ 'shape' => 'StopJobResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'StopRemoteAccessSession' => [ 'name' => 'StopRemoteAccessSession', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopRemoteAccessSessionRequest', ], 'output' => [ 'shape' => 'StopRemoteAccessSessionResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'StopRun' => [ 'name' => 'StopRun', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopRunRequest', ], 'output' => [ 'shape' => 'StopRunResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'UpdateDeviceInstance' => [ 'name' => 'UpdateDeviceInstance', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateDeviceInstanceRequest', ], 'output' => [ 'shape' => 'UpdateDeviceInstanceResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'UpdateDevicePool' => [ 'name' => 'UpdateDevicePool', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateDevicePoolRequest', ], 'output' => [ 'shape' => 'UpdateDevicePoolResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'UpdateInstanceProfile' => [ 'name' => 'UpdateInstanceProfile', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateInstanceProfileRequest', ], 'output' => [ 'shape' => 'UpdateInstanceProfileResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'UpdateNetworkProfile' => [ 'name' => 'UpdateNetworkProfile', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateNetworkProfileRequest', ], 'output' => [ 'shape' => 'UpdateNetworkProfileResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'UpdateProject' => [ 'name' => 'UpdateProject', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateProjectRequest', ], 'output' => [ 'shape' => 'UpdateProjectResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'UpdateUpload' => [ 'name' => 'UpdateUpload', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateUploadRequest', ], 'output' => [ 'shape' => 'UpdateUploadResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'LimitExceededException', ], [ 'shape' => 'ServiceAccountException', ], ], ], 'UpdateVPCEConfiguration' => [ 'name' => 'UpdateVPCEConfiguration', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateVPCEConfigurationRequest', ], 'output' => [ 'shape' => 'UpdateVPCEConfigurationResult', ], 'errors' => [ [ 'shape' => 'ArgumentException', ], [ 'shape' => 'NotFoundException', ], [ 'shape' => 'ServiceAccountException', ], [ 'shape' => 'InvalidOperationException', ], ], ], ], 'shapes' => [ 'AWSAccountNumber' => [ 'type' => 'string', 'max' => 16, 'min' => 2, ], 'AccountSettings' => [ 'type' => 'structure', 'members' => [ 'awsAccountNumber' => [ 'shape' => 'AWSAccountNumber', ], 'unmeteredDevices' => [ 'shape' => 'PurchasedDevicesMap', ], 'unmeteredRemoteAccessDevices' => [ 'shape' => 'PurchasedDevicesMap', ], 'maxJobTimeoutMinutes' => [ 'shape' => 'JobTimeoutMinutes', ], 'trialMinutes' => [ 'shape' => 'TrialMinutes', ], 'maxSlots' => [ 'shape' => 'MaxSlotMap', ], 'defaultJobTimeoutMinutes' => [ 'shape' => 'JobTimeoutMinutes', ], 'skipAppResign' => [ 'shape' => 'SkipAppResign', ], ], ], 'AccountsCleanup' => [ 'type' => 'boolean', ], 'AmazonResourceName' => [ 'type' => 'string', 'min' => 32, ], 'AmazonResourceNames' => [ 'type' => 'list', 'member' => [ 'shape' => 'AmazonResourceName', ], ], 'AndroidPaths' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'AppPackagesCleanup' => [ 'type' => 'boolean', ], 'ArgumentException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'Message', ], ], 'exception' => true, ], 'Artifact' => [ 'type' => 'structure', 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], 'name' => [ 'shape' => 'Name', ], 'type' => [ 'shape' => 'ArtifactType', ], 'extension' => [ 'shape' => 'String', ], 'url' => [ 'shape' => 'URL', ], ], ], 'ArtifactCategory' => [ 'type' => 'string', 'enum' => [ 'SCREENSHOT', 'FILE', 'LOG', ], ], 'ArtifactType' => [ 'type' => 'string', 'enum' => [ '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', ], ], 'Artifacts' => [ 'type' => 'list', 'member' => [ 'shape' => 'Artifact', ], ], 'BillingMethod' => [ 'type' => 'string', 'enum' => [ 'METERED', 'UNMETERED', ], ], 'Boolean' => [ 'type' => 'boolean', ], 'CPU' => [ 'type' => 'structure', 'members' => [ 'frequency' => [ 'shape' => 'String', ], 'architecture' => [ 'shape' => 'String', ], 'clock' => [ 'shape' => 'Double', ], ], ], 'ClientId' => [ 'type' => 'string', 'max' => 64, 'min' => 0, ], 'ContentType' => [ 'type' => 'string', 'max' => 64, 'min' => 0, ], 'Counters' => [ 'type' => 'structure', 'members' => [ 'total' => [ 'shape' => 'Integer', ], 'passed' => [ 'shape' => 'Integer', ], 'failed' => [ 'shape' => 'Integer', ], 'warned' => [ 'shape' => 'Integer', ], 'errored' => [ 'shape' => 'Integer', ], 'stopped' => [ 'shape' => 'Integer', ], 'skipped' => [ 'shape' => 'Integer', ], ], ], 'CreateDevicePoolRequest' => [ 'type' => 'structure', 'required' => [ 'projectArn', 'name', 'rules', ], 'members' => [ 'projectArn' => [ 'shape' => 'AmazonResourceName', ], 'name' => [ 'shape' => 'Name', ], 'description' => [ 'shape' => 'Message', ], 'rules' => [ 'shape' => 'Rules', ], ], ], 'CreateDevicePoolResult' => [ 'type' => 'structure', 'members' => [ 'devicePool' => [ 'shape' => 'DevicePool', ], ], ], 'CreateInstanceProfileRequest' => [ 'type' => 'structure', 'required' => [ 'name', ], 'members' => [ 'name' => [ 'shape' => 'Name', ], 'description' => [ 'shape' => 'Message', ], 'packageCleanup' => [ 'shape' => 'Boolean', ], 'excludeAppPackagesFromCleanup' => [ 'shape' => 'PackageIds', ], 'rebootAfterUse' => [ 'shape' => 'Boolean', ], ], ], 'CreateInstanceProfileResult' => [ 'type' => 'structure', 'members' => [ 'instanceProfile' => [ 'shape' => 'InstanceProfile', ], ], ], 'CreateNetworkProfileRequest' => [ 'type' => 'structure', 'required' => [ 'projectArn', 'name', ], 'members' => [ 'projectArn' => [ 'shape' => 'AmazonResourceName', ], 'name' => [ 'shape' => 'Name', ], 'description' => [ 'shape' => 'Message', ], 'type' => [ 'shape' => 'NetworkProfileType', ], 'uplinkBandwidthBits' => [ 'shape' => 'Long', ], 'downlinkBandwidthBits' => [ 'shape' => 'Long', ], 'uplinkDelayMs' => [ 'shape' => 'Long', ], 'downlinkDelayMs' => [ 'shape' => 'Long', ], 'uplinkJitterMs' => [ 'shape' => 'Long', ], 'downlinkJitterMs' => [ 'shape' => 'Long', ], 'uplinkLossPercent' => [ 'shape' => 'PercentInteger', ], 'downlinkLossPercent' => [ 'shape' => 'PercentInteger', ], ], ], 'CreateNetworkProfileResult' => [ 'type' => 'structure', 'members' => [ 'networkProfile' => [ 'shape' => 'NetworkProfile', ], ], ], 'CreateProjectRequest' => [ 'type' => 'structure', 'required' => [ 'name', ], 'members' => [ 'name' => [ 'shape' => 'Name', ], 'defaultJobTimeoutMinutes' => [ 'shape' => 'JobTimeoutMinutes', ], ], ], 'CreateProjectResult' => [ 'type' => 'structure', 'members' => [ 'project' => [ 'shape' => 'Project', ], ], ], 'CreateRemoteAccessSessionConfiguration' => [ 'type' => 'structure', 'members' => [ 'billingMethod' => [ 'shape' => 'BillingMethod', ], 'vpceConfigurationArns' => [ 'shape' => 'AmazonResourceNames', ], ], ], 'CreateRemoteAccessSessionRequest' => [ 'type' => 'structure', 'required' => [ 'projectArn', 'deviceArn', ], 'members' => [ 'projectArn' => [ 'shape' => 'AmazonResourceName', ], 'deviceArn' => [ 'shape' => 'AmazonResourceName', ], 'instanceArn' => [ 'shape' => 'AmazonResourceName', ], 'sshPublicKey' => [ 'shape' => 'SshPublicKey', ], 'remoteDebugEnabled' => [ 'shape' => 'Boolean', ], 'remoteRecordEnabled' => [ 'shape' => 'Boolean', ], 'remoteRecordAppArn' => [ 'shape' => 'AmazonResourceName', ], 'name' => [ 'shape' => 'Name', ], 'clientId' => [ 'shape' => 'ClientId', ], 'configuration' => [ 'shape' => 'CreateRemoteAccessSessionConfiguration', ], 'interactionMode' => [ 'shape' => 'InteractionMode', ], 'skipAppResign' => [ 'shape' => 'Boolean', ], ], ], 'CreateRemoteAccessSessionResult' => [ 'type' => 'structure', 'members' => [ 'remoteAccessSession' => [ 'shape' => 'RemoteAccessSession', ], ], ], 'CreateUploadRequest' => [ 'type' => 'structure', 'required' => [ 'projectArn', 'name', 'type', ], 'members' => [ 'projectArn' => [ 'shape' => 'AmazonResourceName', ], 'name' => [ 'shape' => 'Name', ], 'type' => [ 'shape' => 'UploadType', ], 'contentType' => [ 'shape' => 'ContentType', ], ], ], 'CreateUploadResult' => [ 'type' => 'structure', 'members' => [ 'upload' => [ 'shape' => 'Upload', ], ], ], 'CreateVPCEConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'vpceConfigurationName', 'vpceServiceName', 'serviceDnsName', ], 'members' => [ 'vpceConfigurationName' => [ 'shape' => 'VPCEConfigurationName', ], 'vpceServiceName' => [ 'shape' => 'VPCEServiceName', ], 'serviceDnsName' => [ 'shape' => 'ServiceDnsName', ], 'vpceConfigurationDescription' => [ 'shape' => 'VPCEConfigurationDescription', ], ], ], 'CreateVPCEConfigurationResult' => [ 'type' => 'structure', 'members' => [ 'vpceConfiguration' => [ 'shape' => 'VPCEConfiguration', ], ], ], 'CurrencyCode' => [ 'type' => 'string', 'enum' => [ 'USD', ], ], 'CustomerArtifactPaths' => [ 'type' => 'structure', 'members' => [ 'iosPaths' => [ 'shape' => 'IosPaths', ], 'androidPaths' => [ 'shape' => 'AndroidPaths', ], 'deviceHostPaths' => [ 'shape' => 'DeviceHostPaths', ], ], ], 'DateTime' => [ 'type' => 'timestamp', ], 'DeleteDevicePoolRequest' => [ 'type' => 'structure', 'required' => [ 'arn', ], 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], ], ], 'DeleteDevicePoolResult' => [ 'type' => 'structure', 'members' => [], ], 'DeleteInstanceProfileRequest' => [ 'type' => 'structure', 'required' => [ 'arn', ], 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], ], ], 'DeleteInstanceProfileResult' => [ 'type' => 'structure', 'members' => [], ], 'DeleteNetworkProfileRequest' => [ 'type' => 'structure', 'required' => [ 'arn', ], 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], ], ], 'DeleteNetworkProfileResult' => [ 'type' => 'structure', 'members' => [], ], 'DeleteProjectRequest' => [ 'type' => 'structure', 'required' => [ 'arn', ], 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], ], ], 'DeleteProjectResult' => [ 'type' => 'structure', 'members' => [], ], 'DeleteRemoteAccessSessionRequest' => [ 'type' => 'structure', 'required' => [ 'arn', ], 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], ], ], 'DeleteRemoteAccessSessionResult' => [ 'type' => 'structure', 'members' => [], ], 'DeleteRunRequest' => [ 'type' => 'structure', 'required' => [ 'arn', ], 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], ], ], 'DeleteRunResult' => [ 'type' => 'structure', 'members' => [], ], 'DeleteUploadRequest' => [ 'type' => 'structure', 'required' => [ 'arn', ], 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], ], ], 'DeleteUploadResult' => [ 'type' => 'structure', 'members' => [], ], 'DeleteVPCEConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'arn', ], 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], ], ], 'DeleteVPCEConfigurationResult' => [ 'type' => 'structure', 'members' => [], ], 'Device' => [ 'type' => 'structure', 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], 'name' => [ 'shape' => 'Name', ], 'manufacturer' => [ 'shape' => 'String', ], 'model' => [ 'shape' => 'String', ], 'modelId' => [ 'shape' => 'String', ], 'formFactor' => [ 'shape' => 'DeviceFormFactor', ], 'platform' => [ 'shape' => 'DevicePlatform', ], 'os' => [ 'shape' => 'String', ], 'cpu' => [ 'shape' => 'CPU', ], 'resolution' => [ 'shape' => 'Resolution', ], 'heapSize' => [ 'shape' => 'Long', ], 'memory' => [ 'shape' => 'Long', ], 'image' => [ 'shape' => 'String', ], 'carrier' => [ 'shape' => 'String', ], 'radio' => [ 'shape' => 'String', ], 'remoteAccessEnabled' => [ 'shape' => 'Boolean', ], 'remoteDebugEnabled' => [ 'shape' => 'Boolean', ], 'fleetType' => [ 'shape' => 'String', ], 'fleetName' => [ 'shape' => 'String', ], 'instances' => [ 'shape' => 'DeviceInstances', ], 'availability' => [ 'shape' => 'DeviceAvailability', ], ], ], 'DeviceAttribute' => [ 'type' => 'string', 'enum' => [ 'ARN', 'PLATFORM', 'FORM_FACTOR', 'MANUFACTURER', 'REMOTE_ACCESS_ENABLED', 'REMOTE_DEBUG_ENABLED', 'APPIUM_VERSION', 'INSTANCE_ARN', 'INSTANCE_LABELS', 'FLEET_TYPE', ], ], 'DeviceAvailability' => [ 'type' => 'string', 'enum' => [ 'TEMPORARY_NOT_AVAILABLE', 'BUSY', 'AVAILABLE', 'HIGHLY_AVAILABLE', ], ], 'DeviceFilter' => [ 'type' => 'structure', 'members' => [ 'attribute' => [ 'shape' => 'DeviceFilterAttribute', ], 'operator' => [ 'shape' => 'DeviceFilterOperator', ], 'values' => [ 'shape' => 'DeviceFilterValues', ], ], ], 'DeviceFilterAttribute' => [ 'type' => 'string', 'enum' => [ 'ARN', 'PLATFORM', 'OS_VERSION', 'MODEL', 'AVAILABILITY', 'FORM_FACTOR', 'MANUFACTURER', 'REMOTE_ACCESS_ENABLED', 'REMOTE_DEBUG_ENABLED', 'INSTANCE_ARN', 'INSTANCE_LABELS', 'FLEET_TYPE', ], ], 'DeviceFilterOperator' => [ 'type' => 'string', 'enum' => [ 'EQUALS', 'LESS_THAN', 'LESS_THAN_OR_EQUALS', 'GREATER_THAN', 'GREATER_THAN_OR_EQUALS', 'IN', 'NOT_IN', 'CONTAINS', ], ], 'DeviceFilterValues' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'DeviceFilters' => [ 'type' => 'list', 'member' => [ 'shape' => 'DeviceFilter', ], ], 'DeviceFormFactor' => [ 'type' => 'string', 'enum' => [ 'PHONE', 'TABLET', ], ], 'DeviceHostPaths' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'DeviceInstance' => [ 'type' => 'structure', 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], 'deviceArn' => [ 'shape' => 'AmazonResourceName', ], 'labels' => [ 'shape' => 'InstanceLabels', ], 'status' => [ 'shape' => 'InstanceStatus', ], 'udid' => [ 'shape' => 'String', ], 'instanceProfile' => [ 'shape' => 'InstanceProfile', ], ], ], 'DeviceInstances' => [ 'type' => 'list', 'member' => [ 'shape' => 'DeviceInstance', ], ], 'DeviceMinutes' => [ 'type' => 'structure', 'members' => [ 'total' => [ 'shape' => 'Double', ], 'metered' => [ 'shape' => 'Double', ], 'unmetered' => [ 'shape' => 'Double', ], ], ], 'DevicePlatform' => [ 'type' => 'string', 'enum' => [ 'ANDROID', 'IOS', ], ], 'DevicePool' => [ 'type' => 'structure', 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], 'name' => [ 'shape' => 'Name', ], 'description' => [ 'shape' => 'Message', ], 'type' => [ 'shape' => 'DevicePoolType', ], 'rules' => [ 'shape' => 'Rules', ], ], ], 'DevicePoolCompatibilityResult' => [ 'type' => 'structure', 'members' => [ 'device' => [ 'shape' => 'Device', ], 'compatible' => [ 'shape' => 'Boolean', ], 'incompatibilityMessages' => [ 'shape' => 'IncompatibilityMessages', ], ], ], 'DevicePoolCompatibilityResults' => [ 'type' => 'list', 'member' => [ 'shape' => 'DevicePoolCompatibilityResult', ], ], 'DevicePoolType' => [ 'type' => 'string', 'enum' => [ 'CURATED', 'PRIVATE', ], ], 'DevicePools' => [ 'type' => 'list', 'member' => [ 'shape' => 'DevicePool', ], ], 'DeviceSelectionConfiguration' => [ 'type' => 'structure', 'required' => [ 'filters', 'maxDevices', ], 'members' => [ 'filters' => [ 'shape' => 'DeviceFilters', ], 'maxDevices' => [ 'shape' => 'Integer', ], ], ], 'DeviceSelectionResult' => [ 'type' => 'structure', 'members' => [ 'filters' => [ 'shape' => 'DeviceFilters', ], 'matchedDevicesCount' => [ 'shape' => 'Integer', ], 'maxDevices' => [ 'shape' => 'Integer', ], ], ], 'Devices' => [ 'type' => 'list', 'member' => [ 'shape' => 'Device', ], ], 'Double' => [ 'type' => 'double', ], 'ExecutionConfiguration' => [ 'type' => 'structure', 'members' => [ 'jobTimeoutMinutes' => [ 'shape' => 'JobTimeoutMinutes', ], 'accountsCleanup' => [ 'shape' => 'AccountsCleanup', ], 'appPackagesCleanup' => [ 'shape' => 'AppPackagesCleanup', ], 'videoCapture' => [ 'shape' => 'VideoCapture', ], 'skipAppResign' => [ 'shape' => 'SkipAppResign', ], ], ], 'ExecutionResult' => [ 'type' => 'string', 'enum' => [ 'PENDING', 'PASSED', 'WARNED', 'FAILED', 'SKIPPED', 'ERRORED', 'STOPPED', ], ], 'ExecutionResultCode' => [ 'type' => 'string', 'enum' => [ 'PARSING_FAILED', 'VPC_ENDPOINT_SETUP_FAILED', ], ], 'ExecutionStatus' => [ 'type' => 'string', 'enum' => [ 'PENDING', 'PENDING_CONCURRENCY', 'PENDING_DEVICE', 'PROCESSING', 'SCHEDULING', 'PREPARING', 'RUNNING', 'COMPLETED', 'STOPPING', ], ], 'Filter' => [ 'type' => 'string', 'max' => 8192, 'min' => 0, ], 'GetAccountSettingsRequest' => [ 'type' => 'structure', 'members' => [], ], 'GetAccountSettingsResult' => [ 'type' => 'structure', 'members' => [ 'accountSettings' => [ 'shape' => 'AccountSettings', ], ], ], 'GetDeviceInstanceRequest' => [ 'type' => 'structure', 'required' => [ 'arn', ], 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], ], ], 'GetDeviceInstanceResult' => [ 'type' => 'structure', 'members' => [ 'deviceInstance' => [ 'shape' => 'DeviceInstance', ], ], ], 'GetDevicePoolCompatibilityRequest' => [ 'type' => 'structure', 'required' => [ 'devicePoolArn', ], 'members' => [ 'devicePoolArn' => [ 'shape' => 'AmazonResourceName', ], 'appArn' => [ 'shape' => 'AmazonResourceName', ], 'testType' => [ 'shape' => 'TestType', ], 'test' => [ 'shape' => 'ScheduleRunTest', ], 'configuration' => [ 'shape' => 'ScheduleRunConfiguration', ], ], ], 'GetDevicePoolCompatibilityResult' => [ 'type' => 'structure', 'members' => [ 'compatibleDevices' => [ 'shape' => 'DevicePoolCompatibilityResults', ], 'incompatibleDevices' => [ 'shape' => 'DevicePoolCompatibilityResults', ], ], ], 'GetDevicePoolRequest' => [ 'type' => 'structure', 'required' => [ 'arn', ], 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], ], ], 'GetDevicePoolResult' => [ 'type' => 'structure', 'members' => [ 'devicePool' => [ 'shape' => 'DevicePool', ], ], ], 'GetDeviceRequest' => [ 'type' => 'structure', 'required' => [ 'arn', ], 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], ], ], 'GetDeviceResult' => [ 'type' => 'structure', 'members' => [ 'device' => [ 'shape' => 'Device', ], ], ], 'GetInstanceProfileRequest' => [ 'type' => 'structure', 'required' => [ 'arn', ], 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], ], ], 'GetInstanceProfileResult' => [ 'type' => 'structure', 'members' => [ 'instanceProfile' => [ 'shape' => 'InstanceProfile', ], ], ], 'GetJobRequest' => [ 'type' => 'structure', 'required' => [ 'arn', ], 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], ], ], 'GetJobResult' => [ 'type' => 'structure', 'members' => [ 'job' => [ 'shape' => 'Job', ], ], ], 'GetNetworkProfileRequest' => [ 'type' => 'structure', 'required' => [ 'arn', ], 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], ], ], 'GetNetworkProfileResult' => [ 'type' => 'structure', 'members' => [ 'networkProfile' => [ 'shape' => 'NetworkProfile', ], ], ], 'GetOfferingStatusRequest' => [ 'type' => 'structure', 'members' => [ 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'GetOfferingStatusResult' => [ 'type' => 'structure', 'members' => [ 'current' => [ 'shape' => 'OfferingStatusMap', ], 'nextPeriod' => [ 'shape' => 'OfferingStatusMap', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'GetProjectRequest' => [ 'type' => 'structure', 'required' => [ 'arn', ], 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], ], ], 'GetProjectResult' => [ 'type' => 'structure', 'members' => [ 'project' => [ 'shape' => 'Project', ], ], ], 'GetRemoteAccessSessionRequest' => [ 'type' => 'structure', 'required' => [ 'arn', ], 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], ], ], 'GetRemoteAccessSessionResult' => [ 'type' => 'structure', 'members' => [ 'remoteAccessSession' => [ 'shape' => 'RemoteAccessSession', ], ], ], 'GetRunRequest' => [ 'type' => 'structure', 'required' => [ 'arn', ], 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], ], ], 'GetRunResult' => [ 'type' => 'structure', 'members' => [ 'run' => [ 'shape' => 'Run', ], ], ], 'GetSuiteRequest' => [ 'type' => 'structure', 'required' => [ 'arn', ], 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], ], ], 'GetSuiteResult' => [ 'type' => 'structure', 'members' => [ 'suite' => [ 'shape' => 'Suite', ], ], ], 'GetTestRequest' => [ 'type' => 'structure', 'required' => [ 'arn', ], 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], ], ], 'GetTestResult' => [ 'type' => 'structure', 'members' => [ 'test' => [ 'shape' => 'Test', ], ], ], 'GetUploadRequest' => [ 'type' => 'structure', 'required' => [ 'arn', ], 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], ], ], 'GetUploadResult' => [ 'type' => 'structure', 'members' => [ 'upload' => [ 'shape' => 'Upload', ], ], ], 'GetVPCEConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'arn', ], 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], ], ], 'GetVPCEConfigurationResult' => [ 'type' => 'structure', 'members' => [ 'vpceConfiguration' => [ 'shape' => 'VPCEConfiguration', ], ], ], 'HostAddress' => [ 'type' => 'string', 'max' => 1024, ], 'IdempotencyException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'Message', ], ], 'exception' => true, ], 'IncompatibilityMessage' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'Message', ], 'type' => [ 'shape' => 'DeviceAttribute', ], ], ], 'IncompatibilityMessages' => [ 'type' => 'list', 'member' => [ 'shape' => 'IncompatibilityMessage', ], ], 'InstallToRemoteAccessSessionRequest' => [ 'type' => 'structure', 'required' => [ 'remoteAccessSessionArn', 'appArn', ], 'members' => [ 'remoteAccessSessionArn' => [ 'shape' => 'AmazonResourceName', ], 'appArn' => [ 'shape' => 'AmazonResourceName', ], ], ], 'InstallToRemoteAccessSessionResult' => [ 'type' => 'structure', 'members' => [ 'appUpload' => [ 'shape' => 'Upload', ], ], ], 'InstanceLabels' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'InstanceProfile' => [ 'type' => 'structure', 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], 'packageCleanup' => [ 'shape' => 'Boolean', ], 'excludeAppPackagesFromCleanup' => [ 'shape' => 'PackageIds', ], 'rebootAfterUse' => [ 'shape' => 'Boolean', ], 'name' => [ 'shape' => 'Name', ], 'description' => [ 'shape' => 'Message', ], ], ], 'InstanceProfiles' => [ 'type' => 'list', 'member' => [ 'shape' => 'InstanceProfile', ], ], 'InstanceStatus' => [ 'type' => 'string', 'enum' => [ 'IN_USE', 'PREPARING', 'AVAILABLE', 'NOT_AVAILABLE', ], ], 'Integer' => [ 'type' => 'integer', ], 'InteractionMode' => [ 'type' => 'string', 'enum' => [ 'INTERACTIVE', 'NO_VIDEO', 'VIDEO_ONLY', ], 'max' => 64, 'min' => 0, ], 'InvalidOperationException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'Message', ], ], 'exception' => true, ], 'IosPaths' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'Job' => [ 'type' => 'structure', 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], 'name' => [ 'shape' => 'Name', ], 'type' => [ 'shape' => 'TestType', ], 'created' => [ 'shape' => 'DateTime', ], 'status' => [ 'shape' => 'ExecutionStatus', ], 'result' => [ 'shape' => 'ExecutionResult', ], 'started' => [ 'shape' => 'DateTime', ], 'stopped' => [ 'shape' => 'DateTime', ], 'counters' => [ 'shape' => 'Counters', ], 'message' => [ 'shape' => 'Message', ], 'device' => [ 'shape' => 'Device', ], 'instanceArn' => [ 'shape' => 'AmazonResourceName', ], 'deviceMinutes' => [ 'shape' => 'DeviceMinutes', ], 'videoEndpoint' => [ 'shape' => 'String', ], 'videoCapture' => [ 'shape' => 'VideoCapture', ], ], ], 'JobTimeoutMinutes' => [ 'type' => 'integer', ], 'Jobs' => [ 'type' => 'list', 'member' => [ 'shape' => 'Job', ], ], 'LimitExceededException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'Message', ], ], 'exception' => true, ], 'ListArtifactsRequest' => [ 'type' => 'structure', 'required' => [ 'arn', 'type', ], 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], 'type' => [ 'shape' => 'ArtifactCategory', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListArtifactsResult' => [ 'type' => 'structure', 'members' => [ 'artifacts' => [ 'shape' => 'Artifacts', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListDeviceInstancesRequest' => [ 'type' => 'structure', 'members' => [ 'maxResults' => [ 'shape' => 'Integer', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListDeviceInstancesResult' => [ 'type' => 'structure', 'members' => [ 'deviceInstances' => [ 'shape' => 'DeviceInstances', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListDevicePoolsRequest' => [ 'type' => 'structure', 'required' => [ 'arn', ], 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], 'type' => [ 'shape' => 'DevicePoolType', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListDevicePoolsResult' => [ 'type' => 'structure', 'members' => [ 'devicePools' => [ 'shape' => 'DevicePools', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListDevicesRequest' => [ 'type' => 'structure', 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], 'filters' => [ 'shape' => 'DeviceFilters', ], ], ], 'ListDevicesResult' => [ 'type' => 'structure', 'members' => [ 'devices' => [ 'shape' => 'Devices', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListInstanceProfilesRequest' => [ 'type' => 'structure', 'members' => [ 'maxResults' => [ 'shape' => 'Integer', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListInstanceProfilesResult' => [ 'type' => 'structure', 'members' => [ 'instanceProfiles' => [ 'shape' => 'InstanceProfiles', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListJobsRequest' => [ 'type' => 'structure', 'required' => [ 'arn', ], 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListJobsResult' => [ 'type' => 'structure', 'members' => [ 'jobs' => [ 'shape' => 'Jobs', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListNetworkProfilesRequest' => [ 'type' => 'structure', 'required' => [ 'arn', ], 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], 'type' => [ 'shape' => 'NetworkProfileType', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListNetworkProfilesResult' => [ 'type' => 'structure', 'members' => [ 'networkProfiles' => [ 'shape' => 'NetworkProfiles', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListOfferingPromotionsRequest' => [ 'type' => 'structure', 'members' => [ 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListOfferingPromotionsResult' => [ 'type' => 'structure', 'members' => [ 'offeringPromotions' => [ 'shape' => 'OfferingPromotions', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListOfferingTransactionsRequest' => [ 'type' => 'structure', 'members' => [ 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListOfferingTransactionsResult' => [ 'type' => 'structure', 'members' => [ 'offeringTransactions' => [ 'shape' => 'OfferingTransactions', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListOfferingsRequest' => [ 'type' => 'structure', 'members' => [ 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListOfferingsResult' => [ 'type' => 'structure', 'members' => [ 'offerings' => [ 'shape' => 'Offerings', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListProjectsRequest' => [ 'type' => 'structure', 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListProjectsResult' => [ 'type' => 'structure', 'members' => [ 'projects' => [ 'shape' => 'Projects', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListRemoteAccessSessionsRequest' => [ 'type' => 'structure', 'required' => [ 'arn', ], 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListRemoteAccessSessionsResult' => [ 'type' => 'structure', 'members' => [ 'remoteAccessSessions' => [ 'shape' => 'RemoteAccessSessions', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListRunsRequest' => [ 'type' => 'structure', 'required' => [ 'arn', ], 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListRunsResult' => [ 'type' => 'structure', 'members' => [ 'runs' => [ 'shape' => 'Runs', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListSamplesRequest' => [ 'type' => 'structure', 'required' => [ 'arn', ], 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListSamplesResult' => [ 'type' => 'structure', 'members' => [ 'samples' => [ 'shape' => 'Samples', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListSuitesRequest' => [ 'type' => 'structure', 'required' => [ 'arn', ], 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListSuitesResult' => [ 'type' => 'structure', 'members' => [ 'suites' => [ 'shape' => 'Suites', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListTestsRequest' => [ 'type' => 'structure', 'required' => [ 'arn', ], 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListTestsResult' => [ 'type' => 'structure', 'members' => [ 'tests' => [ 'shape' => 'Tests', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListUniqueProblemsRequest' => [ 'type' => 'structure', 'required' => [ 'arn', ], 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListUniqueProblemsResult' => [ 'type' => 'structure', 'members' => [ 'uniqueProblems' => [ 'shape' => 'UniqueProblemsByExecutionResultMap', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListUploadsRequest' => [ 'type' => 'structure', 'required' => [ 'arn', ], 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], 'type' => [ 'shape' => 'UploadType', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListUploadsResult' => [ 'type' => 'structure', 'members' => [ 'uploads' => [ 'shape' => 'Uploads', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListVPCEConfigurationsRequest' => [ 'type' => 'structure', 'members' => [ 'maxResults' => [ 'shape' => 'Integer', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListVPCEConfigurationsResult' => [ 'type' => 'structure', 'members' => [ 'vpceConfigurations' => [ 'shape' => 'VPCEConfigurations', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'Location' => [ 'type' => 'structure', 'required' => [ 'latitude', 'longitude', ], 'members' => [ 'latitude' => [ 'shape' => 'Double', ], 'longitude' => [ 'shape' => 'Double', ], ], ], 'Long' => [ 'type' => 'long', ], 'MaxSlotMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'String', ], 'value' => [ 'shape' => 'Integer', ], ], 'Message' => [ 'type' => 'string', 'max' => 16384, 'min' => 0, ], 'Metadata' => [ 'type' => 'string', 'max' => 8192, 'min' => 0, ], 'MonetaryAmount' => [ 'type' => 'structure', 'members' => [ 'amount' => [ 'shape' => 'Double', ], 'currencyCode' => [ 'shape' => 'CurrencyCode', ], ], ], 'Name' => [ 'type' => 'string', 'max' => 256, 'min' => 0, ], 'NetworkProfile' => [ 'type' => 'structure', 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], 'name' => [ 'shape' => 'Name', ], 'description' => [ 'shape' => 'Message', ], 'type' => [ 'shape' => 'NetworkProfileType', ], 'uplinkBandwidthBits' => [ 'shape' => 'Long', ], 'downlinkBandwidthBits' => [ 'shape' => 'Long', ], 'uplinkDelayMs' => [ 'shape' => 'Long', ], 'downlinkDelayMs' => [ 'shape' => 'Long', ], 'uplinkJitterMs' => [ 'shape' => 'Long', ], 'downlinkJitterMs' => [ 'shape' => 'Long', ], 'uplinkLossPercent' => [ 'shape' => 'PercentInteger', ], 'downlinkLossPercent' => [ 'shape' => 'PercentInteger', ], ], ], 'NetworkProfileType' => [ 'type' => 'string', 'enum' => [ 'CURATED', 'PRIVATE', ], ], 'NetworkProfiles' => [ 'type' => 'list', 'member' => [ 'shape' => 'NetworkProfile', ], ], 'NotEligibleException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'Message', ], ], 'exception' => true, ], 'NotFoundException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'Message', ], ], 'exception' => true, ], 'Offering' => [ 'type' => 'structure', 'members' => [ 'id' => [ 'shape' => 'OfferingIdentifier', ], 'description' => [ 'shape' => 'Message', ], 'type' => [ 'shape' => 'OfferingType', ], 'platform' => [ 'shape' => 'DevicePlatform', ], 'recurringCharges' => [ 'shape' => 'RecurringCharges', ], ], ], 'OfferingIdentifier' => [ 'type' => 'string', 'min' => 32, ], 'OfferingPromotion' => [ 'type' => 'structure', 'members' => [ 'id' => [ 'shape' => 'OfferingPromotionIdentifier', ], 'description' => [ 'shape' => 'Message', ], ], ], 'OfferingPromotionIdentifier' => [ 'type' => 'string', 'min' => 4, ], 'OfferingPromotions' => [ 'type' => 'list', 'member' => [ 'shape' => 'OfferingPromotion', ], ], 'OfferingStatus' => [ 'type' => 'structure', 'members' => [ 'type' => [ 'shape' => 'OfferingTransactionType', ], 'offering' => [ 'shape' => 'Offering', ], 'quantity' => [ 'shape' => 'Integer', ], 'effectiveOn' => [ 'shape' => 'DateTime', ], ], ], 'OfferingStatusMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'OfferingIdentifier', ], 'value' => [ 'shape' => 'OfferingStatus', ], ], 'OfferingTransaction' => [ 'type' => 'structure', 'members' => [ 'offeringStatus' => [ 'shape' => 'OfferingStatus', ], 'transactionId' => [ 'shape' => 'TransactionIdentifier', ], 'offeringPromotionId' => [ 'shape' => 'OfferingPromotionIdentifier', ], 'createdOn' => [ 'shape' => 'DateTime', ], 'cost' => [ 'shape' => 'MonetaryAmount', ], ], ], 'OfferingTransactionType' => [ 'type' => 'string', 'enum' => [ 'PURCHASE', 'RENEW', 'SYSTEM', ], ], 'OfferingTransactions' => [ 'type' => 'list', 'member' => [ 'shape' => 'OfferingTransaction', ], ], 'OfferingType' => [ 'type' => 'string', 'enum' => [ 'RECURRING', ], ], 'Offerings' => [ 'type' => 'list', 'member' => [ 'shape' => 'Offering', ], ], 'PackageIds' => [ 'type' => 'list', 'member' => [ 'shape' => 'String', ], ], 'PaginationToken' => [ 'type' => 'string', 'max' => 1024, 'min' => 4, ], 'PercentInteger' => [ 'type' => 'integer', 'max' => 100, 'min' => 0, ], 'Problem' => [ 'type' => 'structure', 'members' => [ 'run' => [ 'shape' => 'ProblemDetail', ], 'job' => [ 'shape' => 'ProblemDetail', ], 'suite' => [ 'shape' => 'ProblemDetail', ], 'test' => [ 'shape' => 'ProblemDetail', ], 'device' => [ 'shape' => 'Device', ], 'result' => [ 'shape' => 'ExecutionResult', ], 'message' => [ 'shape' => 'Message', ], ], ], 'ProblemDetail' => [ 'type' => 'structure', 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], 'name' => [ 'shape' => 'Name', ], ], ], 'Problems' => [ 'type' => 'list', 'member' => [ 'shape' => 'Problem', ], ], 'Project' => [ 'type' => 'structure', 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], 'name' => [ 'shape' => 'Name', ], 'defaultJobTimeoutMinutes' => [ 'shape' => 'JobTimeoutMinutes', ], 'created' => [ 'shape' => 'DateTime', ], ], ], 'Projects' => [ 'type' => 'list', 'member' => [ 'shape' => 'Project', ], ], 'PurchaseOfferingRequest' => [ 'type' => 'structure', 'members' => [ 'offeringId' => [ 'shape' => 'OfferingIdentifier', ], 'quantity' => [ 'shape' => 'Integer', ], 'offeringPromotionId' => [ 'shape' => 'OfferingPromotionIdentifier', ], ], ], 'PurchaseOfferingResult' => [ 'type' => 'structure', 'members' => [ 'offeringTransaction' => [ 'shape' => 'OfferingTransaction', ], ], ], 'PurchasedDevicesMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'DevicePlatform', ], 'value' => [ 'shape' => 'Integer', ], ], 'Radios' => [ 'type' => 'structure', 'members' => [ 'wifi' => [ 'shape' => 'Boolean', ], 'bluetooth' => [ 'shape' => 'Boolean', ], 'nfc' => [ 'shape' => 'Boolean', ], 'gps' => [ 'shape' => 'Boolean', ], ], ], 'RecurringCharge' => [ 'type' => 'structure', 'members' => [ 'cost' => [ 'shape' => 'MonetaryAmount', ], 'frequency' => [ 'shape' => 'RecurringChargeFrequency', ], ], ], 'RecurringChargeFrequency' => [ 'type' => 'string', 'enum' => [ 'MONTHLY', ], ], 'RecurringCharges' => [ 'type' => 'list', 'member' => [ 'shape' => 'RecurringCharge', ], ], 'RemoteAccessSession' => [ 'type' => 'structure', 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], 'name' => [ 'shape' => 'Name', ], 'created' => [ 'shape' => 'DateTime', ], 'status' => [ 'shape' => 'ExecutionStatus', ], 'result' => [ 'shape' => 'ExecutionResult', ], 'message' => [ 'shape' => 'Message', ], 'started' => [ 'shape' => 'DateTime', ], 'stopped' => [ 'shape' => 'DateTime', ], 'device' => [ 'shape' => 'Device', ], 'instanceArn' => [ 'shape' => 'AmazonResourceName', ], 'remoteDebugEnabled' => [ 'shape' => 'Boolean', ], 'remoteRecordEnabled' => [ 'shape' => 'Boolean', ], 'remoteRecordAppArn' => [ 'shape' => 'AmazonResourceName', ], 'hostAddress' => [ 'shape' => 'HostAddress', ], 'clientId' => [ 'shape' => 'ClientId', ], 'billingMethod' => [ 'shape' => 'BillingMethod', ], 'deviceMinutes' => [ 'shape' => 'DeviceMinutes', ], 'endpoint' => [ 'shape' => 'String', ], 'deviceUdid' => [ 'shape' => 'String', ], 'interactionMode' => [ 'shape' => 'InteractionMode', ], 'skipAppResign' => [ 'shape' => 'SkipAppResign', ], ], ], 'RemoteAccessSessions' => [ 'type' => 'list', 'member' => [ 'shape' => 'RemoteAccessSession', ], ], 'RenewOfferingRequest' => [ 'type' => 'structure', 'members' => [ 'offeringId' => [ 'shape' => 'OfferingIdentifier', ], 'quantity' => [ 'shape' => 'Integer', ], ], ], 'RenewOfferingResult' => [ 'type' => 'structure', 'members' => [ 'offeringTransaction' => [ 'shape' => 'OfferingTransaction', ], ], ], 'Resolution' => [ 'type' => 'structure', 'members' => [ 'width' => [ 'shape' => 'Integer', ], 'height' => [ 'shape' => 'Integer', ], ], ], 'Rule' => [ 'type' => 'structure', 'members' => [ 'attribute' => [ 'shape' => 'DeviceAttribute', ], 'operator' => [ 'shape' => 'RuleOperator', ], 'value' => [ 'shape' => 'String', ], ], ], 'RuleOperator' => [ 'type' => 'string', 'enum' => [ 'EQUALS', 'LESS_THAN', 'GREATER_THAN', 'IN', 'NOT_IN', 'CONTAINS', ], ], 'Rules' => [ 'type' => 'list', 'member' => [ 'shape' => 'Rule', ], ], 'Run' => [ 'type' => 'structure', 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], 'name' => [ 'shape' => 'Name', ], 'type' => [ 'shape' => 'TestType', ], 'platform' => [ 'shape' => 'DevicePlatform', ], 'created' => [ 'shape' => 'DateTime', ], 'status' => [ 'shape' => 'ExecutionStatus', ], 'result' => [ 'shape' => 'ExecutionResult', ], 'started' => [ 'shape' => 'DateTime', ], 'stopped' => [ 'shape' => 'DateTime', ], 'counters' => [ 'shape' => 'Counters', ], 'message' => [ 'shape' => 'Message', ], 'totalJobs' => [ 'shape' => 'Integer', ], 'completedJobs' => [ 'shape' => 'Integer', ], 'billingMethod' => [ 'shape' => 'BillingMethod', ], 'deviceMinutes' => [ 'shape' => 'DeviceMinutes', ], 'networkProfile' => [ 'shape' => 'NetworkProfile', ], 'parsingResultUrl' => [ 'shape' => 'String', ], 'resultCode' => [ 'shape' => 'ExecutionResultCode', ], 'seed' => [ 'shape' => 'Integer', ], 'appUpload' => [ 'shape' => 'AmazonResourceName', ], 'eventCount' => [ 'shape' => 'Integer', ], 'jobTimeoutMinutes' => [ 'shape' => 'JobTimeoutMinutes', ], 'devicePoolArn' => [ 'shape' => 'AmazonResourceName', ], 'locale' => [ 'shape' => 'String', ], 'radios' => [ 'shape' => 'Radios', ], 'location' => [ 'shape' => 'Location', ], 'customerArtifactPaths' => [ 'shape' => 'CustomerArtifactPaths', ], 'webUrl' => [ 'shape' => 'String', ], 'skipAppResign' => [ 'shape' => 'SkipAppResign', ], 'testSpecArn' => [ 'shape' => 'AmazonResourceName', ], 'deviceSelectionResult' => [ 'shape' => 'DeviceSelectionResult', ], ], ], 'Runs' => [ 'type' => 'list', 'member' => [ 'shape' => 'Run', ], ], 'Sample' => [ 'type' => 'structure', 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], 'type' => [ 'shape' => 'SampleType', ], 'url' => [ 'shape' => 'URL', ], ], ], 'SampleType' => [ 'type' => 'string', 'enum' => [ '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', ], ], 'Samples' => [ 'type' => 'list', 'member' => [ 'shape' => 'Sample', ], ], 'ScheduleRunConfiguration' => [ 'type' => 'structure', 'members' => [ 'extraDataPackageArn' => [ 'shape' => 'AmazonResourceName', ], 'networkProfileArn' => [ 'shape' => 'AmazonResourceName', ], 'locale' => [ 'shape' => 'String', ], 'location' => [ 'shape' => 'Location', ], 'vpceConfigurationArns' => [ 'shape' => 'AmazonResourceNames', ], 'customerArtifactPaths' => [ 'shape' => 'CustomerArtifactPaths', ], 'radios' => [ 'shape' => 'Radios', ], 'auxiliaryApps' => [ 'shape' => 'AmazonResourceNames', ], 'billingMethod' => [ 'shape' => 'BillingMethod', ], ], ], 'ScheduleRunRequest' => [ 'type' => 'structure', 'required' => [ 'projectArn', 'test', ], 'members' => [ 'projectArn' => [ 'shape' => 'AmazonResourceName', ], 'appArn' => [ 'shape' => 'AmazonResourceName', ], 'devicePoolArn' => [ 'shape' => 'AmazonResourceName', ], 'deviceSelectionConfiguration' => [ 'shape' => 'DeviceSelectionConfiguration', ], 'name' => [ 'shape' => 'Name', ], 'test' => [ 'shape' => 'ScheduleRunTest', ], 'configuration' => [ 'shape' => 'ScheduleRunConfiguration', ], 'executionConfiguration' => [ 'shape' => 'ExecutionConfiguration', ], ], ], 'ScheduleRunResult' => [ 'type' => 'structure', 'members' => [ 'run' => [ 'shape' => 'Run', ], ], ], 'ScheduleRunTest' => [ 'type' => 'structure', 'required' => [ 'type', ], 'members' => [ 'type' => [ 'shape' => 'TestType', ], 'testPackageArn' => [ 'shape' => 'AmazonResourceName', ], 'testSpecArn' => [ 'shape' => 'AmazonResourceName', ], 'filter' => [ 'shape' => 'Filter', ], 'parameters' => [ 'shape' => 'TestParameters', ], ], ], 'ServiceAccountException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'Message', ], ], 'exception' => true, ], 'ServiceDnsName' => [ 'type' => 'string', 'max' => 2048, 'min' => 0, ], 'SkipAppResign' => [ 'type' => 'boolean', ], 'SshPublicKey' => [ 'type' => 'string', 'max' => 8192, 'min' => 0, ], 'StopJobRequest' => [ 'type' => 'structure', 'required' => [ 'arn', ], 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], ], ], 'StopJobResult' => [ 'type' => 'structure', 'members' => [ 'job' => [ 'shape' => 'Job', ], ], ], 'StopRemoteAccessSessionRequest' => [ 'type' => 'structure', 'required' => [ 'arn', ], 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], ], ], 'StopRemoteAccessSessionResult' => [ 'type' => 'structure', 'members' => [ 'remoteAccessSession' => [ 'shape' => 'RemoteAccessSession', ], ], ], 'StopRunRequest' => [ 'type' => 'structure', 'required' => [ 'arn', ], 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], ], ], 'StopRunResult' => [ 'type' => 'structure', 'members' => [ 'run' => [ 'shape' => 'Run', ], ], ], 'String' => [ 'type' => 'string', ], 'Suite' => [ 'type' => 'structure', 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], 'name' => [ 'shape' => 'Name', ], 'type' => [ 'shape' => 'TestType', ], 'created' => [ 'shape' => 'DateTime', ], 'status' => [ 'shape' => 'ExecutionStatus', ], 'result' => [ 'shape' => 'ExecutionResult', ], 'started' => [ 'shape' => 'DateTime', ], 'stopped' => [ 'shape' => 'DateTime', ], 'counters' => [ 'shape' => 'Counters', ], 'message' => [ 'shape' => 'Message', ], 'deviceMinutes' => [ 'shape' => 'DeviceMinutes', ], ], ], 'Suites' => [ 'type' => 'list', 'member' => [ 'shape' => 'Suite', ], ], 'Test' => [ 'type' => 'structure', 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], 'name' => [ 'shape' => 'Name', ], 'type' => [ 'shape' => 'TestType', ], 'created' => [ 'shape' => 'DateTime', ], 'status' => [ 'shape' => 'ExecutionStatus', ], 'result' => [ 'shape' => 'ExecutionResult', ], 'started' => [ 'shape' => 'DateTime', ], 'stopped' => [ 'shape' => 'DateTime', ], 'counters' => [ 'shape' => 'Counters', ], 'message' => [ 'shape' => 'Message', ], 'deviceMinutes' => [ 'shape' => 'DeviceMinutes', ], ], ], 'TestParameters' => [ 'type' => 'map', 'key' => [ 'shape' => 'String', ], 'value' => [ 'shape' => 'String', ], ], 'TestType' => [ 'type' => 'string', 'enum' => [ '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', ], ], 'Tests' => [ 'type' => 'list', 'member' => [ 'shape' => 'Test', ], ], 'TransactionIdentifier' => [ 'type' => 'string', 'min' => 32, ], 'TrialMinutes' => [ 'type' => 'structure', 'members' => [ 'total' => [ 'shape' => 'Double', ], 'remaining' => [ 'shape' => 'Double', ], ], ], 'URL' => [ 'type' => 'string', 'max' => 2048, 'min' => 0, ], 'UniqueProblem' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'Message', ], 'problems' => [ 'shape' => 'Problems', ], ], ], 'UniqueProblems' => [ 'type' => 'list', 'member' => [ 'shape' => 'UniqueProblem', ], ], 'UniqueProblemsByExecutionResultMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'ExecutionResult', ], 'value' => [ 'shape' => 'UniqueProblems', ], ], 'UpdateDeviceInstanceRequest' => [ 'type' => 'structure', 'required' => [ 'arn', ], 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], 'profileArn' => [ 'shape' => 'AmazonResourceName', ], 'labels' => [ 'shape' => 'InstanceLabels', ], ], ], 'UpdateDeviceInstanceResult' => [ 'type' => 'structure', 'members' => [ 'deviceInstance' => [ 'shape' => 'DeviceInstance', ], ], ], 'UpdateDevicePoolRequest' => [ 'type' => 'structure', 'required' => [ 'arn', ], 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], 'name' => [ 'shape' => 'Name', ], 'description' => [ 'shape' => 'Message', ], 'rules' => [ 'shape' => 'Rules', ], ], ], 'UpdateDevicePoolResult' => [ 'type' => 'structure', 'members' => [ 'devicePool' => [ 'shape' => 'DevicePool', ], ], ], 'UpdateInstanceProfileRequest' => [ 'type' => 'structure', 'required' => [ 'arn', ], 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], 'name' => [ 'shape' => 'Name', ], 'description' => [ 'shape' => 'Message', ], 'packageCleanup' => [ 'shape' => 'Boolean', ], 'excludeAppPackagesFromCleanup' => [ 'shape' => 'PackageIds', ], 'rebootAfterUse' => [ 'shape' => 'Boolean', ], ], ], 'UpdateInstanceProfileResult' => [ 'type' => 'structure', 'members' => [ 'instanceProfile' => [ 'shape' => 'InstanceProfile', ], ], ], 'UpdateNetworkProfileRequest' => [ 'type' => 'structure', 'required' => [ 'arn', ], 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], 'name' => [ 'shape' => 'Name', ], 'description' => [ 'shape' => 'Message', ], 'type' => [ 'shape' => 'NetworkProfileType', ], 'uplinkBandwidthBits' => [ 'shape' => 'Long', ], 'downlinkBandwidthBits' => [ 'shape' => 'Long', ], 'uplinkDelayMs' => [ 'shape' => 'Long', ], 'downlinkDelayMs' => [ 'shape' => 'Long', ], 'uplinkJitterMs' => [ 'shape' => 'Long', ], 'downlinkJitterMs' => [ 'shape' => 'Long', ], 'uplinkLossPercent' => [ 'shape' => 'PercentInteger', ], 'downlinkLossPercent' => [ 'shape' => 'PercentInteger', ], ], ], 'UpdateNetworkProfileResult' => [ 'type' => 'structure', 'members' => [ 'networkProfile' => [ 'shape' => 'NetworkProfile', ], ], ], 'UpdateProjectRequest' => [ 'type' => 'structure', 'required' => [ 'arn', ], 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], 'name' => [ 'shape' => 'Name', ], 'defaultJobTimeoutMinutes' => [ 'shape' => 'JobTimeoutMinutes', ], ], ], 'UpdateProjectResult' => [ 'type' => 'structure', 'members' => [ 'project' => [ 'shape' => 'Project', ], ], ], 'UpdateUploadRequest' => [ 'type' => 'structure', 'required' => [ 'arn', ], 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], 'name' => [ 'shape' => 'Name', ], 'contentType' => [ 'shape' => 'ContentType', ], 'editContent' => [ 'shape' => 'Boolean', ], ], ], 'UpdateUploadResult' => [ 'type' => 'structure', 'members' => [ 'upload' => [ 'shape' => 'Upload', ], ], ], 'UpdateVPCEConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'arn', ], 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], 'vpceConfigurationName' => [ 'shape' => 'VPCEConfigurationName', ], 'vpceServiceName' => [ 'shape' => 'VPCEServiceName', ], 'serviceDnsName' => [ 'shape' => 'ServiceDnsName', ], 'vpceConfigurationDescription' => [ 'shape' => 'VPCEConfigurationDescription', ], ], ], 'UpdateVPCEConfigurationResult' => [ 'type' => 'structure', 'members' => [ 'vpceConfiguration' => [ 'shape' => 'VPCEConfiguration', ], ], ], 'Upload' => [ 'type' => 'structure', 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], 'name' => [ 'shape' => 'Name', ], 'created' => [ 'shape' => 'DateTime', ], 'type' => [ 'shape' => 'UploadType', ], 'status' => [ 'shape' => 'UploadStatus', ], 'url' => [ 'shape' => 'URL', ], 'metadata' => [ 'shape' => 'Metadata', ], 'contentType' => [ 'shape' => 'ContentType', ], 'message' => [ 'shape' => 'Message', ], 'category' => [ 'shape' => 'UploadCategory', ], ], ], 'UploadCategory' => [ 'type' => 'string', 'enum' => [ 'CURATED', 'PRIVATE', ], ], 'UploadStatus' => [ 'type' => 'string', 'enum' => [ 'INITIALIZED', 'PROCESSING', 'SUCCEEDED', 'FAILED', ], ], 'UploadType' => [ 'type' => 'string', 'enum' => [ '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', ], ], 'Uploads' => [ 'type' => 'list', 'member' => [ 'shape' => 'Upload', ], ], 'VPCEConfiguration' => [ 'type' => 'structure', 'members' => [ 'arn' => [ 'shape' => 'AmazonResourceName', ], 'vpceConfigurationName' => [ 'shape' => 'VPCEConfigurationName', ], 'vpceServiceName' => [ 'shape' => 'VPCEServiceName', ], 'serviceDnsName' => [ 'shape' => 'ServiceDnsName', ], 'vpceConfigurationDescription' => [ 'shape' => 'VPCEConfigurationDescription', ], ], ], 'VPCEConfigurationDescription' => [ 'type' => 'string', 'max' => 2048, 'min' => 0, ], 'VPCEConfigurationName' => [ 'type' => 'string', 'max' => 1024, 'min' => 0, ], 'VPCEConfigurations' => [ 'type' => 'list', 'member' => [ 'shape' => 'VPCEConfiguration', ], ], 'VPCEServiceName' => [ 'type' => 'string', 'max' => 2048, 'min' => 0, ], 'VideoCapture' => [ 'type' => 'boolean', ], ],]; diff --git a/src/data/devicefarm/2015-06-23/docs-2.json b/src/data/devicefarm/2015-06-23/docs-2.json index ddcd55b101..9fd7903dc5 100644 --- a/src/data/devicefarm/2015-06-23/docs-2.json +++ b/src/data/devicefarm/2015-06-23/docs-2.json @@ -158,7 +158,7 @@ "ScheduleRunConfiguration$networkProfileArn": "
Reserved for internal use.
", "ScheduleRunRequest$projectArn": "The ARN of the project for the run to be scheduled.
", "ScheduleRunRequest$appArn": "The ARN of the app to schedule a run.
", - "ScheduleRunRequest$devicePoolArn": "The ARN of the device pool for the run to be scheduled.
Either devicePoolArn
or deviceSelectionConfiguration
are required in a request.
The ARN of the device pool for the run to be scheduled.
Either devicePoolArn
or deviceSelectionConfiguration
is required in a request.
The ARN of the uploaded test that will be run.
", "ScheduleRunTest$testSpecArn": "The ARN of the YAML-formatted test specification.
", "StopJobRequest$arn": "Represents the Amazon Resource Name (ARN) of the Device Farm job you wish to stop.
", @@ -218,7 +218,7 @@ "ArtifactType": { "base": null, "refs": { - "Artifact$type": "The artifact's type.
Allowed values include the following:
UNKNOWN: An unknown type.
SCREENSHOT: The screenshot type.
DEVICE_LOG: The device log type.
MESSAGE_LOG: The message log type.
RESULT_LOG: The result log type.
SERVICE_LOG: The service log type.
WEBKIT_LOG: The web kit log type.
INSTRUMENTATION_OUTPUT: The instrumentation type.
EXERCISER_MONKEY_OUTPUT: For Android, the artifact (log) generated by an Android fuzz test.
CALABASH_JSON_OUTPUT: The Calabash JSON output type.
CALABASH_PRETTY_OUTPUT: The Calabash pretty output type.
CALABASH_STANDARD_OUTPUT: The Calabash standard output type.
CALABASH_JAVA_XML_OUTPUT: The Calabash Java XML output type.
AUTOMATION_OUTPUT: The automation output type.
APPIUM_SERVER_OUTPUT: The Appium server output type.
APPIUM_JAVA_OUTPUT: The Appium Java output type.
APPIUM_JAVA_XML_OUTPUT: The Appium Java XML output type.
APPIUM_PYTHON_OUTPUT: The Appium Python output type.
APPIUM_PYTHON_XML_OUTPUT: The Appium Python XML output type.
EXPLORER_EVENT_LOG: The Explorer event log output type.
EXPLORER_SUMMARY_LOG: The Explorer summary log output type.
APPLICATION_CRASH_REPORT: The application crash report output type.
XCTEST_LOG: The XCode test output type.
The artifact's type.
Allowed values include the following:
UNKNOWN: An unknown type.
SCREENSHOT: The screenshot type.
DEVICE_LOG: The device log type.
MESSAGE_LOG: The message log type.
VIDEO_LOG: The video log type.
RESULT_LOG: The result log type.
SERVICE_LOG: The service log type.
WEBKIT_LOG: The web kit log type.
INSTRUMENTATION_OUTPUT: The instrumentation type.
EXERCISER_MONKEY_OUTPUT: For Android, the artifact (log) generated by an Android fuzz test.
CALABASH_JSON_OUTPUT: The Calabash JSON output type.
CALABASH_PRETTY_OUTPUT: The Calabash pretty output type.
CALABASH_STANDARD_OUTPUT: The Calabash standard output type.
CALABASH_JAVA_XML_OUTPUT: The Calabash Java XML output type.
AUTOMATION_OUTPUT: The automation output type.
APPIUM_SERVER_OUTPUT: The Appium server output type.
APPIUM_JAVA_OUTPUT: The Appium Java output type.
APPIUM_JAVA_XML_OUTPUT: The Appium Java XML output type.
APPIUM_PYTHON_OUTPUT: The Appium Python output type.
APPIUM_PYTHON_XML_OUTPUT: The Appium Python XML output type.
EXPLORER_EVENT_LOG: The Explorer event log output type.
EXPLORER_SUMMARY_LOG: The Explorer summary log output type.
APPLICATION_CRASH_REPORT: The application crash report output type.
XCTEST_LOG: The XCode test output type.
VIDEO: The Video output type.
CUSTOMER_ARTIFACT:The Customer Artifact output type.
CUSTOMER_ARTIFACT_LOG: The Customer Artifact Log output type.
TESTSPEC_OUTPUT: The Test Spec Output type.
The type of incompatibility.
Allowed values include:
ARN: The ARN.
FORM_FACTOR: The form factor (for example, phone or tablet).
MANUFACTURER: The manufacturer.
PLATFORM: The platform (for example, Android or iOS).
REMOTE_ACCESS_ENABLED: Whether the device is enabled for remote access.
APPIUM_VERSION: The Appium version for the test.
The rule's attribute. It is the aspect of a device such as platform or model used as selection criteria to create or update a device pool.
Allowed values include:
ARN: The Amazon Resource Name (ARN) of a device. For example, \"arn:aws:devicefarm:us-west-2::device:12345Example\".
PLATFORM: The device platform. Valid values are \"ANDROID\" or \"IOS\".
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.
REMOTE_DEBUG_ENABLED: Whether the device is enabled for remote debugging.
APPIUM_VERSION: The Appium version for the test.
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\".
The rule's attribute. It is the aspect of a device such as platform or model used as selection criteria to create or update a device pool.
Allowed values include:
ARN: The Amazon Resource Name (ARN) of a device. For example, \"arn:aws:devicefarm:us-west-2::device:12345Example\".
PLATFORM: The device platform. Valid values are \"ANDROID\" or \"IOS\".
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 values are \"TRUE\" or \"FALSE\".
APPIUM_VERSION: The Appium version for the test.
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\".
Reflects how likely a device will be available for a test run.
" + "Device$availability": "Reflects how likely a device will be available for a test run. It is currently available in the ListDevices and GetDevice API methods.
" } }, "DeviceFilter": { - "base": "Represents a device filter used to select a set of devices to be included in a test run. This data structure is passed in as the \"deviceSelectionConfiguration\" parameter to ScheduleRun. For an example of the JSON request syntax, see ScheduleRun.
It is also passed in as the \"filters\" parameter to ListDevices. For an example of the JSON request syntax, see ListDevices.
", + "base": "Represents a device filter used to select a set of devices to be included in a test run. This data structure is passed in as the deviceSelectionConfiguration
parameter to ScheduleRun. For an example of the JSON request syntax, see ScheduleRun.
It is also passed in as the filters
parameter to ListDevices. For an example of the JSON request syntax, see ListDevices.
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.
REMOTE_DEBUG_ENABLED: Whether the device is enabled for remote debugging.
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\".
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 values are \"TRUE\" or \"FALSE\".
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\".
An array of one or more filter values used in a device filter.
Operator Values
The IN and NOT 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\".
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\".
Used to dynamically select a set of devices for a test run. A filter is made up of an attribute, an operator, 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.
REMOTE_DEBUG_ENABLED: Whether the device is enabled for remote debugging.
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 operators can take a values array that has more than one element.
The other operators require an array with a single element.
In a request, the AVAILABILITY attribute takes \"AVAILABLE\", \"HIGHLY_AVAILABLE\", \"BUSY\", or \"TEMPORARY_NOT_AVAILABLE\" as values.
Used to dynamically select a set of devices for a test run. A filter is made up of an attribute, an operator, 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 are \"TRUE\" or \"FALSE\".
REMOTE_DEBUG_ENABLED: Whether the device is enabled for remote debugging. Valid values are \"TRUE\" or \"FALSE\".
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.
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\".
The filters in a device selection result.
", - "ListDevicesRequest$filters": "Used to select a set of devices. A filter is made up of an attribute, an operator, and one or more values.
Attribute: The aspect of a device such as platform or model used as the selction 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.
REMOTE_DEBUG_ENABLED: Whether the device is enabled for remote debugging.
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 operators can take a values array that has more than one element.
The other operators require an array with a single element.
In a request, the AVAILABILITY attribute takes \"AVAILABLE\", \"HIGHLY_AVAILABLE\", \"BUSY\", or \"TEMPORARY_NOT_AVAILABLE\" as values.
Used to select a set of devices. A filter is made up of an attribute, an operator, and one or more values.
Attribute: The aspect of a device such as platform or model used as the selction 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 values are \"TRUE\" or \"FALSE\".
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 \"AVAILABLE\", \"HIGHLY_AVAILABLE\", \"BUSY\", or \"TEMPORARY_NOT_AVAILABLE\" as values.
Represents the device filters used in a test run as well as the maximum number of devices to be included in the run. It is passed in as the deviceSelectionConfiguration request parameter in ScheduleRun.
", + "base": "Represents the device filters used in a test run as well as the maximum number of devices to be included in the run. It is passed in as the deviceSelectionConfiguration
request parameter in ScheduleRun.
The filter criteria used to dynamically select a set of devices for a test run, as well as the maximum number of devices to be included in the run.
Either devicePoolArn
or deviceSelectionConfiguration
are required in a request.
The filter criteria used to dynamically select a set of devices for a test run, as well as the maximum number of devices to be included in the run.
Either devicePoolArn
or deviceSelectionConfiguration
is required in a request.
Represents test settings. This data structure is passed in as the \"test\" parameter to ScheduleRun. For an example of the JSON request syntax, see ScheduleRun.
", + "base": "Represents test settings. This data structure is passed in as the test
parameter to ScheduleRun. For an example of the JSON request syntax, see ScheduleRun.
Information about the uploaded test to be run against the device pool.
", "ScheduleRunRequest$test": "Information about the test for the run to be scheduled.
" @@ -1778,18 +1778,18 @@ "TestParameters": { "base": null, "refs": { - "ScheduleRunTest$parameters": "The test's parameters, such as test framework parameters and fixture settings. Parameters are represented 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.7.2\", \"1.7.1\", \"1.6.5\", \"latest\", and \"default\".
“latest” will run the latest Appium version supported by Device Farm (1.7.2).
For “default”, Device Farm will choose 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, 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 username to use if the Explorer encounters a login form. If not supplied, no username will be inserted.
password: A password to use if the Explorer encounters a login form. If not supplied, no password will be 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\"
The test's parameters, such as test framework parameters and fixture settings. Parameters are represented 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 higher), \"latest\", and \"default\".
“latest” will run the latest Appium version supported by Device Farm (1.9.1).
For “default”, Device Farm will choose 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, 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 username to use if the Explorer encounters a login form. If not supplied, no username will be inserted.
password: A password to use if the Explorer encounters a login form. If not supplied, no password will be 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\"
The test type for the specified device pool.
Allowed values include the following:
BUILTIN_FUZZ: The built-in fuzz type.
BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time.
APPIUM_JAVA_JUNIT: The Appium Java JUnit type.
APPIUM_JAVA_TESTNG: The Appium Java TestNG type.
APPIUM_PYTHON: The Appium Python type.
APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for Web apps.
APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for Web apps.
APPIUM_WEB_PYTHON: The Appium Python type for Web apps.
CALABASH: The Calabash type.
INSTRUMENTATION: The Instrumentation type.
UIAUTOMATION: The uiautomation type.
UIAUTOMATOR: The uiautomator type.
XCTEST: The XCode test type.
XCTEST_UI: The XCode UI test type.
The job's type.
Allowed values include the following:
BUILTIN_FUZZ: The built-in fuzz type.
BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time.
APPIUM_JAVA_JUNIT: The Appium Java JUnit type.
APPIUM_JAVA_TESTNG: The Appium Java TestNG type.
APPIUM_PYTHON: The Appium Python type.
APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for Web apps.
APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for Web apps.
APPIUM_WEB_PYTHON: The Appium Python type for Web apps.
CALABASH: The Calabash type.
INSTRUMENTATION: The Instrumentation type.
UIAUTOMATION: The uiautomation type.
UIAUTOMATOR: The uiautomator type.
XCTEST: The XCode test type.
XCTEST_UI: The XCode UI test type.
The run's type.
Must be one of the following values:
BUILTIN_FUZZ: The built-in fuzz type.
BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time.
APPIUM_JAVA_JUNIT: The Appium Java JUnit type.
APPIUM_JAVA_TESTNG: The Appium Java TestNG type.
APPIUM_PYTHON: The Appium Python type.
APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for Web apps.
APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for Web apps.
APPIUM_WEB_PYTHON: The Appium Python type for Web apps.
CALABASH: The Calabash type.
INSTRUMENTATION: The Instrumentation type.
UIAUTOMATION: The uiautomation type.
UIAUTOMATOR: The uiautomator type.
XCTEST: The XCode test type.
XCTEST_UI: The XCode UI test type.
The test's type.
Must be one of the following values:
BUILTIN_FUZZ: The built-in fuzz type.
BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time.
APPIUM_JAVA_JUNIT: The Appium Java JUnit type.
APPIUM_JAVA_TESTNG: The Appium Java TestNG type.
APPIUM_PYTHON: The Appium Python type.
APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for Web apps.
APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for Web apps.
APPIUM_WEB_PYTHON: The Appium Python type for Web apps.
CALABASH: The Calabash type.
INSTRUMENTATION: The Instrumentation type.
UIAUTOMATION: The uiautomation type.
UIAUTOMATOR: The uiautomator type.
XCTEST: The XCode test type.
XCTEST_UI: The XCode UI test type.
The suite's type.
Must be one of the following values:
BUILTIN_FUZZ: The built-in fuzz type.
BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time.
APPIUM_JAVA_JUNIT: The Appium Java JUnit type.
APPIUM_JAVA_TESTNG: The Appium Java TestNG type.
APPIUM_PYTHON: The Appium Python type.
APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for Web apps.
APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for Web apps.
APPIUM_WEB_PYTHON: The Appium Python type for Web apps.
CALABASH: The Calabash type.
INSTRUMENTATION: The Instrumentation type.
UIAUTOMATION: The uiautomation type.
UIAUTOMATOR: The uiautomator type.
XCTEST: The XCode test type.
XCTEST_UI: The XCode UI test type.
The test's type.
Must be one of the following values:
BUILTIN_FUZZ: The built-in fuzz type.
BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time.
APPIUM_JAVA_JUNIT: The Appium Java JUnit type.
APPIUM_JAVA_TESTNG: The Appium Java TestNG type.
APPIUM_PYTHON: The Appium Python type.
APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for Web apps.
APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for Web apps.
APPIUM_WEB_PYTHON: The Appium Python type for Web apps.
CALABASH: The Calabash type.
INSTRUMENTATION: The Instrumentation type.
UIAUTOMATION: The uiautomation type.
UIAUTOMATOR: The uiautomator type.
XCTEST: The XCode test type.
XCTEST_UI: The XCode UI test type.
The test type for the specified device pool.
Allowed values include the following:
BUILTIN_FUZZ: The built-in fuzz type.
BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time.
APPIUM_JAVA_JUNIT: The Appium Java JUnit type.
APPIUM_JAVA_TESTNG: The Appium Java TestNG type.
APPIUM_PYTHON: The Appium Python type.
APPIUM_NODE: The Appium Node.js type.
APPIUM_RUBY: The Appium Ruby type.
APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for web apps.
APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for web apps.
APPIUM_WEB_PYTHON: The Appium Python type for web apps.
APPIUM_WEB_NODE: The Appium Node.js type for web apps.
APPIUM_WEB_RUBY: The Appium Ruby type for web apps.
CALABASH: The Calabash type.
INSTRUMENTATION: The Instrumentation type.
UIAUTOMATION: The uiautomation type.
UIAUTOMATOR: The uiautomator type.
XCTEST: The XCode test type.
XCTEST_UI: The XCode UI test type.
The job's type.
Allowed values include the following:
BUILTIN_FUZZ: The built-in fuzz type.
BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time.
APPIUM_JAVA_JUNIT: The Appium Java JUnit type.
APPIUM_JAVA_TESTNG: The Appium Java TestNG type.
APPIUM_PYTHON: The Appium Python type.
APPIUM_NODE: The Appium Node.js type.
APPIUM_RUBY: The Appium Ruby type.
APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for web apps.
APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for web apps.
APPIUM_WEB_PYTHON: The Appium Python type for web apps.
APPIUM_WEB_NODE: The Appium Node.js type for web apps.
APPIUM_WEB_RUBY: The Appium Ruby test type for web apps.
CALABASH: The Calabash type.
INSTRUMENTATION: The Instrumentation type.
UIAUTOMATION: The uiautomation type.
UIAUTOMATOR: The uiautomator type.
XCTEST: The XCode test type.
XCTEST_UI: The XCode UI test type.
The run's type.
Must be one of the following values:
BUILTIN_FUZZ: The built-in fuzz type.
BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time.
APPIUM_JAVA_JUNIT: The Appium Java JUnit type.
APPIUM_JAVA_TESTNG: The Appium Java TestNG type.
APPIUM_PYTHON: The Appium Python type.
APPIUM_NODE: The Appium Node.js type.
APPIUM_RUBY: The Appium Ruby type.
APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for web apps.
APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for web apps.
APPIUM_WEB_PYTHON: The Appium Python type for web apps.
APPIUM_WEB_NODE: The Appium Node.js type for web apps.
APPIUM_WEB_RUBY: The Appium Ruby type for web apps.
CALABASH: The Calabash type.
INSTRUMENTATION: The Instrumentation type.
UIAUTOMATION: The uiautomation type.
UIAUTOMATOR: The uiautomator type.
XCTEST: The XCode test type.
XCTEST_UI: The XCode UI test type.
The test's type.
Must be one of the following values:
BUILTIN_FUZZ: The built-in fuzz type.
BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time.
APPIUM_JAVA_JUNIT: The Appium Java JUnit type.
APPIUM_JAVA_TESTNG: The Appium Java TestNG type.
APPIUM_PYTHON: The Appium Python type.
APPIUM_NODE: The Appium Node.js type.
APPIUM_RUBY: The Appium Ruby type.
APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for web apps.
APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for web apps.
APPIUM_WEB_PYTHON: The Appium Python type for web apps.
APPIUM_WEB_NODE: The Appium Node.js type for web apps.
APPIUM_WEB_RUBY: The Appium Ruby type for web apps.
CALABASH: The Calabash type.
INSTRUMENTATION: The Instrumentation type.
UIAUTOMATION: The uiautomation type.
UIAUTOMATOR: The uiautomator type.
XCTEST: The XCode test type.
XCTEST_UI: The XCode UI test type.
The suite's type.
Must be one of the following values:
BUILTIN_FUZZ: The built-in fuzz type.
BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time.
APPIUM_JAVA_JUNIT: The Appium Java JUnit type.
APPIUM_JAVA_TESTNG: The Appium Java TestNG type.
APPIUM_PYTHON: The Appium Python type.
APPIUM_NODE: The Appium Node.js type.
APPIUM_RUBY: The Appium Ruby type.
APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for web apps.
APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for web apps.
APPIUM_WEB_PYTHON: The Appium Python type for web apps.
APPIUM_WEB_NODE: The Appium Node.js type for web apps.
APPIUM_WEB_RUBY: The Appium Ruby type for web apps.
CALABASH: The Calabash type.
INSTRUMENTATION: The Instrumentation type.
UIAUTOMATION: The uiautomation type.
UIAUTOMATOR: The uiautomator type.
XCTEST: The XCode test type.
XCTEST_UI: The XCode UI test type.
The test's type.
Must be one of the following values:
BUILTIN_FUZZ: The built-in fuzz type.
BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time.
APPIUM_JAVA_JUNIT: The Appium Java JUnit type.
APPIUM_JAVA_TESTNG: The Appium Java TestNG type.
APPIUM_PYTHON: The Appium Python type.
APPIUM_NODE: The Appium Node.js type.
APPIUM_RUBY: The Appium Ruby type.
APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for web apps.
APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for web apps.
APPIUM_WEB_PYTHON: The Appium Python type for web apps.
APPIUM_WEB_NODE: The Appium Node.js type for web apps.
APPIUM_WEB_RUBY: The Appium Ruby type for web apps.
CALABASH: The Calabash type.
INSTRUMENTATION: The Instrumentation type.
UIAUTOMATION: The uiautomation type.
UIAUTOMATOR: The uiautomator type.
XCTEST: The XCode test type.
XCTEST_UI: The XCode UI test type.
The upload's upload type.
Must be one of the following values:
ANDROID_APP: An Android upload.
IOS_APP: An iOS upload.
WEB_APP: A web application upload.
EXTERNAL_DATA: An external data upload.
APPIUM_JAVA_JUNIT_TEST_PACKAGE: An Appium Java JUnit test package upload.
APPIUM_JAVA_TESTNG_TEST_PACKAGE: An Appium Java TestNG test package upload.
APPIUM_PYTHON_TEST_PACKAGE: An Appium Python test package upload.
APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE: An Appium Java JUnit test package upload.
APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE: An Appium Java TestNG test package upload.
APPIUM_WEB_PYTHON_TEST_PACKAGE: An Appium Python test package upload.
CALABASH_TEST_PACKAGE: A Calabash test package upload.
INSTRUMENTATION_TEST_PACKAGE: An instrumentation upload.
UIAUTOMATION_TEST_PACKAGE: A uiautomation test package upload.
UIAUTOMATOR_TEST_PACKAGE: A uiautomator test package upload.
XCTEST_TEST_PACKAGE: An XCode test package upload.
XCTEST_UI_TEST_PACKAGE: An XCode UI test package upload.
APPIUM_JAVA_JUNIT_TEST_SPEC: An Appium Java JUnit test spec upload.
APPIUM_JAVA_TESTNG_TEST_SPEC: An Appium Java TestNG test spec upload.
APPIUM_PYTHON_TEST_SPEC: An Appium Python test spec upload.
APPIUM_WEB_JAVA_JUNIT_TEST_SPEC: An Appium Java JUnit test spec upload.
APPIUM_WEB_JAVA_TESTNG_TEST_SPEC: An Appium Java TestNG test spec upload.
APPIUM_WEB_PYTHON_TEST_SPEC: An Appium Python test spec upload.
INSTRUMENTATION_TEST_SPEC: An instrumentation test spec upload.
XCTEST_UI_TEST_SPEC: An XCode UI test spec upload.
Note If you call CreateUpload
with WEB_APP
specified, AWS Device Farm throws an ArgumentException
error.
The type of upload.
Must be one of the following values:
ANDROID_APP: An Android upload.
IOS_APP: An iOS upload.
WEB_APP: A web appliction upload.
EXTERNAL_DATA: An external data upload.
APPIUM_JAVA_JUNIT_TEST_PACKAGE: An Appium Java JUnit test package upload.
APPIUM_JAVA_TESTNG_TEST_PACKAGE: An Appium Java TestNG test package upload.
APPIUM_PYTHON_TEST_PACKAGE: An Appium Python test package upload.
APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE: An Appium Java JUnit test package upload.
APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE: An Appium Java TestNG test package upload.
APPIUM_WEB_PYTHON_TEST_PACKAGE: An Appium Python test package upload.
CALABASH_TEST_PACKAGE: A Calabash test package upload.
INSTRUMENTATION_TEST_PACKAGE: An instrumentation upload.
UIAUTOMATION_TEST_PACKAGE: A uiautomation test package upload.
UIAUTOMATOR_TEST_PACKAGE: A uiautomator test package upload.
XCTEST_TEST_PACKAGE: An XCode test package upload.
XCTEST_UI_TEST_PACKAGE: An XCode UI test package upload.
APPIUM_JAVA_JUNIT_TEST_SPEC: An Appium Java JUnit test spec upload.
APPIUM_JAVA_TESTNG_TEST_SPEC: An Appium Java TestNG test spec upload.
APPIUM_PYTHON_TEST_SPEC: An Appium Python test spec upload.
APPIUM_WEB_JAVA_JUNIT_TEST_SPEC: An Appium Java JUnit test spec upload.
APPIUM_WEB_JAVA_TESTNG_TEST_SPEC: An Appium Java TestNG test spec upload.
APPIUM_WEB_PYTHON_TEST_SPEC: An Appium Python test spec upload.
INSTRUMENTATION_TEST_SPEC: An instrumentation test spec upload.
XCTEST_UI_TEST_SPEC: An XCode UI test spec upload.
The upload's type.
Must be one of the following values:
ANDROID_APP: An Android upload.
IOS_APP: An iOS upload.
WEB_APP: A web appliction upload.
EXTERNAL_DATA: An external data upload.
APPIUM_JAVA_JUNIT_TEST_PACKAGE: An Appium Java JUnit test package upload.
APPIUM_JAVA_TESTNG_TEST_PACKAGE: An Appium Java TestNG test package upload.
APPIUM_PYTHON_TEST_PACKAGE: An Appium Python test package upload.
APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE: An Appium Java JUnit test package upload.
APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE: An Appium Java TestNG test package upload.
APPIUM_WEB_PYTHON_TEST_PACKAGE: An Appium Python test package upload.
CALABASH_TEST_PACKAGE: A Calabash test package upload.
INSTRUMENTATION_TEST_PACKAGE: An instrumentation upload.
UIAUTOMATION_TEST_PACKAGE: A uiautomation test package upload.
UIAUTOMATOR_TEST_PACKAGE: A uiautomator test package upload.
XCTEST_TEST_PACKAGE: An XCode test package upload.
XCTEST_UI_TEST_PACKAGE: An XCode UI test package upload.
APPIUM_JAVA_JUNIT_TEST_SPEC: An Appium Java JUnit test spec upload.
APPIUM_JAVA_TESTNG_TEST_SPEC: An Appium Java TestNG test spec upload.
APPIUM_PYTHON_TEST_SPEC: An Appium Python test spec upload.
APPIUM_WEB_JAVA_JUNIT_TEST_SPEC: An Appium Java JUnit test spec upload.
APPIUM_WEB_JAVA_TESTNG_TEST_SPEC: An Appium Java TestNG test spec upload.
APPIUM_WEB_PYTHON_TEST_SPEC: An Appium Python test spec upload.
INSTRUMENTATION_TEST_SPEC: An instrumentation test spec upload.
XCTEST_UI_TEST_SPEC: An XCode UI test spec upload.
The upload's upload type.
Must be one of the following values:
ANDROID_APP: An Android upload.
IOS_APP: An iOS upload.
WEB_APP: A web application upload.
EXTERNAL_DATA: An external data upload.
APPIUM_JAVA_JUNIT_TEST_PACKAGE: An Appium Java JUnit test package upload.
APPIUM_JAVA_TESTNG_TEST_PACKAGE: An Appium Java TestNG test package upload.
APPIUM_PYTHON_TEST_PACKAGE: An Appium Python test package upload.
APPIUM_NODE_TEST_PACKAGE: An Appium Node.js test package upload.
APPIUM_RUBY_TEST_PACKAGE: An Appium Ruby test package upload.
APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE: An Appium Java JUnit test package upload for a web app.
APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE: An Appium Java TestNG test package upload for a web app.
APPIUM_WEB_PYTHON_TEST_PACKAGE: An Appium Python test package upload for a web app.
APPIUM_WEB_NODE_TEST_PACKAGE: An Appium Node.js test package upload for a web app.
APPIUM_WEB_RUBY_TEST_PACKAGE: An Appium Ruby test package upload for a web app.
CALABASH_TEST_PACKAGE: A Calabash test package upload.
INSTRUMENTATION_TEST_PACKAGE: An instrumentation upload.
UIAUTOMATION_TEST_PACKAGE: A uiautomation test package upload.
UIAUTOMATOR_TEST_PACKAGE: A uiautomator test package upload.
XCTEST_TEST_PACKAGE: An XCode test package upload.
XCTEST_UI_TEST_PACKAGE: An XCode UI test package upload.
APPIUM_JAVA_JUNIT_TEST_SPEC: An Appium Java JUnit test spec upload.
APPIUM_JAVA_TESTNG_TEST_SPEC: An Appium Java TestNG test spec upload.
APPIUM_PYTHON_TEST_SPEC: An Appium Python test spec upload.
APPIUM_NODE_TEST_SPEC: An Appium Node.js test spec upload.
APPIUM_RUBY_TEST_SPEC: An Appium Ruby test spec upload.
APPIUM_WEB_JAVA_JUNIT_TEST_SPEC: An Appium Java JUnit test spec upload for a web app.
APPIUM_WEB_JAVA_TESTNG_TEST_SPEC: An Appium Java TestNG test spec upload for a web app.
APPIUM_WEB_PYTHON_TEST_SPEC: An Appium Python test spec upload for a web app.
APPIUM_WEB_NODE_TEST_SPEC: An Appium Node.js test spec upload for a web app.
APPIUM_WEB_RUBY_TEST_SPEC: An Appium Ruby test spec upload for a web app.
INSTRUMENTATION_TEST_SPEC: An instrumentation test spec upload.
XCTEST_UI_TEST_SPEC: An XCode UI test spec upload.
Note If you call CreateUpload
with WEB_APP
specified, AWS Device Farm throws an ArgumentException
error.
The type of upload.
Must be one of the following values:
ANDROID_APP: An Android upload.
IOS_APP: An iOS upload.
WEB_APP: A web appliction upload.
EXTERNAL_DATA: An external data upload.
APPIUM_JAVA_JUNIT_TEST_PACKAGE: An Appium Java JUnit test package upload.
APPIUM_JAVA_TESTNG_TEST_PACKAGE: An Appium Java TestNG test package upload.
APPIUM_PYTHON_TEST_PACKAGE: An Appium Python test package upload.
APPIUM_NODE_TEST_PACKAGE: An Appium Node.js test package upload.
APPIUM_RUBY_TEST_PACKAGE: An Appium Ruby test package upload.
APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE: An Appium Java JUnit test package upload for a web app.
APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE: An Appium Java TestNG test package upload for a web app.
APPIUM_WEB_PYTHON_TEST_PACKAGE: An Appium Python test package upload for a web app.
APPIUM_WEB_NODE_TEST_PACKAGE: An Appium Node.js test package upload for a web app.
APPIUM_WEB_RUBY_TEST_PACKAGE: An Appium Ruby test package upload for a web app.
CALABASH_TEST_PACKAGE: A Calabash test package upload.
INSTRUMENTATION_TEST_PACKAGE: An instrumentation upload.
UIAUTOMATION_TEST_PACKAGE: A uiautomation test package upload.
UIAUTOMATOR_TEST_PACKAGE: A uiautomator test package upload.
XCTEST_TEST_PACKAGE: An XCode test package upload.
XCTEST_UI_TEST_PACKAGE: An XCode UI test package upload.
APPIUM_JAVA_JUNIT_TEST_SPEC: An Appium Java JUnit test spec upload.
APPIUM_JAVA_TESTNG_TEST_SPEC: An Appium Java TestNG test spec upload.
APPIUM_PYTHON_TEST_SPEC: An Appium Python test spec upload.
APPIUM_NODE_TEST_SPEC: An Appium Node.js test spec upload.
APPIUM_RUBY_TEST_SPEC: An Appium Ruby test spec upload.
APPIUM_WEB_JAVA_JUNIT_TEST_SPEC: An Appium Java JUnit test spec upload for a web app.
APPIUM_WEB_JAVA_TESTNG_TEST_SPEC: An Appium Java TestNG test spec upload for a web app.
APPIUM_WEB_PYTHON_TEST_SPEC: An Appium Python test spec upload for a web app.
APPIUM_WEB_NODE_TEST_SPEC: An Appium Node.js test spec upload for a web app.
APPIUM_WEB_RUBY_TEST_SPEC: An Appium Ruby test spec upload for a web app.
INSTRUMENTATION_TEST_SPEC: An instrumentation test spec upload.
XCTEST_UI_TEST_SPEC: An XCode UI test spec upload.
The upload's type.
Must be one of the following values:
ANDROID_APP: An Android upload.
IOS_APP: An iOS upload.
WEB_APP: A web appliction upload.
EXTERNAL_DATA: An external data upload.
APPIUM_JAVA_JUNIT_TEST_PACKAGE: An Appium Java JUnit test package upload.
APPIUM_JAVA_TESTNG_TEST_PACKAGE: An Appium Java TestNG test package upload.
APPIUM_PYTHON_TEST_PACKAGE: An Appium Python test package upload.
APPIUM_NODE_TEST_PACKAGE: An Appium Node.js test package upload.
APPIUM_RUBY_TEST_PACKAGE: An Appium Ruby test package upload.
APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE: An Appium Java JUnit test package upload for web apps.
APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE: An Appium Java TestNG test package upload for web apps.
APPIUM_WEB_PYTHON_TEST_PACKAGE: An Appium Python test package upload for web apps.
APPIUM_WEB_NODE_TEST_PACKAGE: An Appium Node.js test package upload for web apps.
APPIUM_WEB_RUBY_TEST_PACKAGE: An Appium Ruby test package upload for web apps.
CALABASH_TEST_PACKAGE: A Calabash test package upload.
INSTRUMENTATION_TEST_PACKAGE: An instrumentation upload.
UIAUTOMATION_TEST_PACKAGE: A uiautomation test package upload.
UIAUTOMATOR_TEST_PACKAGE: A uiautomator test package upload.
XCTEST_TEST_PACKAGE: An XCode test package upload.
XCTEST_UI_TEST_PACKAGE: An XCode UI test package upload.
APPIUM_JAVA_JUNIT_TEST_SPEC: An Appium Java JUnit test spec upload.
APPIUM_JAVA_TESTNG_TEST_SPEC: An Appium Java TestNG test spec upload.
APPIUM_PYTHON_TEST_SPEC: An Appium Python test spec upload.
APPIUM_NODE_TEST_SPEC: An Appium Node.js test spec upload.
APPIUM_RUBY_TEST_SPEC: An Appium Ruby test spec upload.
APPIUM_WEB_JAVA_JUNIT_TEST_SPEC: An Appium Java JUnit test spec upload for a web app.
APPIUM_WEB_JAVA_TESTNG_TEST_SPEC: An Appium Java TestNG test spec upload for a web app.
APPIUM_WEB_PYTHON_TEST_SPEC: An Appium Python test spec upload for a web app.
APPIUM_WEB_NODE_TEST_SPEC: An Appium Node.js test spec upload for a web app.
APPIUM_WEB_RUBY_TEST_SPEC: An Appium Ruby test spec upload for a web app.
INSTRUMENTATION_TEST_SPEC: An instrumentation test spec upload.
XCTEST_UI_TEST_SPEC: An XCode UI test spec upload.
AWS Device Farm is a service that enables mobile app developers to test Android, iOS, and Fire OS apps on physical phones, tablets, and other devices in the cloud.
', 'operations' => [ 'CreateDevicePool' => 'Creates a device pool.
', 'CreateInstanceProfile' => 'Creates a profile that can be applied to one or more private fleet device instances.
', 'CreateNetworkProfile' => 'Creates a network profile.
', 'CreateProject' => 'Creates a new project.
', 'CreateRemoteAccessSession' => 'Specifies and starts a remote access session.
', 'CreateUpload' => 'Uploads an app or test scripts.
', 'CreateVPCEConfiguration' => 'Creates a configuration record in Device Farm for your Amazon Virtual Private Cloud (VPC) endpoint.
', 'DeleteDevicePool' => 'Deletes a device pool given the pool ARN. Does not allow deletion of curated pools owned by the system.
', 'DeleteInstanceProfile' => 'Deletes a profile that can be applied to one or more private device instances.
', 'DeleteNetworkProfile' => 'Deletes a network profile.
', 'DeleteProject' => 'Deletes an AWS Device Farm project, given the project ARN.
Note Deleting this resource does not stop an in-progress run.
', 'DeleteRemoteAccessSession' => 'Deletes a completed remote access session and its results.
', 'DeleteRun' => 'Deletes the run, given the run ARN.
Note Deleting this resource does not stop an in-progress run.
', 'DeleteUpload' => 'Deletes an upload given the upload ARN.
', 'DeleteVPCEConfiguration' => 'Deletes a configuration for your Amazon Virtual Private Cloud (VPC) endpoint.
', 'GetAccountSettings' => 'Returns the number of unmetered iOS and/or unmetered Android devices that have been purchased by the account.
', 'GetDevice' => 'Gets information about a unique device type.
', 'GetDeviceInstance' => 'Returns information about a device instance belonging to a private device fleet.
', 'GetDevicePool' => 'Gets information about a device pool.
', 'GetDevicePoolCompatibility' => 'Gets information about compatibility with a device pool.
', 'GetInstanceProfile' => 'Returns information about the specified instance profile.
', 'GetJob' => 'Gets information about a job.
', 'GetNetworkProfile' => 'Returns information about a network profile.
', 'GetOfferingStatus' => 'Gets the current status and future status of all offerings purchased by an AWS account. The response indicates how many offerings are currently available and the offerings that will be available in the next period. The API returns a NotEligible
error if the user is not permitted to invoke the operation. Please contact aws-devicefarm-support@amazon.com if you believe that you should be able to invoke this operation.
Gets information about a project.
', 'GetRemoteAccessSession' => 'Returns a link to a currently running remote access session.
', 'GetRun' => 'Gets information about a run.
', 'GetSuite' => 'Gets information about a suite.
', 'GetTest' => 'Gets information about a test.
', 'GetUpload' => 'Gets information about an upload.
', 'GetVPCEConfiguration' => 'Returns information about the configuration settings for your Amazon Virtual Private Cloud (VPC) endpoint.
', 'InstallToRemoteAccessSession' => 'Installs an application to the device in a remote access session. For Android applications, the file must be in .apk format. For iOS applications, the file must be in .ipa format.
', 'ListArtifacts' => 'Gets information about artifacts.
', 'ListDeviceInstances' => 'Returns information about the private device instances associated with one or more AWS accounts.
', 'ListDevicePools' => 'Gets information about device pools.
', 'ListDevices' => 'Gets information about unique device types.
', 'ListInstanceProfiles' => 'Returns information about all the instance profiles in an AWS account.
', 'ListJobs' => 'Gets information about jobs for a given test run.
', 'ListNetworkProfiles' => 'Returns the list of available network profiles.
', 'ListOfferingPromotions' => 'Returns a list of offering promotions. Each offering promotion record contains the ID and description of the promotion. The API returns a NotEligible
error if the caller is not permitted to invoke the operation. Contact aws-devicefarm-support@amazon.com if you believe that you should be able to invoke this operation.
Returns 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 API returns a NotEligible
error if the user is not permitted to invoke the operation. Please contact aws-devicefarm-support@amazon.com if you believe that you should be able to invoke this operation.
Returns a list of products or offerings that the user can manage through the API. Each offering record indicates the recurring price per unit and the frequency for that offering. The API returns a NotEligible
error if the user is not permitted to invoke the operation. Please contact aws-devicefarm-support@amazon.com if you believe that you should be able to invoke this operation.
Gets information about projects.
', 'ListRemoteAccessSessions' => 'Returns a list of all currently running remote access sessions.
', 'ListRuns' => 'Gets information about runs, given an AWS Device Farm project ARN.
', 'ListSamples' => 'Gets information about samples, given an AWS Device Farm job ARN.
', 'ListSuites' => 'Gets information about test suites for a given job.
', 'ListTests' => 'Gets information about tests in a given test suite.
', 'ListUniqueProblems' => 'Gets information about unique problems.
', 'ListUploads' => 'Gets information about uploads, given an AWS Device Farm project ARN.
', 'ListVPCEConfigurations' => 'Returns information about all Amazon Virtual Private Cloud (VPC) endpoint configurations in the AWS account.
', 'PurchaseOffering' => 'Immediately purchases offerings for an AWS account. Offerings renew with the latest total purchased quantity for an offering, unless the renewal was overridden. The API returns a NotEligible
error if the user is not permitted to invoke the operation. Please contact aws-devicefarm-support@amazon.com if you believe that you should be able to invoke this operation.
Explicitly sets the quantity of devices to renew for an offering, starting from the effectiveDate
of the next period. The API returns a NotEligible
error if the user is not permitted to invoke the operation. Please contact aws-devicefarm-support@amazon.com if you believe that you should be able to invoke this operation.
Schedules a run.
', 'StopJob' => 'Initiates a stop request for the current job. AWS Device Farm will immediately stop the job on the device where tests have not started executing, and you will not be billed for this device. On the device where tests have started executing, Setup Suite and Teardown Suite tests will run to completion before stopping execution on the device. You will be billed for Setup, Teardown, and any tests that were in progress or already completed.
', 'StopRemoteAccessSession' => 'Ends a specified remote access session.
', 'StopRun' => 'Initiates a stop request for the current test run. AWS Device Farm will immediately stop the run on devices where tests have not started executing, and you will not be billed for these devices. On devices where tests have started executing, Setup Suite and Teardown Suite tests will run to completion before stopping execution on those devices. You will be billed for Setup, Teardown, and any tests that were in progress or already completed.
', 'UpdateDeviceInstance' => 'Updates information about an existing private device instance.
', 'UpdateDevicePool' => 'Modifies the name, description, and rules in a device pool given the attributes and the pool ARN. Rule updates are all-or-nothing, meaning they can only be updated as a whole (or not at all).
', 'UpdateInstanceProfile' => 'Updates information about an existing private device instance profile.
', 'UpdateNetworkProfile' => 'Updates the network profile with specific settings.
', 'UpdateProject' => 'Modifies the specified project name, given the project ARN and a new name.
', 'UpdateUpload' => 'Update an uploaded test specification (test spec).
', 'UpdateVPCEConfiguration' => 'Updates information about an existing Amazon Virtual Private Cloud (VPC) endpoint configuration.
', ], 'shapes' => [ 'AWSAccountNumber' => [ 'base' => NULL, 'refs' => [ 'AccountSettings$awsAccountNumber' => 'The AWS account number specified in the AccountSettings
container.
A container for account-level settings within AWS Device Farm.
', 'refs' => [ 'GetAccountSettingsResult$accountSettings' => 'The account settings.
', ], ], 'AccountsCleanup' => [ 'base' => NULL, 'refs' => [ 'ExecutionConfiguration$accountsCleanup' => 'True if account cleanup is enabled at the beginning of the test; otherwise, false.
', ], ], 'AmazonResourceName' => [ 'base' => NULL, 'refs' => [ 'AmazonResourceNames$member' => NULL, 'Artifact$arn' => 'The artifact\'s ARN.
', 'CreateDevicePoolRequest$projectArn' => 'The ARN of the project for the device pool.
', 'CreateNetworkProfileRequest$projectArn' => 'The Amazon Resource Name (ARN) of the project for which you want to create a network profile.
', 'CreateRemoteAccessSessionRequest$projectArn' => 'The Amazon Resource Name (ARN) of the project for which you want to create a remote access session.
', 'CreateRemoteAccessSessionRequest$deviceArn' => 'The Amazon Resource Name (ARN) of the device for which you want to create a remote access session.
', 'CreateRemoteAccessSessionRequest$instanceArn' => 'The Amazon Resource Name (ARN) of the device instance for which you want to create a remote access session.
', 'CreateRemoteAccessSessionRequest$remoteRecordAppArn' => 'The Amazon Resource Name (ARN) for the app to be recorded in the remote access session.
', 'CreateUploadRequest$projectArn' => 'The ARN of the project for the upload.
', 'DeleteDevicePoolRequest$arn' => 'Represents the Amazon Resource Name (ARN) of the Device Farm device pool you wish to delete.
', 'DeleteInstanceProfileRequest$arn' => 'The Amazon Resource Name (ARN) of the instance profile you are requesting to delete.
', 'DeleteNetworkProfileRequest$arn' => 'The Amazon Resource Name (ARN) of the network profile you want to delete.
', 'DeleteProjectRequest$arn' => 'Represents the Amazon Resource Name (ARN) of the Device Farm project you wish to delete.
', 'DeleteRemoteAccessSessionRequest$arn' => 'The Amazon Resource Name (ARN) of the sesssion for which you want to delete remote access.
', 'DeleteRunRequest$arn' => 'The Amazon Resource Name (ARN) for the run you wish to delete.
', 'DeleteUploadRequest$arn' => 'Represents the Amazon Resource Name (ARN) of the Device Farm upload you wish to delete.
', 'DeleteVPCEConfigurationRequest$arn' => 'The Amazon Resource Name (ARN) of the VPC endpoint configuration you want to delete.
', 'Device$arn' => 'The device\'s ARN.
', 'DeviceInstance$arn' => 'The Amazon Resource Name (ARN) of the device instance.
', 'DeviceInstance$deviceArn' => 'The Amazon Resource Name (ARN) of the device.
', 'DevicePool$arn' => 'The device pool\'s ARN.
', 'GetDeviceInstanceRequest$arn' => 'The Amazon Resource Name (ARN) of the instance you\'re requesting information about.
', 'GetDevicePoolCompatibilityRequest$devicePoolArn' => 'The device pool\'s ARN.
', 'GetDevicePoolCompatibilityRequest$appArn' => 'The ARN of the app that is associated with the specified device pool.
', 'GetDevicePoolRequest$arn' => 'The device pool\'s ARN.
', 'GetDeviceRequest$arn' => 'The device type\'s ARN.
', 'GetInstanceProfileRequest$arn' => 'The Amazon Resource Name (ARN) of your instance profile.
', 'GetJobRequest$arn' => 'The job\'s ARN.
', 'GetNetworkProfileRequest$arn' => 'The Amazon Resource Name (ARN) of the network profile you want to return information about.
', 'GetProjectRequest$arn' => 'The project\'s ARN.
', 'GetRemoteAccessSessionRequest$arn' => 'The Amazon Resource Name (ARN) of the remote access session about which you want to get session information.
', 'GetRunRequest$arn' => 'The run\'s ARN.
', 'GetSuiteRequest$arn' => 'The suite\'s ARN.
', 'GetTestRequest$arn' => 'The test\'s ARN.
', 'GetUploadRequest$arn' => 'The upload\'s ARN.
', 'GetVPCEConfigurationRequest$arn' => 'The Amazon Resource Name (ARN) of the VPC endpoint configuration you want to describe.
', 'InstallToRemoteAccessSessionRequest$remoteAccessSessionArn' => 'The Amazon Resource Name (ARN) of the remote access session about which you are requesting information.
', 'InstallToRemoteAccessSessionRequest$appArn' => 'The Amazon Resource Name (ARN) of the app about which you are requesting information.
', 'InstanceProfile$arn' => 'The Amazon Resource Name (ARN) of the instance profile.
', 'Job$arn' => 'The job\'s ARN.
', 'Job$instanceArn' => 'The Amazon Resource Name (ARN) of the instance.
', 'ListArtifactsRequest$arn' => 'The Run, Job, Suite, or Test ARN.
', 'ListDevicePoolsRequest$arn' => 'The project ARN.
', 'ListDevicesRequest$arn' => 'The Amazon Resource Name (ARN) of the project.
', 'ListJobsRequest$arn' => 'The run\'s Amazon Resource Name (ARN).
', 'ListNetworkProfilesRequest$arn' => 'The Amazon Resource Name (ARN) of the project for which you want to list network profiles.
', 'ListProjectsRequest$arn' => 'Optional. If no Amazon Resource Name (ARN) is specified, then AWS Device Farm returns a list of all projects for the AWS account. You can also specify a project ARN.
', 'ListRemoteAccessSessionsRequest$arn' => 'The Amazon Resource Name (ARN) of the remote access session about which you are requesting information.
', 'ListRunsRequest$arn' => 'The Amazon Resource Name (ARN) of the project for which you want to list runs.
', 'ListSamplesRequest$arn' => 'The Amazon Resource Name (ARN) of the job used to list samples.
', 'ListSuitesRequest$arn' => 'The job\'s Amazon Resource Name (ARN).
', 'ListTestsRequest$arn' => 'The test suite\'s Amazon Resource Name (ARN).
', 'ListUniqueProblemsRequest$arn' => 'The unique problems\' ARNs.
', 'ListUploadsRequest$arn' => 'The Amazon Resource Name (ARN) of the project for which you want to list uploads.
', 'NetworkProfile$arn' => 'The Amazon Resource Name (ARN) of the network profile.
', 'ProblemDetail$arn' => 'The problem detail\'s ARN.
', 'Project$arn' => 'The project\'s ARN.
', 'RemoteAccessSession$arn' => 'The Amazon Resource Name (ARN) of the remote access session.
', 'RemoteAccessSession$instanceArn' => 'The Amazon Resource Name (ARN) of the instance.
', 'RemoteAccessSession$remoteRecordAppArn' => 'The Amazon Resource Name (ARN) for the app to be recorded in the remote access session.
', 'Run$arn' => 'The run\'s ARN.
', 'Run$appUpload' => 'An app to upload or that has been uploaded.
', 'Run$devicePoolArn' => 'The ARN of the device pool for the run.
', 'Run$testSpecArn' => 'The ARN of the YAML-formatted test specification for the run.
', 'Sample$arn' => 'The sample\'s ARN.
', 'ScheduleRunConfiguration$extraDataPackageArn' => 'The ARN of the extra data for the run. The extra data is a .zip file that AWS Device Farm will extract to external data for Android or the app\'s sandbox for iOS.
', 'ScheduleRunConfiguration$networkProfileArn' => 'Reserved for internal use.
', 'ScheduleRunRequest$projectArn' => 'The ARN of the project for the run to be scheduled.
', 'ScheduleRunRequest$appArn' => 'The ARN of the app to schedule a run.
', 'ScheduleRunRequest$devicePoolArn' => 'The ARN of the device pool for the run to be scheduled.
Either devicePoolArn
or deviceSelectionConfiguration
are required in a request.
The ARN of the uploaded test that will be run.
', 'ScheduleRunTest$testSpecArn' => 'The ARN of the YAML-formatted test specification.
', 'StopJobRequest$arn' => 'Represents the Amazon Resource Name (ARN) of the Device Farm job you wish to stop.
', 'StopRemoteAccessSessionRequest$arn' => 'The Amazon Resource Name (ARN) of the remote access session you wish to stop.
', 'StopRunRequest$arn' => 'Represents the Amazon Resource Name (ARN) of the Device Farm run you wish to stop.
', 'Suite$arn' => 'The suite\'s ARN.
', 'Test$arn' => 'The test\'s ARN.
', 'UpdateDeviceInstanceRequest$arn' => 'The Amazon Resource Name (ARN) of the device instance.
', 'UpdateDeviceInstanceRequest$profileArn' => 'The Amazon Resource Name (ARN) of the profile that you want to associate with the device instance.
', 'UpdateDevicePoolRequest$arn' => 'The Amazon Resourc Name (ARN) of the Device Farm device pool you wish to update.
', 'UpdateInstanceProfileRequest$arn' => 'The Amazon Resource Name (ARN) of the instance profile.
', 'UpdateNetworkProfileRequest$arn' => 'The Amazon Resource Name (ARN) of the project for which you want to update network profile settings.
', 'UpdateProjectRequest$arn' => 'The Amazon Resource Name (ARN) of the project whose name you wish to update.
', 'UpdateUploadRequest$arn' => 'The Amazon Resource Name (ARN) of the uploaded test spec.
', 'UpdateVPCEConfigurationRequest$arn' => 'The Amazon Resource Name (ARN) of the VPC endpoint configuration you want to update.
', 'Upload$arn' => 'The upload\'s ARN.
', 'VPCEConfiguration$arn' => 'The Amazon Resource Name (ARN) of the VPC endpoint configuration.
', ], ], 'AmazonResourceNames' => [ 'base' => NULL, 'refs' => [ 'CreateRemoteAccessSessionConfiguration$vpceConfigurationArns' => 'An array of Amazon Resource Names (ARNs) included in the VPC endpoint configuration.
', 'ScheduleRunConfiguration$vpceConfigurationArns' => 'An array of Amazon Resource Names (ARNs) for your VPC endpoint configurations.
', 'ScheduleRunConfiguration$auxiliaryApps' => 'A list of auxiliary apps for the run.
', ], ], 'AndroidPaths' => [ 'base' => NULL, 'refs' => [ 'CustomerArtifactPaths$androidPaths' => 'Comma-separated list of paths on the Android device where the artifacts generated by the customer\'s tests will be pulled from.
', ], ], 'AppPackagesCleanup' => [ 'base' => NULL, 'refs' => [ 'ExecutionConfiguration$appPackagesCleanup' => 'True if app package cleanup is enabled at the beginning of the test; otherwise, false.
', ], ], 'ArgumentException' => [ 'base' => 'An invalid argument was specified.
', 'refs' => [], ], 'Artifact' => [ 'base' => 'Represents the output of a test. Examples of artifacts include logs and screenshots.
', 'refs' => [ 'Artifacts$member' => NULL, ], ], 'ArtifactCategory' => [ 'base' => NULL, 'refs' => [ 'ListArtifactsRequest$type' => 'The artifacts\' type.
Allowed values include:
FILE: The artifacts are files.
LOG: The artifacts are logs.
SCREENSHOT: The artifacts are screenshots.
The artifact\'s type.
Allowed values include the following:
UNKNOWN: An unknown type.
SCREENSHOT: The screenshot type.
DEVICE_LOG: The device log type.
MESSAGE_LOG: The message log type.
RESULT_LOG: The result log type.
SERVICE_LOG: The service log type.
WEBKIT_LOG: The web kit log type.
INSTRUMENTATION_OUTPUT: The instrumentation type.
EXERCISER_MONKEY_OUTPUT: For Android, the artifact (log) generated by an Android fuzz test.
CALABASH_JSON_OUTPUT: The Calabash JSON output type.
CALABASH_PRETTY_OUTPUT: The Calabash pretty output type.
CALABASH_STANDARD_OUTPUT: The Calabash standard output type.
CALABASH_JAVA_XML_OUTPUT: The Calabash Java XML output type.
AUTOMATION_OUTPUT: The automation output type.
APPIUM_SERVER_OUTPUT: The Appium server output type.
APPIUM_JAVA_OUTPUT: The Appium Java output type.
APPIUM_JAVA_XML_OUTPUT: The Appium Java XML output type.
APPIUM_PYTHON_OUTPUT: The Appium Python output type.
APPIUM_PYTHON_XML_OUTPUT: The Appium Python XML output type.
EXPLORER_EVENT_LOG: The Explorer event log output type.
EXPLORER_SUMMARY_LOG: The Explorer summary log output type.
APPLICATION_CRASH_REPORT: The application crash report output type.
XCTEST_LOG: The XCode test output type.
Information about the artifacts.
', ], ], 'BillingMethod' => [ 'base' => NULL, 'refs' => [ 'CreateRemoteAccessSessionConfiguration$billingMethod' => 'The billing method for the remote access session.
', 'RemoteAccessSession$billingMethod' => '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."
Specifies the billing method for a test run: metered
or unmetered
. If the parameter is not specified, the default value is metered
.
Specifies the billing method for a test run: metered
or unmetered
. If the parameter is not specified, the default value is metered
.
When set to true
, Device Farm will remove app packages after a test run. The default value is false
for private devices.
When set to true
, Device Farm will reboot the instance after a test run. The default value is true
.
Set to true
if you want to access devices remotely for debugging in your remote access session.
Set to true
to enable remote recording for the remote access session.
When set to true
, for private devices, Device Farm will not sign your app again. For public devices, Device Farm always signs your apps again and this parameter has no effect.
For more information about how Device Farm re-signs your app(s), see Do you modify my app? in the AWS Device Farm FAQs.
', 'Device$remoteAccessEnabled' => 'Specifies whether remote access has been enabled for the specified device.
', 'Device$remoteDebugEnabled' => 'This flag is set to true
if remote debugging is enabled for the device.
Whether the result was compatible with the device pool.
', 'InstanceProfile$packageCleanup' => 'When set to true
, Device Farm will remove app packages after a test run. The default value is false
for private devices.
When set to true
, Device Farm will reboot the instance after a test run. The default value is true
.
True if Wi-Fi is enabled at the beginning of the test; otherwise, false.
', 'Radios$bluetooth' => 'True if Bluetooth is enabled at the beginning of the test; otherwise, false.
', 'Radios$nfc' => 'True if NFC is enabled at the beginning of the test; otherwise, false.
', 'Radios$gps' => 'True if GPS is enabled at the beginning of the test; otherwise, false.
', 'RemoteAccessSession$remoteDebugEnabled' => 'This flag is set to true
if remote debugging is enabled for the remote access session.
This flag is set to true
if remote recording is enabled for the remote access session.
The updated choice for whether you want to specify package cleanup. The default value is false
for private devices.
The updated choice for whether you want to reboot the device after use. The default value is true
.
Set to true if the YAML file has changed and needs to be updated; otherwise, set to false.
', ], ], 'CPU' => [ 'base' => 'Represents the amount of CPU that an app is using on a physical device.
Note that this does not represent system-wide CPU usage.
', 'refs' => [ 'Device$cpu' => 'Information about the device\'s CPU.
', ], ], 'ClientId' => [ 'base' => NULL, 'refs' => [ 'CreateRemoteAccessSessionRequest$clientId' => 'Unique identifier for the client. If you want access to multiple devices on the same client, you should pass the same clientId
value in each call to CreateRemoteAccessSession
. This is required only if remoteDebugEnabled
is set to true
.
Unique identifier of your client for the remote access session. Only returned if remote debugging is enabled for the remote access session.
', ], ], 'ContentType' => [ 'base' => NULL, 'refs' => [ 'CreateUploadRequest$contentType' => 'The upload\'s content type (for example, "application/octet-stream").
', 'UpdateUploadRequest$contentType' => 'The upload\'s content type (for example, "application/x-yaml").
', 'Upload$contentType' => 'The upload\'s content type (for example, "application/octet-stream").
', ], ], 'Counters' => [ 'base' => 'Represents entity counters.
', 'refs' => [ 'Job$counters' => 'The job\'s result counters.
', 'Run$counters' => 'The run\'s result counters.
', 'Suite$counters' => 'The suite\'s result counters.
', 'Test$counters' => 'The test\'s result counters.
', ], ], 'CreateDevicePoolRequest' => [ 'base' => 'Represents a request to the create device pool operation.
', 'refs' => [], ], 'CreateDevicePoolResult' => [ 'base' => 'Represents the result of a create device pool request.
', 'refs' => [], ], 'CreateInstanceProfileRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateInstanceProfileResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateNetworkProfileRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateNetworkProfileResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateProjectRequest' => [ 'base' => 'Represents a request to the create project operation.
', 'refs' => [], ], 'CreateProjectResult' => [ 'base' => 'Represents the result of a create project request.
', 'refs' => [], ], 'CreateRemoteAccessSessionConfiguration' => [ 'base' => 'Configuration settings for a remote access session, including billing method.
', 'refs' => [ 'CreateRemoteAccessSessionRequest$configuration' => 'The configuration information for the remote access session request.
', ], ], 'CreateRemoteAccessSessionRequest' => [ 'base' => 'Creates and submits a request to start a remote access session.
', 'refs' => [], ], 'CreateRemoteAccessSessionResult' => [ 'base' => 'Represents the server response from a request to create a remote access session.
', 'refs' => [], ], 'CreateUploadRequest' => [ 'base' => 'Represents a request to the create upload operation.
', 'refs' => [], ], 'CreateUploadResult' => [ 'base' => 'Represents the result of a create upload request.
', 'refs' => [], ], 'CreateVPCEConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateVPCEConfigurationResult' => [ 'base' => NULL, 'refs' => [], ], 'CurrencyCode' => [ 'base' => NULL, 'refs' => [ 'MonetaryAmount$currencyCode' => 'The currency code of a monetary amount. For example, USD
means "U.S. dollars."
A JSON object specifying the paths where the artifacts generated by the customer\'s tests, on the device or in the test environment, will be pulled from.
Specify deviceHostPaths
and optionally specify either iosPaths
or androidPaths
.
For web app tests, you can specify both iosPaths
and androidPaths
.
Output CustomerArtifactPaths
object for the test run.
Input CustomerArtifactPaths
object for the scheduled run configuration.
When the job was created.
', 'Job$started' => 'The job\'s start time.
', 'Job$stopped' => 'The job\'s stop time.
', 'OfferingStatus$effectiveOn' => 'The date on which the offering is effective.
', 'OfferingTransaction$createdOn' => 'The date on which an offering transaction was created.
', 'Project$created' => 'When the project was created.
', 'RemoteAccessSession$created' => 'The date and time the remote access session was created.
', 'RemoteAccessSession$started' => 'The date and time the remote access session was started.
', 'RemoteAccessSession$stopped' => 'The date and time the remote access session was stopped.
', 'Run$created' => 'When the run was created.
', 'Run$started' => 'The run\'s start time.
', 'Run$stopped' => 'The run\'s stop time.
', 'Suite$created' => 'When the suite was created.
', 'Suite$started' => 'The suite\'s start time.
', 'Suite$stopped' => 'The suite\'s stop time.
', 'Test$created' => 'When the test was created.
', 'Test$started' => 'The test\'s start time.
', 'Test$stopped' => 'The test\'s stop time.
', 'Upload$created' => 'When the upload was created.
', ], ], 'DeleteDevicePoolRequest' => [ 'base' => 'Represents a request to the delete device pool operation.
', 'refs' => [], ], 'DeleteDevicePoolResult' => [ 'base' => 'Represents the result of a delete device pool request.
', 'refs' => [], ], 'DeleteInstanceProfileRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteInstanceProfileResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteNetworkProfileRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteNetworkProfileResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteProjectRequest' => [ 'base' => 'Represents a request to the delete project operation.
', 'refs' => [], ], 'DeleteProjectResult' => [ 'base' => 'Represents the result of a delete project request.
', 'refs' => [], ], 'DeleteRemoteAccessSessionRequest' => [ 'base' => 'Represents the request to delete the specified remote access session.
', 'refs' => [], ], 'DeleteRemoteAccessSessionResult' => [ 'base' => 'The response from the server when a request is made to delete the remote access session.
', 'refs' => [], ], 'DeleteRunRequest' => [ 'base' => 'Represents a request to the delete run operation.
', 'refs' => [], ], 'DeleteRunResult' => [ 'base' => 'Represents the result of a delete run request.
', 'refs' => [], ], 'DeleteUploadRequest' => [ 'base' => 'Represents a request to the delete upload operation.
', 'refs' => [], ], 'DeleteUploadResult' => [ 'base' => 'Represents the result of a delete upload request.
', 'refs' => [], ], 'DeleteVPCEConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteVPCEConfigurationResult' => [ 'base' => NULL, 'refs' => [], ], 'Device' => [ 'base' => 'Represents a device type that an app is tested against.
', 'refs' => [ 'DevicePoolCompatibilityResult$device' => 'The device (phone or tablet) that you wish to return information about.
', 'Devices$member' => NULL, 'GetDeviceResult$device' => 'An object containing information about the requested device.
', 'Job$device' => 'The device (phone or tablet).
', 'Problem$device' => 'Information about the associated device.
', 'RemoteAccessSession$device' => 'The device (phone or tablet) used in the remote access session.
', ], ], 'DeviceAttribute' => [ 'base' => NULL, 'refs' => [ 'IncompatibilityMessage$type' => 'The type of incompatibility.
Allowed values include:
ARN: The ARN.
FORM_FACTOR: The form factor (for example, phone or tablet).
MANUFACTURER: The manufacturer.
PLATFORM: The platform (for example, Android or iOS).
REMOTE_ACCESS_ENABLED: Whether the device is enabled for remote access.
APPIUM_VERSION: The Appium version for the test.
The rule\'s attribute. It is the aspect of a device such as platform or model used as selection criteria to create or update a device pool.
Allowed values include:
ARN: The Amazon Resource Name (ARN) of a device. For example, "arn:aws:devicefarm:us-west-2::device:12345Example".
PLATFORM: The device platform. Valid values are "ANDROID" or "IOS".
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.
REMOTE_DEBUG_ENABLED: Whether the device is enabled for remote debugging.
APPIUM_VERSION: The Appium version for the test.
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".
Reflects how likely a device will be available for a test run.
', ], ], 'DeviceFilter' => [ 'base' => 'Represents a device filter used to select a set of devices to be included in a test run. This data structure is passed in as the "deviceSelectionConfiguration" parameter to ScheduleRun. For an example of the JSON request syntax, see ScheduleRun.
It is also passed in as the "filters" parameter to ListDevices. For an example of the JSON request syntax, see ListDevices.
', 'refs' => [ 'DeviceFilters$member' => NULL, ], ], 'DeviceFilterAttribute' => [ 'base' => NULL, 'refs' => [ 'DeviceFilter$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.
REMOTE_DEBUG_ENABLED: Whether the device is enabled for remote debugging.
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".
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.
An array of one or more filter values used in a device filter.
Operator Values
The IN and NOT 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".
Used to dynamically select a set of devices for a test run. A filter is made up of an attribute, an operator, 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.
REMOTE_DEBUG_ENABLED: Whether the device is enabled for remote debugging.
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 operators can take a values array that has more than one element.
The other operators require an array with a single element.
In a request, the AVAILABILITY attribute takes "AVAILABLE", "HIGHLY_AVAILABLE", "BUSY", or "TEMPORARY_NOT_AVAILABLE" as values.
The filters in a device selection result.
', 'ListDevicesRequest$filters' => 'Used to select a set of devices. A filter is made up of an attribute, an operator, and one or more values.
Attribute: The aspect of a device such as platform or model used as the selction 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.
REMOTE_DEBUG_ENABLED: Whether the device is enabled for remote debugging.
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 operators can take a values array that has more than one element.
The other operators require an array with a single element.
In a request, the AVAILABILITY attribute takes "AVAILABLE", "HIGHLY_AVAILABLE", "BUSY", or "TEMPORARY_NOT_AVAILABLE" as values.
The device\'s form factor.
Allowed values include:
PHONE: The phone form factor.
TABLET: The tablet form factor.
Comma-separated list of paths in the test execution environment where the artifacts generated by the customer\'s tests will be pulled from.
', ], ], 'DeviceInstance' => [ 'base' => 'Represents the device instance.
', 'refs' => [ 'DeviceInstances$member' => NULL, 'GetDeviceInstanceResult$deviceInstance' => 'An object containing information about your device instance.
', 'UpdateDeviceInstanceResult$deviceInstance' => 'An object containing information about your device instance.
', ], ], 'DeviceInstances' => [ 'base' => NULL, 'refs' => [ 'Device$instances' => 'The instances belonging to this device.
', 'ListDeviceInstancesResult$deviceInstances' => 'An object containing information about your device instances.
', ], ], 'DeviceMinutes' => [ 'base' => 'Represents the total (metered or unmetered) minutes used by the resource to run tests. Contains the sum of minutes consumed by all children.
', 'refs' => [ 'Job$deviceMinutes' => 'Represents the total (metered or unmetered) minutes used by the job.
', 'RemoteAccessSession$deviceMinutes' => 'The number of minutes a device is used in a remote access sesssion (including setup and teardown minutes).
', 'Run$deviceMinutes' => 'Represents the total (metered or unmetered) minutes used by the test run.
', 'Suite$deviceMinutes' => 'Represents the total (metered or unmetered) minutes used by the test suite.
', 'Test$deviceMinutes' => 'Represents the total (metered or unmetered) minutes used by the test.
', ], ], 'DevicePlatform' => [ 'base' => NULL, 'refs' => [ 'Device$platform' => 'The device\'s platform.
Allowed values include:
ANDROID: The Android platform.
IOS: The iOS platform.
The platform of the device (e.g., ANDROID or IOS).
', 'PurchasedDevicesMap$key' => NULL, 'Run$platform' => 'The run\'s platform.
Allowed values include:
ANDROID: The Android platform.
IOS: The iOS platform.
Represents a collection of device types.
', 'refs' => [ 'CreateDevicePoolResult$devicePool' => 'The newly created device pool.
', 'DevicePools$member' => NULL, 'GetDevicePoolResult$devicePool' => 'An object containing information about the requested device pool.
', 'UpdateDevicePoolResult$devicePool' => 'The device pool you just updated.
', ], ], 'DevicePoolCompatibilityResult' => [ 'base' => 'Represents a device pool compatibility result.
', 'refs' => [ 'DevicePoolCompatibilityResults$member' => NULL, ], ], 'DevicePoolCompatibilityResults' => [ 'base' => NULL, 'refs' => [ 'GetDevicePoolCompatibilityResult$compatibleDevices' => 'Information about compatible devices.
', 'GetDevicePoolCompatibilityResult$incompatibleDevices' => 'Information about incompatible devices.
', ], ], 'DevicePoolType' => [ 'base' => NULL, 'refs' => [ 'DevicePool$type' => '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.
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.
Information about the device pools.
', ], ], 'DeviceSelectionConfiguration' => [ 'base' => 'Represents the device filters used in a test run as well as the maximum number of devices to be included in the run. It is passed in as the deviceSelectionConfiguration request parameter in ScheduleRun.
', 'refs' => [ 'ScheduleRunRequest$deviceSelectionConfiguration' => 'The filter criteria used to dynamically select a set of devices for a test run, as well as the maximum number of devices to be included in the run.
Either devicePoolArn
or deviceSelectionConfiguration
are required in a request.
Contains the run results requested by the device selection configuration as well as how many devices were returned. For an example of the JSON response syntax, see ScheduleRun.
', 'refs' => [ 'Run$deviceSelectionResult' => 'The results of a device filter used to select the devices for a test run.
', ], ], 'Devices' => [ 'base' => NULL, 'refs' => [ 'ListDevicesResult$devices' => 'Information about the devices.
', ], ], 'Double' => [ 'base' => NULL, 'refs' => [ 'CPU$clock' => 'The clock speed of the device\'s CPU, expressed in hertz (Hz). For example, a 1.2 GHz CPU is expressed as 1200000000.
', 'DeviceMinutes$total' => 'When specified, represents the total minutes used by the resource to run tests.
', 'DeviceMinutes$metered' => 'When specified, represents only the sum of metered minutes used by the resource to run tests.
', 'DeviceMinutes$unmetered' => 'When specified, represents only the sum of unmetered minutes used by the resource to run tests.
', 'Location$latitude' => 'The latitude.
', 'Location$longitude' => 'The longitude.
', 'MonetaryAmount$amount' => 'The numerical amount of an offering or transaction.
', 'TrialMinutes$total' => 'The total number of free trial minutes that the account started with.
', 'TrialMinutes$remaining' => 'The number of free trial minutes remaining in the account.
', ], ], 'ExecutionConfiguration' => [ 'base' => 'Represents configuration information about a test run, such as the execution timeout (in minutes).
', 'refs' => [ 'ScheduleRunRequest$executionConfiguration' => 'Specifies configuration information about a test run, such as the execution timeout (in minutes).
', ], ], 'ExecutionResult' => [ 'base' => NULL, 'refs' => [ 'Job$result' => 'The job\'s result.
Allowed values include:
PENDING: A pending condition.
PASSED: A passing condition.
WARNED: A warning condition.
FAILED: A failed condition.
SKIPPED: A skipped condition.
ERRORED: An error condition.
STOPPED: A stopped condition.
The problem\'s result.
Allowed values include:
PENDING: A pending condition.
PASSED: A passing condition.
WARNED: A warning condition.
FAILED: A failed condition.
SKIPPED: A skipped condition.
ERRORED: An error condition.
STOPPED: A stopped condition.
The result of the remote access session. Can be any of the following:
PENDING: A pending condition.
PASSED: A passing condition.
WARNED: A warning condition.
FAILED: A failed condition.
SKIPPED: A skipped condition.
ERRORED: An error condition.
STOPPED: A stopped condition.
The run\'s result.
Allowed values include:
PENDING: A pending condition.
PASSED: A passing condition.
WARNED: A warning condition.
FAILED: A failed condition.
SKIPPED: A skipped condition.
ERRORED: An error condition.
STOPPED: A stopped condition.
The suite\'s result.
Allowed values include:
PENDING: A pending condition.
PASSED: A passing condition.
WARNED: A warning condition.
FAILED: A failed condition.
SKIPPED: A skipped condition.
ERRORED: An error condition.
STOPPED: A stopped condition.
The test\'s result.
Allowed values include:
PENDING: A pending condition.
PASSED: A passing condition.
WARNED: A warning condition.
FAILED: A failed condition.
SKIPPED: A skipped condition.
ERRORED: An error condition.
STOPPED: A stopped condition.
Supporting field for the result field. Set only if result
is SKIPPED
. PARSING_FAILED
if the result is skipped because of test package parsing failure.
The job\'s status.
Allowed values include:
PENDING: A pending status.
PENDING_CONCURRENCY: A pending concurrency status.
PENDING_DEVICE: A pending device status.
PROCESSING: A processing status.
SCHEDULING: A scheduling status.
PREPARING: A preparing status.
RUNNING: A running status.
COMPLETED: A completed status.
STOPPING: A stopping status.
The status of the remote access session. Can be any of the following:
PENDING: A pending status.
PENDING_CONCURRENCY: A pending concurrency status.
PENDING_DEVICE: A pending device status.
PROCESSING: A processing status.
SCHEDULING: A scheduling status.
PREPARING: A preparing status.
RUNNING: A running status.
COMPLETED: A completed status.
STOPPING: A stopping status.
The run\'s status.
Allowed values include:
PENDING: A pending status.
PENDING_CONCURRENCY: A pending concurrency status.
PENDING_DEVICE: A pending device status.
PROCESSING: A processing status.
SCHEDULING: A scheduling status.
PREPARING: A preparing status.
RUNNING: A running status.
COMPLETED: A completed status.
STOPPING: A stopping status.
The suite\'s status.
Allowed values include:
PENDING: A pending status.
PENDING_CONCURRENCY: A pending concurrency status.
PENDING_DEVICE: A pending device status.
PROCESSING: A processing status.
SCHEDULING: A scheduling status.
PREPARING: A preparing status.
RUNNING: A running status.
COMPLETED: A completed status.
STOPPING: A stopping status.
The test\'s status.
Allowed values include:
PENDING: A pending status.
PENDING_CONCURRENCY: A pending concurrency status.
PENDING_DEVICE: A pending device status.
PROCESSING: A processing status.
SCHEDULING: A scheduling status.
PREPARING: A preparing status.
RUNNING: A running status.
COMPLETED: A completed status.
STOPPING: A stopping status.
The test\'s filter.
', ], ], 'GetAccountSettingsRequest' => [ 'base' => 'Represents the request sent to retrieve the account settings.
', 'refs' => [], ], 'GetAccountSettingsResult' => [ 'base' => 'Represents the account settings return values from the GetAccountSettings
request.
Represents a request to the get device pool compatibility operation.
', 'refs' => [], ], 'GetDevicePoolCompatibilityResult' => [ 'base' => 'Represents the result of describe device pool compatibility request.
', 'refs' => [], ], 'GetDevicePoolRequest' => [ 'base' => 'Represents a request to the get device pool operation.
', 'refs' => [], ], 'GetDevicePoolResult' => [ 'base' => 'Represents the result of a get device pool request.
', 'refs' => [], ], 'GetDeviceRequest' => [ 'base' => 'Represents a request to the get device request.
', 'refs' => [], ], 'GetDeviceResult' => [ 'base' => 'Represents the result of a get device request.
', 'refs' => [], ], 'GetInstanceProfileRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetInstanceProfileResult' => [ 'base' => NULL, 'refs' => [], ], 'GetJobRequest' => [ 'base' => 'Represents a request to the get job operation.
', 'refs' => [], ], 'GetJobResult' => [ 'base' => 'Represents the result of a get job request.
', 'refs' => [], ], 'GetNetworkProfileRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetNetworkProfileResult' => [ 'base' => NULL, 'refs' => [], ], 'GetOfferingStatusRequest' => [ 'base' => 'Represents the request to retrieve the offering status for the specified customer or account.
', 'refs' => [], ], 'GetOfferingStatusResult' => [ 'base' => 'Returns the status result for a device offering.
', 'refs' => [], ], 'GetProjectRequest' => [ 'base' => 'Represents a request to the get project operation.
', 'refs' => [], ], 'GetProjectResult' => [ 'base' => 'Represents the result of a get project request.
', 'refs' => [], ], 'GetRemoteAccessSessionRequest' => [ 'base' => 'Represents the request to get information about the specified remote access session.
', 'refs' => [], ], 'GetRemoteAccessSessionResult' => [ 'base' => 'Represents the response from the server that lists detailed information about the remote access session.
', 'refs' => [], ], 'GetRunRequest' => [ 'base' => 'Represents a request to the get run operation.
', 'refs' => [], ], 'GetRunResult' => [ 'base' => 'Represents the result of a get run request.
', 'refs' => [], ], 'GetSuiteRequest' => [ 'base' => 'Represents a request to the get suite operation.
', 'refs' => [], ], 'GetSuiteResult' => [ 'base' => 'Represents the result of a get suite request.
', 'refs' => [], ], 'GetTestRequest' => [ 'base' => 'Represents a request to the get test operation.
', 'refs' => [], ], 'GetTestResult' => [ 'base' => 'Represents the result of a get test request.
', 'refs' => [], ], 'GetUploadRequest' => [ 'base' => 'Represents a request to the get upload operation.
', 'refs' => [], ], 'GetUploadResult' => [ 'base' => 'Represents the result of a get upload request.
', 'refs' => [], ], 'GetVPCEConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetVPCEConfigurationResult' => [ 'base' => NULL, 'refs' => [], ], 'HostAddress' => [ 'base' => NULL, 'refs' => [ 'RemoteAccessSession$hostAddress' => 'IP address of the EC2 host where you need to connect to remotely debug devices. Only returned if remote debugging is enabled for the remote access session.
', ], ], 'IdempotencyException' => [ 'base' => 'An entity with the same name already exists.
', 'refs' => [], ], 'IncompatibilityMessage' => [ 'base' => 'Represents information about incompatibility.
', 'refs' => [ 'IncompatibilityMessages$member' => NULL, ], ], 'IncompatibilityMessages' => [ 'base' => NULL, 'refs' => [ 'DevicePoolCompatibilityResult$incompatibilityMessages' => 'Information about the compatibility.
', ], ], 'InstallToRemoteAccessSessionRequest' => [ 'base' => 'Represents the request to install an Android application (in .apk format) or an iOS application (in .ipa format) as part of a remote access session.
', 'refs' => [], ], 'InstallToRemoteAccessSessionResult' => [ 'base' => 'Represents the response from the server after AWS Device Farm makes a request to install to a remote access session.
', 'refs' => [], ], 'InstanceLabels' => [ 'base' => NULL, 'refs' => [ 'DeviceInstance$labels' => 'An array of strings describing the device instance.
', 'UpdateDeviceInstanceRequest$labels' => 'An array of strings that you want to associate with the device instance.
', ], ], 'InstanceProfile' => [ 'base' => 'Represents the instance profile.
', 'refs' => [ 'CreateInstanceProfileResult$instanceProfile' => 'An object containing information about your instance profile.
', 'DeviceInstance$instanceProfile' => 'A object containing information about the instance profile.
', 'GetInstanceProfileResult$instanceProfile' => 'An object containing information about your instance profile.
', 'InstanceProfiles$member' => NULL, 'UpdateInstanceProfileResult$instanceProfile' => 'An object containing information about your instance profile.
', ], ], 'InstanceProfiles' => [ 'base' => NULL, 'refs' => [ 'ListInstanceProfilesResult$instanceProfiles' => 'An object containing information about your instance profiles.
', ], ], 'InstanceStatus' => [ 'base' => NULL, 'refs' => [ 'DeviceInstance$status' => 'The status of the device instance. Valid values are listed below.
', ], ], 'Integer' => [ 'base' => NULL, 'refs' => [ 'Counters$total' => 'The total number of entities.
', 'Counters$passed' => 'The number of passed entities.
', 'Counters$failed' => 'The number of failed entities.
', 'Counters$warned' => 'The number of warned entities.
', 'Counters$errored' => 'The number of errored entities.
', 'Counters$stopped' => 'The number of stopped entities.
', 'Counters$skipped' => 'The number of skipped entities.
', 'DeviceSelectionConfiguration$maxDevices' => 'The maximum number of devices to be included in a test run.
', 'DeviceSelectionResult$matchedDevicesCount' => 'The number of devices that matched the device filter selection criteria.
', 'DeviceSelectionResult$maxDevices' => 'The maximum number of devices to be selected by a device filter and included in a test run.
', 'ListDeviceInstancesRequest$maxResults' => 'An integer specifying the maximum number of items you want to return in the API response.
', 'ListInstanceProfilesRequest$maxResults' => 'An integer specifying the maximum number of items you want to return in the API response.
', 'ListVPCEConfigurationsRequest$maxResults' => 'An integer specifying the maximum number of items you want to return in the API response.
', 'MaxSlotMap$value' => NULL, 'OfferingStatus$quantity' => 'The number of available devices in the offering.
', 'PurchaseOfferingRequest$quantity' => 'The number of device slots you wish to purchase in an offering request.
', 'PurchasedDevicesMap$value' => NULL, 'RenewOfferingRequest$quantity' => 'The quantity requested in an offering renewal.
', 'Resolution$width' => 'The screen resolution\'s width, expressed in pixels.
', 'Resolution$height' => 'The screen resolution\'s height, expressed in pixels.
', 'Run$totalJobs' => 'The total number of jobs for the run.
', 'Run$completedJobs' => 'The total number of completed jobs.
', 'Run$seed' => 'For fuzz tests, this is a seed to use for randomizing the UI fuzz test. Using the same seed value between tests ensures identical event sequences.
', 'Run$eventCount' => 'For fuzz tests, this is the number of events, between 1 and 10000, that the UI fuzz test should perform.
', ], ], 'InteractionMode' => [ 'base' => NULL, 'refs' => [ 'CreateRemoteAccessSessionRequest$interactionMode' => '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 this mode.
VIDEO_ONLY: You can view the screen but cannot touch or rotate it. You can run XCUITest framework-based tests and watch the screen in this mode.
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 this mode.
VIDEO_ONLY: You can view the screen but cannot touch or rotate it. You can run XCUITest framework-based tests and watch the screen in this mode.
There was an error with the update request, or you do not have sufficient permissions to update this VPC endpoint configuration.
', 'refs' => [], ], 'IosPaths' => [ 'base' => NULL, 'refs' => [ 'CustomerArtifactPaths$iosPaths' => 'Comma-separated list of paths on the iOS device where the artifacts generated by the customer\'s tests will be pulled from.
', ], ], 'Job' => [ 'base' => 'Represents a device.
', 'refs' => [ 'GetJobResult$job' => 'An object containing information about the requested job.
', 'Jobs$member' => NULL, 'StopJobResult$job' => 'The job that was stopped.
', ], ], 'JobTimeoutMinutes' => [ 'base' => NULL, 'refs' => [ 'AccountSettings$maxJobTimeoutMinutes' => 'The maximum number of minutes a test run will execute before it times out.
', 'AccountSettings$defaultJobTimeoutMinutes' => 'The default number of minutes (at the account level) a test run will execute before it times out. Default value is 60 minutes.
', 'CreateProjectRequest$defaultJobTimeoutMinutes' => 'Sets the execution timeout value (in minutes) for a project. All test runs in this project will use the specified execution timeout value unless overridden when scheduling a run.
', 'ExecutionConfiguration$jobTimeoutMinutes' => 'The number of minutes a test run will execute before it times out.
', 'Project$defaultJobTimeoutMinutes' => 'The default number of minutes (at the project level) a test run will execute before it times out. Default value is 60 minutes.
', 'Run$jobTimeoutMinutes' => 'The number of minutes the job will execute before it times out.
', 'UpdateProjectRequest$defaultJobTimeoutMinutes' => 'The number of minutes a test run in the project will execute before it times out.
', ], ], 'Jobs' => [ 'base' => NULL, 'refs' => [ 'ListJobsResult$jobs' => 'Information about the jobs.
', ], ], 'LimitExceededException' => [ 'base' => 'A limit was exceeded.
', 'refs' => [], ], 'ListArtifactsRequest' => [ 'base' => 'Represents a request to the list artifacts operation.
', 'refs' => [], ], 'ListArtifactsResult' => [ 'base' => 'Represents the result of a list artifacts operation.
', 'refs' => [], ], 'ListDeviceInstancesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListDeviceInstancesResult' => [ 'base' => NULL, 'refs' => [], ], 'ListDevicePoolsRequest' => [ 'base' => 'Represents the result of a list device pools request.
', 'refs' => [], ], 'ListDevicePoolsResult' => [ 'base' => 'Represents the result of a list device pools request.
', 'refs' => [], ], 'ListDevicesRequest' => [ 'base' => 'Represents the result of a list devices request.
', 'refs' => [], ], 'ListDevicesResult' => [ 'base' => 'Represents the result of a list devices operation.
', 'refs' => [], ], 'ListInstanceProfilesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListInstanceProfilesResult' => [ 'base' => NULL, 'refs' => [], ], 'ListJobsRequest' => [ 'base' => 'Represents a request to the list jobs operation.
', 'refs' => [], ], 'ListJobsResult' => [ 'base' => 'Represents the result of a list jobs request.
', 'refs' => [], ], 'ListNetworkProfilesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListNetworkProfilesResult' => [ 'base' => NULL, 'refs' => [], ], 'ListOfferingPromotionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListOfferingPromotionsResult' => [ 'base' => NULL, 'refs' => [], ], 'ListOfferingTransactionsRequest' => [ 'base' => 'Represents the request to list the offering transaction history.
', 'refs' => [], ], 'ListOfferingTransactionsResult' => [ 'base' => 'Returns the transaction log of the specified offerings.
', 'refs' => [], ], 'ListOfferingsRequest' => [ 'base' => 'Represents the request to list all offerings.
', 'refs' => [], ], 'ListOfferingsResult' => [ 'base' => 'Represents the return values of the list of offerings.
', 'refs' => [], ], 'ListProjectsRequest' => [ 'base' => 'Represents a request to the list projects operation.
', 'refs' => [], ], 'ListProjectsResult' => [ 'base' => 'Represents the result of a list projects request.
', 'refs' => [], ], 'ListRemoteAccessSessionsRequest' => [ 'base' => 'Represents the request to return information about the remote access session.
', 'refs' => [], ], 'ListRemoteAccessSessionsResult' => [ 'base' => 'Represents the response from the server after AWS Device Farm makes a request to return information about the remote access session.
', 'refs' => [], ], 'ListRunsRequest' => [ 'base' => 'Represents a request to the list runs operation.
', 'refs' => [], ], 'ListRunsResult' => [ 'base' => 'Represents the result of a list runs request.
', 'refs' => [], ], 'ListSamplesRequest' => [ 'base' => 'Represents a request to the list samples operation.
', 'refs' => [], ], 'ListSamplesResult' => [ 'base' => 'Represents the result of a list samples request.
', 'refs' => [], ], 'ListSuitesRequest' => [ 'base' => 'Represents a request to the list suites operation.
', 'refs' => [], ], 'ListSuitesResult' => [ 'base' => 'Represents the result of a list suites request.
', 'refs' => [], ], 'ListTestsRequest' => [ 'base' => 'Represents a request to the list tests operation.
', 'refs' => [], ], 'ListTestsResult' => [ 'base' => 'Represents the result of a list tests request.
', 'refs' => [], ], 'ListUniqueProblemsRequest' => [ 'base' => 'Represents a request to the list unique problems operation.
', 'refs' => [], ], 'ListUniqueProblemsResult' => [ 'base' => 'Represents the result of a list unique problems request.
', 'refs' => [], ], 'ListUploadsRequest' => [ 'base' => 'Represents a request to the list uploads operation.
', 'refs' => [], ], 'ListUploadsResult' => [ 'base' => 'Represents the result of a list uploads request.
', 'refs' => [], ], 'ListVPCEConfigurationsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListVPCEConfigurationsResult' => [ 'base' => NULL, 'refs' => [], ], 'Location' => [ 'base' => 'Represents a latitude and longitude pair, expressed in geographic coordinate system degrees (for example 47.6204, -122.3491).
Elevation is currently not supported.
', 'refs' => [ 'Run$location' => 'Information about the location that is used for the run.
', 'ScheduleRunConfiguration$location' => 'Information about the location that is used for the run.
', ], ], 'Long' => [ 'base' => NULL, 'refs' => [ 'CreateNetworkProfileRequest$uplinkBandwidthBits' => 'The data throughput rate in bits per second, as an integer from 0 to 104857600.
', 'CreateNetworkProfileRequest$downlinkBandwidthBits' => 'The data throughput rate in bits per second, as an integer from 0 to 104857600.
', 'CreateNetworkProfileRequest$uplinkDelayMs' => 'Delay time for all packets to destination in milliseconds as an integer from 0 to 2000.
', 'CreateNetworkProfileRequest$downlinkDelayMs' => 'Delay time for all packets to destination in milliseconds as an integer from 0 to 2000.
', 'CreateNetworkProfileRequest$uplinkJitterMs' => 'Time variation in the delay of received packets in milliseconds as an integer from 0 to 2000.
', 'CreateNetworkProfileRequest$downlinkJitterMs' => 'Time variation in the delay of received packets in milliseconds as an integer from 0 to 2000.
', 'Device$heapSize' => 'The device\'s heap size, expressed in bytes.
', 'Device$memory' => 'The device\'s total memory size, expressed in bytes.
', 'NetworkProfile$uplinkBandwidthBits' => 'The data throughput rate in bits per second, as an integer from 0 to 104857600.
', 'NetworkProfile$downlinkBandwidthBits' => 'The data throughput rate in bits per second, as an integer from 0 to 104857600.
', 'NetworkProfile$uplinkDelayMs' => 'Delay time for all packets to destination in milliseconds as an integer from 0 to 2000.
', 'NetworkProfile$downlinkDelayMs' => 'Delay time for all packets to destination in milliseconds as an integer from 0 to 2000.
', 'NetworkProfile$uplinkJitterMs' => 'Time variation in the delay of received packets in milliseconds as an integer from 0 to 2000.
', 'NetworkProfile$downlinkJitterMs' => 'Time variation in the delay of received packets in milliseconds as an integer from 0 to 2000.
', 'UpdateNetworkProfileRequest$uplinkBandwidthBits' => 'The data throughput rate in bits per second, as an integer from 0 to 104857600.
', 'UpdateNetworkProfileRequest$downlinkBandwidthBits' => 'The data throughput rate in bits per second, as an integer from 0 to 104857600.
', 'UpdateNetworkProfileRequest$uplinkDelayMs' => 'Delay time for all packets to destination in milliseconds as an integer from 0 to 2000.
', 'UpdateNetworkProfileRequest$downlinkDelayMs' => 'Delay time for all packets to destination in milliseconds as an integer from 0 to 2000.
', 'UpdateNetworkProfileRequest$uplinkJitterMs' => 'Time variation in the delay of received packets in milliseconds as an integer from 0 to 2000.
', 'UpdateNetworkProfileRequest$downlinkJitterMs' => 'Time variation in the delay of received packets in milliseconds as an integer from 0 to 2000.
', ], ], 'MaxSlotMap' => [ 'base' => NULL, 'refs' => [ 'AccountSettings$maxSlots' => 'The maximum number of device slots that the AWS account can purchase. Each maximum is expressed as an offering-id:number
pair, where the offering-id
represents one of the IDs returned by the ListOfferings
command.
Any additional information about the exception.
', 'CreateDevicePoolRequest$description' => 'The device pool\'s description.
', 'CreateInstanceProfileRequest$description' => 'The description of your instance profile.
', 'CreateNetworkProfileRequest$description' => 'The description of the network profile.
', 'DevicePool$description' => 'The device pool\'s description.
', 'IdempotencyException$message' => 'Any additional information about the exception.
', 'IncompatibilityMessage$message' => 'A message about the incompatibility.
', 'InstanceProfile$description' => 'The description of the instance profile.
', 'InvalidOperationException$message' => NULL, 'Job$message' => 'A message about the job\'s result.
', 'LimitExceededException$message' => 'Any additional information about the exception.
', 'NetworkProfile$description' => 'The description of the network profile.
', 'NotEligibleException$message' => 'The HTTP response code of a Not Eligible exception.
', 'NotFoundException$message' => 'Any additional information about the exception.
', 'Offering$description' => 'A string describing the offering.
', 'OfferingPromotion$description' => 'A string describing the offering promotion.
', 'Problem$message' => 'A message about the problem\'s result.
', 'RemoteAccessSession$message' => 'A message about the remote access session.
', 'Run$message' => 'A message about the run\'s result.
', 'ServiceAccountException$message' => 'Any additional information about the exception.
', 'Suite$message' => 'A message about the suite\'s result.
', 'Test$message' => 'A message about the test\'s result.
', 'UniqueProblem$message' => 'A message about the unique problems\' result.
', 'UpdateDevicePoolRequest$description' => 'A description of the device pool you wish to update.
', 'UpdateInstanceProfileRequest$description' => 'The updated description for your instance profile.
', 'UpdateNetworkProfileRequest$description' => 'The descriptoin of the network profile about which you are returning information.
', 'Upload$message' => 'A message about the upload\'s result.
', ], ], 'Metadata' => [ 'base' => NULL, 'refs' => [ 'Upload$metadata' => 'The upload\'s metadata. For example, for Android, this contains information that is parsed from the manifest and is displayed in the AWS Device Farm console after the associated app is uploaded.
', ], ], 'MonetaryAmount' => [ 'base' => 'A number representing the monetary amount for an offering or transaction.
', 'refs' => [ 'OfferingTransaction$cost' => 'The cost of an offering transaction.
', 'RecurringCharge$cost' => 'The cost of the recurring charge.
', ], ], 'Name' => [ 'base' => NULL, 'refs' => [ 'Artifact$name' => 'The artifact\'s name.
', 'CreateDevicePoolRequest$name' => 'The device pool\'s name.
', 'CreateInstanceProfileRequest$name' => 'The name of your instance profile.
', 'CreateNetworkProfileRequest$name' => 'The name you wish to specify for the new network profile.
', 'CreateProjectRequest$name' => 'The project\'s name.
', 'CreateRemoteAccessSessionRequest$name' => 'The name of the remote access session that you wish to create.
', 'CreateUploadRequest$name' => 'The upload\'s file name. The name should not contain the \'/\' character. If uploading an iOS app, the file name needs to end with the .ipa
extension. If uploading an Android app, the file name needs to end with the .apk
extension. For all others, the file name must end with the .zip
file extension.
The device\'s display name.
', 'DevicePool$name' => 'The device pool\'s name.
', 'InstanceProfile$name' => 'The name of the instance profile.
', 'Job$name' => 'The job\'s name.
', 'NetworkProfile$name' => 'The name of the network profile.
', 'ProblemDetail$name' => 'The problem detail\'s name.
', 'Project$name' => 'The project\'s name.
', 'RemoteAccessSession$name' => 'The name of the remote access session.
', 'Run$name' => 'The run\'s name.
', 'ScheduleRunRequest$name' => 'The name for the run to be scheduled.
', 'Suite$name' => 'The suite\'s name.
', 'Test$name' => 'The test\'s name.
', 'UpdateDevicePoolRequest$name' => 'A string representing the name of the device pool you wish to update.
', 'UpdateInstanceProfileRequest$name' => 'The updated name for your instance profile.
', 'UpdateNetworkProfileRequest$name' => 'The name of the network profile about which you are returning information.
', 'UpdateProjectRequest$name' => 'A string representing the new name of the project that you are updating.
', 'UpdateUploadRequest$name' => 'The upload\'s test spec file name. The name should not contain the \'/\' character. The test spec file name must end with the .yaml
or .yml
file extension.
The upload\'s file name.
', ], ], 'NetworkProfile' => [ 'base' => 'An array of settings that describes characteristics of a network profile.
', 'refs' => [ 'CreateNetworkProfileResult$networkProfile' => 'The network profile that is returned by the create network profile request.
', 'GetNetworkProfileResult$networkProfile' => 'The network profile.
', 'NetworkProfiles$member' => NULL, 'Run$networkProfile' => 'The network profile being used for a test run.
', 'UpdateNetworkProfileResult$networkProfile' => 'A list of the available network profiles.
', ], ], 'NetworkProfileType' => [ 'base' => NULL, 'refs' => [ 'CreateNetworkProfileRequest$type' => 'The type of network profile you wish to create. Valid values are listed below.
', 'ListNetworkProfilesRequest$type' => 'The type of network profile you wish to return information about. Valid values are listed below.
', 'NetworkProfile$type' => 'The type of network profile. Valid values are listed below.
', 'UpdateNetworkProfileRequest$type' => 'The type of network profile you wish to return information about. Valid values are listed below.
', ], ], 'NetworkProfiles' => [ 'base' => NULL, 'refs' => [ 'ListNetworkProfilesResult$networkProfiles' => 'A list of the available network profiles.
', ], ], 'NotEligibleException' => [ 'base' => 'Exception gets thrown when a user is not eligible to perform the specified transaction.
', 'refs' => [], ], 'NotFoundException' => [ 'base' => 'The specified entity was not found.
', 'refs' => [], ], 'Offering' => [ 'base' => 'Represents the metadata of a device offering.
', 'refs' => [ 'OfferingStatus$offering' => 'Represents the metadata of an offering status.
', 'Offerings$member' => NULL, ], ], 'OfferingIdentifier' => [ 'base' => NULL, 'refs' => [ 'Offering$id' => 'The ID that corresponds to a device offering.
', 'OfferingStatusMap$key' => NULL, 'PurchaseOfferingRequest$offeringId' => 'The ID of the offering.
', 'RenewOfferingRequest$offeringId' => 'The ID of a request to renew an offering.
', ], ], 'OfferingPromotion' => [ 'base' => 'Represents information about an offering promotion.
', 'refs' => [ 'OfferingPromotions$member' => NULL, ], ], 'OfferingPromotionIdentifier' => [ 'base' => NULL, 'refs' => [ 'OfferingPromotion$id' => 'The ID of the offering promotion.
', 'OfferingTransaction$offeringPromotionId' => 'The ID that corresponds to a device offering promotion.
', 'PurchaseOfferingRequest$offeringPromotionId' => 'The ID of the offering promotion to be applied to the purchase.
', ], ], 'OfferingPromotions' => [ 'base' => NULL, 'refs' => [ 'ListOfferingPromotionsResult$offeringPromotions' => 'Information about the offering promotions.
', ], ], 'OfferingStatus' => [ 'base' => 'The status of the offering.
', 'refs' => [ 'OfferingStatusMap$value' => NULL, 'OfferingTransaction$offeringStatus' => 'The status of an offering transaction.
', ], ], 'OfferingStatusMap' => [ 'base' => NULL, 'refs' => [ 'GetOfferingStatusResult$current' => 'When specified, gets the offering status for the current period.
', 'GetOfferingStatusResult$nextPeriod' => 'When specified, gets the offering status for the next period.
', ], ], 'OfferingTransaction' => [ 'base' => 'Represents the metadata of an offering transaction.
', 'refs' => [ 'OfferingTransactions$member' => NULL, 'PurchaseOfferingResult$offeringTransaction' => 'Represents the offering transaction for the purchase result.
', 'RenewOfferingResult$offeringTransaction' => 'Represents the status of the offering transaction for the renewal.
', ], ], 'OfferingTransactionType' => [ 'base' => NULL, 'refs' => [ 'OfferingStatus$type' => 'The type specified for the offering status.
', ], ], 'OfferingTransactions' => [ 'base' => NULL, 'refs' => [ 'ListOfferingTransactionsResult$offeringTransactions' => 'The audit log of subscriptions you have purchased and modified through AWS Device Farm.
', ], ], 'OfferingType' => [ 'base' => NULL, 'refs' => [ 'Offering$type' => 'The type of offering (e.g., "RECURRING") for a device.
', ], ], 'Offerings' => [ 'base' => NULL, 'refs' => [ 'ListOfferingsResult$offerings' => 'A value representing the list offering results.
', ], ], 'PackageIds' => [ 'base' => NULL, 'refs' => [ 'CreateInstanceProfileRequest$excludeAppPackagesFromCleanup' => 'An array of strings specifying the list of app packages that should not be cleaned up from the device after a test run is over.
The list of packages is only considered if you set packageCleanup
to true
.
An array of strings specifying the list of app packages that should not be cleaned up from the device after a test run is over.
The list of packages is only considered if you set packageCleanup
to true
.
An array of strings specifying the list of app packages that should not be cleaned up from the device after a test run is over.
The list of packages is only considered if you set packageCleanup
to true
.
An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
', 'GetOfferingStatusResult$nextToken' => 'An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
', 'ListArtifactsRequest$nextToken' => 'An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
', 'ListArtifactsResult$nextToken' => 'If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.
', 'ListDeviceInstancesRequest$nextToken' => 'An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
', 'ListDeviceInstancesResult$nextToken' => 'An identifier that can be used in the next call to this operation to return the next set of items in the list.
', 'ListDevicePoolsRequest$nextToken' => 'An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
', 'ListDevicePoolsResult$nextToken' => 'If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.
', 'ListDevicesRequest$nextToken' => 'An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
', 'ListDevicesResult$nextToken' => 'If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.
', 'ListInstanceProfilesRequest$nextToken' => 'An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
', 'ListInstanceProfilesResult$nextToken' => 'An identifier that can be used in the next call to this operation to return the next set of items in the list.
', 'ListJobsRequest$nextToken' => 'An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
', 'ListJobsResult$nextToken' => 'If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.
', 'ListNetworkProfilesRequest$nextToken' => 'An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
', 'ListNetworkProfilesResult$nextToken' => 'An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
', 'ListOfferingPromotionsRequest$nextToken' => 'An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
', 'ListOfferingPromotionsResult$nextToken' => 'An identifier to be used in the next call to this operation, to return the next set of items in the list.
', 'ListOfferingTransactionsRequest$nextToken' => 'An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
', 'ListOfferingTransactionsResult$nextToken' => 'An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
', 'ListOfferingsRequest$nextToken' => 'An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
', 'ListOfferingsResult$nextToken' => 'An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
', 'ListProjectsRequest$nextToken' => 'An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
', 'ListProjectsResult$nextToken' => 'If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.
', 'ListRemoteAccessSessionsRequest$nextToken' => 'An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
', 'ListRemoteAccessSessionsResult$nextToken' => 'An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
', 'ListRunsRequest$nextToken' => 'An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
', 'ListRunsResult$nextToken' => 'If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.
', 'ListSamplesRequest$nextToken' => 'An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
', 'ListSamplesResult$nextToken' => 'If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.
', 'ListSuitesRequest$nextToken' => 'An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
', 'ListSuitesResult$nextToken' => 'If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.
', 'ListTestsRequest$nextToken' => 'An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
', 'ListTestsResult$nextToken' => 'If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.
', 'ListUniqueProblemsRequest$nextToken' => 'An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
', 'ListUniqueProblemsResult$nextToken' => 'If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.
', 'ListUploadsRequest$nextToken' => 'An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
', 'ListUploadsResult$nextToken' => 'If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.
', 'ListVPCEConfigurationsRequest$nextToken' => 'An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
', 'ListVPCEConfigurationsResult$nextToken' => 'An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
', ], ], 'PercentInteger' => [ 'base' => NULL, 'refs' => [ 'CreateNetworkProfileRequest$uplinkLossPercent' => 'Proportion of transmitted packets that fail to arrive from 0 to 100 percent.
', 'CreateNetworkProfileRequest$downlinkLossPercent' => 'Proportion of received packets that fail to arrive from 0 to 100 percent.
', 'NetworkProfile$uplinkLossPercent' => 'Proportion of transmitted packets that fail to arrive from 0 to 100 percent.
', 'NetworkProfile$downlinkLossPercent' => 'Proportion of received packets that fail to arrive from 0 to 100 percent.
', 'UpdateNetworkProfileRequest$uplinkLossPercent' => 'Proportion of transmitted packets that fail to arrive from 0 to 100 percent.
', 'UpdateNetworkProfileRequest$downlinkLossPercent' => 'Proportion of received packets that fail to arrive from 0 to 100 percent.
', ], ], 'Problem' => [ 'base' => 'Represents a specific warning or failure.
', 'refs' => [ 'Problems$member' => NULL, ], ], 'ProblemDetail' => [ 'base' => 'Information about a problem detail.
', 'refs' => [ 'Problem$run' => 'Information about the associated run.
', 'Problem$job' => 'Information about the associated job.
', 'Problem$suite' => 'Information about the associated suite.
', 'Problem$test' => 'Information about the associated test.
', ], ], 'Problems' => [ 'base' => NULL, 'refs' => [ 'UniqueProblem$problems' => 'Information about the problems.
', ], ], 'Project' => [ 'base' => 'Represents an operating-system neutral workspace for running and managing tests.
', 'refs' => [ 'CreateProjectResult$project' => 'The newly created project.
', 'GetProjectResult$project' => 'The project you wish to get information about.
', 'Projects$member' => NULL, 'UpdateProjectResult$project' => 'The project you wish to update.
', ], ], 'Projects' => [ 'base' => NULL, 'refs' => [ 'ListProjectsResult$projects' => 'Information about the projects.
', ], ], 'PurchaseOfferingRequest' => [ 'base' => 'Represents a request for a purchase offering.
', 'refs' => [], ], 'PurchaseOfferingResult' => [ 'base' => 'The result of the purchase offering (e.g., success or failure).
', 'refs' => [], ], 'PurchasedDevicesMap' => [ 'base' => NULL, 'refs' => [ 'AccountSettings$unmeteredDevices' => 'Returns the unmetered devices you have purchased or want to purchase.
', 'AccountSettings$unmeteredRemoteAccessDevices' => 'Returns the unmetered remote access devices you have purchased or want to purchase.
', ], ], 'Radios' => [ 'base' => 'Represents the set of radios and their states on a device. Examples of radios include Wi-Fi, GPS, Bluetooth, and NFC.
', 'refs' => [ 'Run$radios' => 'Information about the radio states for the run.
', 'ScheduleRunConfiguration$radios' => 'Information about the radio states for the run.
', ], ], 'RecurringCharge' => [ 'base' => 'Specifies whether charges for devices will be recurring.
', 'refs' => [ 'RecurringCharges$member' => NULL, ], ], 'RecurringChargeFrequency' => [ 'base' => NULL, 'refs' => [ 'RecurringCharge$frequency' => 'The frequency in which charges will recur.
', ], ], 'RecurringCharges' => [ 'base' => NULL, 'refs' => [ 'Offering$recurringCharges' => 'Specifies whether there are recurring charges for the offering.
', ], ], 'RemoteAccessSession' => [ 'base' => 'Represents information about the remote access session.
', 'refs' => [ 'CreateRemoteAccessSessionResult$remoteAccessSession' => 'A container that describes the remote access session when the request to create a remote access session is sent.
', 'GetRemoteAccessSessionResult$remoteAccessSession' => 'A container that lists detailed information about the remote access session.
', 'RemoteAccessSessions$member' => NULL, 'StopRemoteAccessSessionResult$remoteAccessSession' => 'A container representing the metadata from the service about the remote access session you are stopping.
', ], ], 'RemoteAccessSessions' => [ 'base' => NULL, 'refs' => [ 'ListRemoteAccessSessionsResult$remoteAccessSessions' => 'A container representing the metadata from the service about each remote access session you are requesting.
', ], ], 'RenewOfferingRequest' => [ 'base' => 'A request representing an offering renewal.
', 'refs' => [], ], 'RenewOfferingResult' => [ 'base' => 'The result of a renewal offering.
', 'refs' => [], ], 'Resolution' => [ 'base' => 'Represents the screen resolution of a device in height and width, expressed in pixels.
', 'refs' => [ 'Device$resolution' => 'The resolution of the device.
', ], ], 'Rule' => [ 'base' => 'Represents a condition for a device pool. It is passed in as the rules
parameter to CreateDevicePool and UpdateDevicePool.
The rule\'s operator.
EQUALS: The equals operator.
GREATER_THAN: The greater-than operator.
IN: The in operator.
LESS_THAN: The less-than operator.
NOT_IN: The not-in operator.
CONTAINS: The contains operator.
The device pool\'s rules.
', 'DevicePool$rules' => 'Information about the device pool\'s rules.
', 'UpdateDevicePoolRequest$rules' => 'Represents the rules you wish to modify for the device pool. Updating rules is optional; however, if you choose to update rules for your request, the update will replace the existing rules.
', ], ], 'Run' => [ 'base' => 'Represents a test run on a set of devices with a given app package, test parameters, etc.
', 'refs' => [ 'GetRunResult$run' => 'The run you wish to get results from.
', 'Runs$member' => NULL, 'ScheduleRunResult$run' => 'Information about the scheduled run.
', 'StopRunResult$run' => 'The run that was stopped.
', ], ], 'Runs' => [ 'base' => NULL, 'refs' => [ 'ListRunsResult$runs' => 'Information about the runs.
', ], ], 'Sample' => [ 'base' => 'Represents a sample of performance data.
', 'refs' => [ 'Samples$member' => NULL, ], ], 'SampleType' => [ 'base' => NULL, 'refs' => [ 'Sample$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 child processes) as reported by process, as a percentage.
MEMORY: A memory usage sample type. This is expressed as the total proportional set size of an app 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 app process.
TX
TX_RATE: The total number of bytes per second (TCP and UDP) that are received, by app process.
Information about the samples.
', ], ], 'ScheduleRunConfiguration' => [ 'base' => 'Represents the settings for a run. Includes things like location, radio states, auxiliary apps, and network profiles.
', 'refs' => [ 'GetDevicePoolCompatibilityRequest$configuration' => 'An object containing information about the settings for a run.
', 'ScheduleRunRequest$configuration' => 'Information about the settings for the run to be scheduled.
', ], ], 'ScheduleRunRequest' => [ 'base' => 'Represents a request to the schedule run operation.
', 'refs' => [], ], 'ScheduleRunResult' => [ 'base' => 'Represents the result of a schedule run request.
', 'refs' => [], ], 'ScheduleRunTest' => [ 'base' => 'Represents test settings. This data structure is passed in as the "test" parameter to ScheduleRun. For an example of the JSON request syntax, see ScheduleRun.
', 'refs' => [ 'GetDevicePoolCompatibilityRequest$test' => 'Information about the uploaded test to be run against the device pool.
', 'ScheduleRunRequest$test' => 'Information about the test for the run to be scheduled.
', ], ], 'ServiceAccountException' => [ 'base' => 'There was a problem with the service account.
', 'refs' => [], ], 'ServiceDnsName' => [ 'base' => NULL, 'refs' => [ 'CreateVPCEConfigurationRequest$serviceDnsName' => 'The DNS name of the service running in your VPC that you want Device Farm to test.
', 'UpdateVPCEConfigurationRequest$serviceDnsName' => 'The DNS (domain) name used to connect to your private service in your Amazon VPC. The DNS name must not already be in use on the Internet.
', 'VPCEConfiguration$serviceDnsName' => 'The DNS name that maps to the private IP address of the service you want to access.
', ], ], 'SkipAppResign' => [ 'base' => NULL, 'refs' => [ 'AccountSettings$skipAppResign' => 'When set to true
, for private devices, Device Farm will not sign your app again. For public devices, Device Farm always signs your apps again and this parameter has no effect.
For more information about how Device Farm re-signs your app(s), see Do you modify my app? in the AWS Device Farm FAQs.
', 'ExecutionConfiguration$skipAppResign' => 'When set to true
, for private devices, Device Farm will not sign your app again. For public devices, Device Farm always signs your apps again and this parameter has no effect.
For more information about how Device Farm re-signs your app(s), see Do you modify my app? in the AWS Device Farm FAQs.
', 'RemoteAccessSession$skipAppResign' => 'When set to true
, for private devices, Device Farm will not sign your app again. For public devices, Device Farm always signs your apps again and this parameter has no effect.
For more information about how Device Farm re-signs your app(s), see Do you modify my app? in the AWS Device Farm FAQs.
', 'Run$skipAppResign' => 'When set to true
, for private devices, Device Farm will not sign your app again. For public devices, Device Farm always signs your apps again and this parameter has no effect.
For more information about how Device Farm re-signs your app(s), see Do you modify my app? in the AWS Device Farm FAQs.
', ], ], 'SshPublicKey' => [ 'base' => NULL, 'refs' => [ 'CreateRemoteAccessSessionRequest$sshPublicKey' => 'The public key of the ssh
key pair you want to use for connecting to remote devices in your remote debugging session. This is only required if remoteDebugEnabled
is set to true
.
Represents the request to stop the remote access session.
', 'refs' => [], ], 'StopRemoteAccessSessionResult' => [ 'base' => 'Represents the response from the server that describes the remote access session when AWS Device Farm stops the session.
', 'refs' => [], ], 'StopRunRequest' => [ 'base' => 'Represents the request to stop a specific run.
', 'refs' => [], ], 'StopRunResult' => [ 'base' => 'Represents the results of your stop run attempt.
', 'refs' => [], ], 'String' => [ 'base' => NULL, 'refs' => [ 'AndroidPaths$member' => NULL, 'Artifact$extension' => 'The artifact\'s file extension.
', 'CPU$frequency' => 'The CPU\'s frequency.
', 'CPU$architecture' => 'The CPU\'s architecture, for example x86 or ARM.
', 'Device$manufacturer' => 'The device\'s manufacturer name.
', 'Device$model' => 'The device\'s model name.
', 'Device$modelId' => 'The device\'s model ID.
', 'Device$os' => 'The device\'s operating system type.
', 'Device$image' => 'The device\'s image name.
', 'Device$carrier' => 'The device\'s carrier.
', 'Device$radio' => 'The device\'s radio.
', 'Device$fleetType' => 'The type of fleet to which this device belongs. Possible values for fleet type are PRIVATE and PUBLIC.
', 'Device$fleetName' => 'The name of the fleet to which this device belongs.
', 'DeviceFilterValues$member' => NULL, 'DeviceHostPaths$member' => NULL, 'DeviceInstance$udid' => 'Unique device identifier for the device instance.
', 'InstanceLabels$member' => NULL, 'IosPaths$member' => NULL, 'Job$videoEndpoint' => 'The endpoint for streaming device video.
', 'MaxSlotMap$key' => NULL, 'PackageIds$member' => NULL, 'RemoteAccessSession$endpoint' => 'The endpoint for the remote access sesssion.
', 'RemoteAccessSession$deviceUdid' => 'Unique device identifier for the remote device. Only returned if remote debugging is enabled for the remote access session.
', 'Rule$value' => 'The rule\'s value.
The value must be passed in as a string using escaped quotes.
For example:
"value": "\\"ANDROID\\""
', 'Run$parsingResultUrl' => 'Read-only URL for an object in S3 bucket where you can get the parsing results of the test package. If the test package doesn\'t parse, the reason why it doesn\'t parse appears in the file that this URL points to.
', 'Run$locale' => 'Information about the locale that is used for the run.
', 'Run$webUrl' => 'The Device Farm console URL for the recording of the run.
', 'ScheduleRunConfiguration$locale' => 'Information about the locale that is used for the run.
', 'TestParameters$key' => NULL, 'TestParameters$value' => NULL, ], ], 'Suite' => [ 'base' => 'Represents a collection of one or more tests.
', 'refs' => [ 'GetSuiteResult$suite' => 'A collection of one or more tests.
', 'Suites$member' => NULL, ], ], 'Suites' => [ 'base' => NULL, 'refs' => [ 'ListSuitesResult$suites' => 'Information about the suites.
', ], ], 'Test' => [ 'base' => 'Represents a condition that is evaluated.
', 'refs' => [ 'GetTestResult$test' => 'A test condition that is evaluated.
', 'Tests$member' => NULL, ], ], 'TestParameters' => [ 'base' => NULL, 'refs' => [ 'ScheduleRunTest$parameters' => 'The test\'s parameters, such as test framework parameters and fixture settings. Parameters are represented 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.7.2", "1.7.1", "1.6.5", "latest", and "default".
“latest” will run the latest Appium version supported by Device Farm (1.7.2).
For “default”, Device Farm will choose 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, 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 username to use if the Explorer encounters a login form. If not supplied, no username will be inserted.
password: A password to use if the Explorer encounters a login form. If not supplied, no password will be 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"
The test type for the specified device pool.
Allowed values include the following:
BUILTIN_FUZZ: The built-in fuzz type.
BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time.
APPIUM_JAVA_JUNIT: The Appium Java JUnit type.
APPIUM_JAVA_TESTNG: The Appium Java TestNG type.
APPIUM_PYTHON: The Appium Python type.
APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for Web apps.
APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for Web apps.
APPIUM_WEB_PYTHON: The Appium Python type for Web apps.
CALABASH: The Calabash type.
INSTRUMENTATION: The Instrumentation type.
UIAUTOMATION: The uiautomation type.
UIAUTOMATOR: The uiautomator type.
XCTEST: The XCode test type.
XCTEST_UI: The XCode UI test type.
The job\'s type.
Allowed values include the following:
BUILTIN_FUZZ: The built-in fuzz type.
BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time.
APPIUM_JAVA_JUNIT: The Appium Java JUnit type.
APPIUM_JAVA_TESTNG: The Appium Java TestNG type.
APPIUM_PYTHON: The Appium Python type.
APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for Web apps.
APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for Web apps.
APPIUM_WEB_PYTHON: The Appium Python type for Web apps.
CALABASH: The Calabash type.
INSTRUMENTATION: The Instrumentation type.
UIAUTOMATION: The uiautomation type.
UIAUTOMATOR: The uiautomator type.
XCTEST: The XCode test type.
XCTEST_UI: The XCode UI test type.
The run\'s type.
Must be one of the following values:
BUILTIN_FUZZ: The built-in fuzz type.
BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time.
APPIUM_JAVA_JUNIT: The Appium Java JUnit type.
APPIUM_JAVA_TESTNG: The Appium Java TestNG type.
APPIUM_PYTHON: The Appium Python type.
APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for Web apps.
APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for Web apps.
APPIUM_WEB_PYTHON: The Appium Python type for Web apps.
CALABASH: The Calabash type.
INSTRUMENTATION: The Instrumentation type.
UIAUTOMATION: The uiautomation type.
UIAUTOMATOR: The uiautomator type.
XCTEST: The XCode test type.
XCTEST_UI: The XCode UI test type.
The test\'s type.
Must be one of the following values:
BUILTIN_FUZZ: The built-in fuzz type.
BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time.
APPIUM_JAVA_JUNIT: The Appium Java JUnit type.
APPIUM_JAVA_TESTNG: The Appium Java TestNG type.
APPIUM_PYTHON: The Appium Python type.
APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for Web apps.
APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for Web apps.
APPIUM_WEB_PYTHON: The Appium Python type for Web apps.
CALABASH: The Calabash type.
INSTRUMENTATION: The Instrumentation type.
UIAUTOMATION: The uiautomation type.
UIAUTOMATOR: The uiautomator type.
XCTEST: The XCode test type.
XCTEST_UI: The XCode UI test type.
The suite\'s type.
Must be one of the following values:
BUILTIN_FUZZ: The built-in fuzz type.
BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time.
APPIUM_JAVA_JUNIT: The Appium Java JUnit type.
APPIUM_JAVA_TESTNG: The Appium Java TestNG type.
APPIUM_PYTHON: The Appium Python type.
APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for Web apps.
APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for Web apps.
APPIUM_WEB_PYTHON: The Appium Python type for Web apps.
CALABASH: The Calabash type.
INSTRUMENTATION: The Instrumentation type.
UIAUTOMATION: The uiautomation type.
UIAUTOMATOR: The uiautomator type.
XCTEST: The XCode test type.
XCTEST_UI: The XCode UI test type.
The test\'s type.
Must be one of the following values:
BUILTIN_FUZZ: The built-in fuzz type.
BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time.
APPIUM_JAVA_JUNIT: The Appium Java JUnit type.
APPIUM_JAVA_TESTNG: The Appium Java TestNG type.
APPIUM_PYTHON: The Appium Python type.
APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for Web apps.
APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for Web apps.
APPIUM_WEB_PYTHON: The Appium Python type for Web apps.
CALABASH: The Calabash type.
INSTRUMENTATION: The Instrumentation type.
UIAUTOMATION: The uiautomation type.
UIAUTOMATOR: The uiautomator type.
XCTEST: The XCode test type.
XCTEST_UI: The XCode UI test type.
Information about the tests.
', ], ], 'TransactionIdentifier' => [ 'base' => NULL, 'refs' => [ 'OfferingTransaction$transactionId' => 'The transaction ID of the offering transaction.
', ], ], 'TrialMinutes' => [ 'base' => 'Represents information about free trial device minutes for an AWS account.
', 'refs' => [ 'AccountSettings$trialMinutes' => 'Information about an AWS account\'s usage of free trial device minutes.
', ], ], 'URL' => [ 'base' => NULL, 'refs' => [ 'Artifact$url' => 'The pre-signed Amazon S3 URL that can be used with a corresponding GET request to download the artifact\'s file.
', 'Sample$url' => 'The pre-signed Amazon S3 URL that can be used with a corresponding GET request to download the sample\'s file.
', 'Upload$url' => 'The pre-signed Amazon S3 URL that was used to store a file through a corresponding PUT request.
', ], ], 'UniqueProblem' => [ 'base' => 'A collection of one or more problems, grouped by their result.
', 'refs' => [ 'UniqueProblems$member' => NULL, ], ], 'UniqueProblems' => [ 'base' => NULL, 'refs' => [ 'UniqueProblemsByExecutionResultMap$value' => NULL, ], ], 'UniqueProblemsByExecutionResultMap' => [ 'base' => NULL, 'refs' => [ 'ListUniqueProblemsResult$uniqueProblems' => 'Information about the unique problems.
Allowed values include:
PENDING: A pending condition.
PASSED: A passing condition.
WARNED: A warning condition.
FAILED: A failed condition.
SKIPPED: A skipped condition.
ERRORED: An error condition.
STOPPED: A stopped condition.
Represents a request to the update device pool operation.
', 'refs' => [], ], 'UpdateDevicePoolResult' => [ 'base' => 'Represents the result of an update device pool request.
', 'refs' => [], ], 'UpdateInstanceProfileRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateInstanceProfileResult' => [ 'base' => NULL, 'refs' => [], ], 'UpdateNetworkProfileRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateNetworkProfileResult' => [ 'base' => NULL, 'refs' => [], ], 'UpdateProjectRequest' => [ 'base' => 'Represents a request to the update project operation.
', 'refs' => [], ], 'UpdateProjectResult' => [ 'base' => 'Represents the result of an update project request.
', 'refs' => [], ], 'UpdateUploadRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateUploadResult' => [ 'base' => NULL, 'refs' => [], ], 'UpdateVPCEConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateVPCEConfigurationResult' => [ 'base' => NULL, 'refs' => [], ], 'Upload' => [ 'base' => 'An app or a set of one or more tests to upload or that have been uploaded.
', 'refs' => [ 'CreateUploadResult$upload' => 'The newly created upload.
', 'GetUploadResult$upload' => 'An app or a set of one or more tests to upload or that have been uploaded.
', 'InstallToRemoteAccessSessionResult$appUpload' => 'An app to upload or that has been uploaded.
', 'UpdateUploadResult$upload' => 'A test spec uploaded to Device Farm.
', 'Uploads$member' => NULL, ], ], 'UploadCategory' => [ 'base' => NULL, 'refs' => [ 'Upload$category' => '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.
The upload\'s status.
Must be one of the following values:
FAILED: A failed status.
INITIALIZED: An initialized status.
PROCESSING: A processing status.
SUCCEEDED: A succeeded status.
The upload\'s upload type.
Must be one of the following values:
ANDROID_APP: An Android upload.
IOS_APP: An iOS upload.
WEB_APP: A web application upload.
EXTERNAL_DATA: An external data upload.
APPIUM_JAVA_JUNIT_TEST_PACKAGE: An Appium Java JUnit test package upload.
APPIUM_JAVA_TESTNG_TEST_PACKAGE: An Appium Java TestNG test package upload.
APPIUM_PYTHON_TEST_PACKAGE: An Appium Python test package upload.
APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE: An Appium Java JUnit test package upload.
APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE: An Appium Java TestNG test package upload.
APPIUM_WEB_PYTHON_TEST_PACKAGE: An Appium Python test package upload.
CALABASH_TEST_PACKAGE: A Calabash test package upload.
INSTRUMENTATION_TEST_PACKAGE: An instrumentation upload.
UIAUTOMATION_TEST_PACKAGE: A uiautomation test package upload.
UIAUTOMATOR_TEST_PACKAGE: A uiautomator test package upload.
XCTEST_TEST_PACKAGE: An XCode test package upload.
XCTEST_UI_TEST_PACKAGE: An XCode UI test package upload.
APPIUM_JAVA_JUNIT_TEST_SPEC: An Appium Java JUnit test spec upload.
APPIUM_JAVA_TESTNG_TEST_SPEC: An Appium Java TestNG test spec upload.
APPIUM_PYTHON_TEST_SPEC: An Appium Python test spec upload.
APPIUM_WEB_JAVA_JUNIT_TEST_SPEC: An Appium Java JUnit test spec upload.
APPIUM_WEB_JAVA_TESTNG_TEST_SPEC: An Appium Java TestNG test spec upload.
APPIUM_WEB_PYTHON_TEST_SPEC: An Appium Python test spec upload.
INSTRUMENTATION_TEST_SPEC: An instrumentation test spec upload.
XCTEST_UI_TEST_SPEC: An XCode UI test spec upload.
Note If you call CreateUpload
with WEB_APP
specified, AWS Device Farm throws an ArgumentException
error.
The type of upload.
Must be one of the following values:
ANDROID_APP: An Android upload.
IOS_APP: An iOS upload.
WEB_APP: A web appliction upload.
EXTERNAL_DATA: An external data upload.
APPIUM_JAVA_JUNIT_TEST_PACKAGE: An Appium Java JUnit test package upload.
APPIUM_JAVA_TESTNG_TEST_PACKAGE: An Appium Java TestNG test package upload.
APPIUM_PYTHON_TEST_PACKAGE: An Appium Python test package upload.
APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE: An Appium Java JUnit test package upload.
APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE: An Appium Java TestNG test package upload.
APPIUM_WEB_PYTHON_TEST_PACKAGE: An Appium Python test package upload.
CALABASH_TEST_PACKAGE: A Calabash test package upload.
INSTRUMENTATION_TEST_PACKAGE: An instrumentation upload.
UIAUTOMATION_TEST_PACKAGE: A uiautomation test package upload.
UIAUTOMATOR_TEST_PACKAGE: A uiautomator test package upload.
XCTEST_TEST_PACKAGE: An XCode test package upload.
XCTEST_UI_TEST_PACKAGE: An XCode UI test package upload.
APPIUM_JAVA_JUNIT_TEST_SPEC: An Appium Java JUnit test spec upload.
APPIUM_JAVA_TESTNG_TEST_SPEC: An Appium Java TestNG test spec upload.
APPIUM_PYTHON_TEST_SPEC: An Appium Python test spec upload.
APPIUM_WEB_JAVA_JUNIT_TEST_SPEC: An Appium Java JUnit test spec upload.
APPIUM_WEB_JAVA_TESTNG_TEST_SPEC: An Appium Java TestNG test spec upload.
APPIUM_WEB_PYTHON_TEST_SPEC: An Appium Python test spec upload.
INSTRUMENTATION_TEST_SPEC: An instrumentation test spec upload.
XCTEST_UI_TEST_SPEC: An XCode UI test spec upload.
The upload\'s type.
Must be one of the following values:
ANDROID_APP: An Android upload.
IOS_APP: An iOS upload.
WEB_APP: A web appliction upload.
EXTERNAL_DATA: An external data upload.
APPIUM_JAVA_JUNIT_TEST_PACKAGE: An Appium Java JUnit test package upload.
APPIUM_JAVA_TESTNG_TEST_PACKAGE: An Appium Java TestNG test package upload.
APPIUM_PYTHON_TEST_PACKAGE: An Appium Python test package upload.
APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE: An Appium Java JUnit test package upload.
APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE: An Appium Java TestNG test package upload.
APPIUM_WEB_PYTHON_TEST_PACKAGE: An Appium Python test package upload.
CALABASH_TEST_PACKAGE: A Calabash test package upload.
INSTRUMENTATION_TEST_PACKAGE: An instrumentation upload.
UIAUTOMATION_TEST_PACKAGE: A uiautomation test package upload.
UIAUTOMATOR_TEST_PACKAGE: A uiautomator test package upload.
XCTEST_TEST_PACKAGE: An XCode test package upload.
XCTEST_UI_TEST_PACKAGE: An XCode UI test package upload.
APPIUM_JAVA_JUNIT_TEST_SPEC: An Appium Java JUnit test spec upload.
APPIUM_JAVA_TESTNG_TEST_SPEC: An Appium Java TestNG test spec upload.
APPIUM_PYTHON_TEST_SPEC: An Appium Python test spec upload.
APPIUM_WEB_JAVA_JUNIT_TEST_SPEC: An Appium Java JUnit test spec upload.
APPIUM_WEB_JAVA_TESTNG_TEST_SPEC: An Appium Java TestNG test spec upload.
APPIUM_WEB_PYTHON_TEST_SPEC: An Appium Python test spec upload.
INSTRUMENTATION_TEST_SPEC: An instrumentation test spec upload.
XCTEST_UI_TEST_SPEC: An XCode UI test spec upload.
Information about the uploads.
', ], ], 'VPCEConfiguration' => [ 'base' => 'Represents an Amazon Virtual Private Cloud (VPC) endpoint configuration.
', 'refs' => [ 'CreateVPCEConfigurationResult$vpceConfiguration' => 'An object containing information about your VPC endpoint configuration.
', 'GetVPCEConfigurationResult$vpceConfiguration' => 'An object containing information about your VPC endpoint configuration.
', 'UpdateVPCEConfigurationResult$vpceConfiguration' => 'An object containing information about your VPC endpoint configuration.
', 'VPCEConfigurations$member' => NULL, ], ], 'VPCEConfigurationDescription' => [ 'base' => NULL, 'refs' => [ 'CreateVPCEConfigurationRequest$vpceConfigurationDescription' => 'An optional description, providing more details about your VPC endpoint configuration.
', 'UpdateVPCEConfigurationRequest$vpceConfigurationDescription' => 'An optional description, providing more details about your VPC endpoint configuration.
', 'VPCEConfiguration$vpceConfigurationDescription' => 'An optional description, providing more details about your VPC endpoint configuration.
', ], ], 'VPCEConfigurationName' => [ 'base' => NULL, 'refs' => [ 'CreateVPCEConfigurationRequest$vpceConfigurationName' => 'The friendly name you give to your VPC endpoint configuration, to manage your configurations more easily.
', 'UpdateVPCEConfigurationRequest$vpceConfigurationName' => 'The friendly name you give to your VPC endpoint configuration, to manage your configurations more easily.
', 'VPCEConfiguration$vpceConfigurationName' => 'The friendly name you give to your VPC endpoint configuration, to manage your configurations more easily.
', ], ], 'VPCEConfigurations' => [ 'base' => NULL, 'refs' => [ 'ListVPCEConfigurationsResult$vpceConfigurations' => 'An array of VPCEConfiguration
objects containing information about your VPC endpoint configuration.
The name of the VPC endpoint service running inside your AWS account that you want Device Farm to test.
', 'UpdateVPCEConfigurationRequest$vpceServiceName' => 'The name of the VPC endpoint service running inside your AWS account that you want Device Farm to test.
', 'VPCEConfiguration$vpceServiceName' => 'The name of the VPC endpoint service running inside your AWS account that you want Device Farm to test.
', ], ], 'VideoCapture' => [ 'base' => NULL, 'refs' => [ 'ExecutionConfiguration$videoCapture' => 'Set to true to enable video capture; otherwise, set to false. The default is true.
', 'Job$videoCapture' => 'This value is set to true if video capture is enabled; otherwise, it is set to false.
', ], ], ],]; +return [ 'version' => '2.0', 'service' => 'AWS Device Farm is a service that enables mobile app developers to test Android, iOS, and Fire OS apps on physical phones, tablets, and other devices in the cloud.
', 'operations' => [ 'CreateDevicePool' => 'Creates a device pool.
', 'CreateInstanceProfile' => 'Creates a profile that can be applied to one or more private fleet device instances.
', 'CreateNetworkProfile' => 'Creates a network profile.
', 'CreateProject' => 'Creates a new project.
', 'CreateRemoteAccessSession' => 'Specifies and starts a remote access session.
', 'CreateUpload' => 'Uploads an app or test scripts.
', 'CreateVPCEConfiguration' => 'Creates a configuration record in Device Farm for your Amazon Virtual Private Cloud (VPC) endpoint.
', 'DeleteDevicePool' => 'Deletes a device pool given the pool ARN. Does not allow deletion of curated pools owned by the system.
', 'DeleteInstanceProfile' => 'Deletes a profile that can be applied to one or more private device instances.
', 'DeleteNetworkProfile' => 'Deletes a network profile.
', 'DeleteProject' => 'Deletes an AWS Device Farm project, given the project ARN.
Note Deleting this resource does not stop an in-progress run.
', 'DeleteRemoteAccessSession' => 'Deletes a completed remote access session and its results.
', 'DeleteRun' => 'Deletes the run, given the run ARN.
Note Deleting this resource does not stop an in-progress run.
', 'DeleteUpload' => 'Deletes an upload given the upload ARN.
', 'DeleteVPCEConfiguration' => 'Deletes a configuration for your Amazon Virtual Private Cloud (VPC) endpoint.
', 'GetAccountSettings' => 'Returns the number of unmetered iOS and/or unmetered Android devices that have been purchased by the account.
', 'GetDevice' => 'Gets information about a unique device type.
', 'GetDeviceInstance' => 'Returns information about a device instance belonging to a private device fleet.
', 'GetDevicePool' => 'Gets information about a device pool.
', 'GetDevicePoolCompatibility' => 'Gets information about compatibility with a device pool.
', 'GetInstanceProfile' => 'Returns information about the specified instance profile.
', 'GetJob' => 'Gets information about a job.
', 'GetNetworkProfile' => 'Returns information about a network profile.
', 'GetOfferingStatus' => 'Gets the current status and future status of all offerings purchased by an AWS account. The response indicates how many offerings are currently available and the offerings that will be available in the next period. The API returns a NotEligible
error if the user is not permitted to invoke the operation. Please contact aws-devicefarm-support@amazon.com if you believe that you should be able to invoke this operation.
Gets information about a project.
', 'GetRemoteAccessSession' => 'Returns a link to a currently running remote access session.
', 'GetRun' => 'Gets information about a run.
', 'GetSuite' => 'Gets information about a suite.
', 'GetTest' => 'Gets information about a test.
', 'GetUpload' => 'Gets information about an upload.
', 'GetVPCEConfiguration' => 'Returns information about the configuration settings for your Amazon Virtual Private Cloud (VPC) endpoint.
', 'InstallToRemoteAccessSession' => 'Installs an application to the device in a remote access session. For Android applications, the file must be in .apk format. For iOS applications, the file must be in .ipa format.
', 'ListArtifacts' => 'Gets information about artifacts.
', 'ListDeviceInstances' => 'Returns information about the private device instances associated with one or more AWS accounts.
', 'ListDevicePools' => 'Gets information about device pools.
', 'ListDevices' => 'Gets information about unique device types.
', 'ListInstanceProfiles' => 'Returns information about all the instance profiles in an AWS account.
', 'ListJobs' => 'Gets information about jobs for a given test run.
', 'ListNetworkProfiles' => 'Returns the list of available network profiles.
', 'ListOfferingPromotions' => 'Returns a list of offering promotions. Each offering promotion record contains the ID and description of the promotion. The API returns a NotEligible
error if the caller is not permitted to invoke the operation. Contact aws-devicefarm-support@amazon.com if you believe that you should be able to invoke this operation.
Returns 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 API returns a NotEligible
error if the user is not permitted to invoke the operation. Please contact aws-devicefarm-support@amazon.com if you believe that you should be able to invoke this operation.
Returns a list of products or offerings that the user can manage through the API. Each offering record indicates the recurring price per unit and the frequency for that offering. The API returns a NotEligible
error if the user is not permitted to invoke the operation. Please contact aws-devicefarm-support@amazon.com if you believe that you should be able to invoke this operation.
Gets information about projects.
', 'ListRemoteAccessSessions' => 'Returns a list of all currently running remote access sessions.
', 'ListRuns' => 'Gets information about runs, given an AWS Device Farm project ARN.
', 'ListSamples' => 'Gets information about samples, given an AWS Device Farm job ARN.
', 'ListSuites' => 'Gets information about test suites for a given job.
', 'ListTests' => 'Gets information about tests in a given test suite.
', 'ListUniqueProblems' => 'Gets information about unique problems.
', 'ListUploads' => 'Gets information about uploads, given an AWS Device Farm project ARN.
', 'ListVPCEConfigurations' => 'Returns information about all Amazon Virtual Private Cloud (VPC) endpoint configurations in the AWS account.
', 'PurchaseOffering' => 'Immediately purchases offerings for an AWS account. Offerings renew with the latest total purchased quantity for an offering, unless the renewal was overridden. The API returns a NotEligible
error if the user is not permitted to invoke the operation. Please contact aws-devicefarm-support@amazon.com if you believe that you should be able to invoke this operation.
Explicitly sets the quantity of devices to renew for an offering, starting from the effectiveDate
of the next period. The API returns a NotEligible
error if the user is not permitted to invoke the operation. Please contact aws-devicefarm-support@amazon.com if you believe that you should be able to invoke this operation.
Schedules a run.
', 'StopJob' => 'Initiates a stop request for the current job. AWS Device Farm will immediately stop the job on the device where tests have not started executing, and you will not be billed for this device. On the device where tests have started executing, Setup Suite and Teardown Suite tests will run to completion before stopping execution on the device. You will be billed for Setup, Teardown, and any tests that were in progress or already completed.
', 'StopRemoteAccessSession' => 'Ends a specified remote access session.
', 'StopRun' => 'Initiates a stop request for the current test run. AWS Device Farm will immediately stop the run on devices where tests have not started executing, and you will not be billed for these devices. On devices where tests have started executing, Setup Suite and Teardown Suite tests will run to completion before stopping execution on those devices. You will be billed for Setup, Teardown, and any tests that were in progress or already completed.
', 'UpdateDeviceInstance' => 'Updates information about an existing private device instance.
', 'UpdateDevicePool' => 'Modifies the name, description, and rules in a device pool given the attributes and the pool ARN. Rule updates are all-or-nothing, meaning they can only be updated as a whole (or not at all).
', 'UpdateInstanceProfile' => 'Updates information about an existing private device instance profile.
', 'UpdateNetworkProfile' => 'Updates the network profile with specific settings.
', 'UpdateProject' => 'Modifies the specified project name, given the project ARN and a new name.
', 'UpdateUpload' => 'Update an uploaded test specification (test spec).
', 'UpdateVPCEConfiguration' => 'Updates information about an existing Amazon Virtual Private Cloud (VPC) endpoint configuration.
', ], 'shapes' => [ 'AWSAccountNumber' => [ 'base' => NULL, 'refs' => [ 'AccountSettings$awsAccountNumber' => 'The AWS account number specified in the AccountSettings
container.
A container for account-level settings within AWS Device Farm.
', 'refs' => [ 'GetAccountSettingsResult$accountSettings' => 'The account settings.
', ], ], 'AccountsCleanup' => [ 'base' => NULL, 'refs' => [ 'ExecutionConfiguration$accountsCleanup' => 'True if account cleanup is enabled at the beginning of the test; otherwise, false.
', ], ], 'AmazonResourceName' => [ 'base' => NULL, 'refs' => [ 'AmazonResourceNames$member' => NULL, 'Artifact$arn' => 'The artifact\'s ARN.
', 'CreateDevicePoolRequest$projectArn' => 'The ARN of the project for the device pool.
', 'CreateNetworkProfileRequest$projectArn' => 'The Amazon Resource Name (ARN) of the project for which you want to create a network profile.
', 'CreateRemoteAccessSessionRequest$projectArn' => 'The Amazon Resource Name (ARN) of the project for which you want to create a remote access session.
', 'CreateRemoteAccessSessionRequest$deviceArn' => 'The Amazon Resource Name (ARN) of the device for which you want to create a remote access session.
', 'CreateRemoteAccessSessionRequest$instanceArn' => 'The Amazon Resource Name (ARN) of the device instance for which you want to create a remote access session.
', 'CreateRemoteAccessSessionRequest$remoteRecordAppArn' => 'The Amazon Resource Name (ARN) for the app to be recorded in the remote access session.
', 'CreateUploadRequest$projectArn' => 'The ARN of the project for the upload.
', 'DeleteDevicePoolRequest$arn' => 'Represents the Amazon Resource Name (ARN) of the Device Farm device pool you wish to delete.
', 'DeleteInstanceProfileRequest$arn' => 'The Amazon Resource Name (ARN) of the instance profile you are requesting to delete.
', 'DeleteNetworkProfileRequest$arn' => 'The Amazon Resource Name (ARN) of the network profile you want to delete.
', 'DeleteProjectRequest$arn' => 'Represents the Amazon Resource Name (ARN) of the Device Farm project you wish to delete.
', 'DeleteRemoteAccessSessionRequest$arn' => 'The Amazon Resource Name (ARN) of the sesssion for which you want to delete remote access.
', 'DeleteRunRequest$arn' => 'The Amazon Resource Name (ARN) for the run you wish to delete.
', 'DeleteUploadRequest$arn' => 'Represents the Amazon Resource Name (ARN) of the Device Farm upload you wish to delete.
', 'DeleteVPCEConfigurationRequest$arn' => 'The Amazon Resource Name (ARN) of the VPC endpoint configuration you want to delete.
', 'Device$arn' => 'The device\'s ARN.
', 'DeviceInstance$arn' => 'The Amazon Resource Name (ARN) of the device instance.
', 'DeviceInstance$deviceArn' => 'The Amazon Resource Name (ARN) of the device.
', 'DevicePool$arn' => 'The device pool\'s ARN.
', 'GetDeviceInstanceRequest$arn' => 'The Amazon Resource Name (ARN) of the instance you\'re requesting information about.
', 'GetDevicePoolCompatibilityRequest$devicePoolArn' => 'The device pool\'s ARN.
', 'GetDevicePoolCompatibilityRequest$appArn' => 'The ARN of the app that is associated with the specified device pool.
', 'GetDevicePoolRequest$arn' => 'The device pool\'s ARN.
', 'GetDeviceRequest$arn' => 'The device type\'s ARN.
', 'GetInstanceProfileRequest$arn' => 'The Amazon Resource Name (ARN) of your instance profile.
', 'GetJobRequest$arn' => 'The job\'s ARN.
', 'GetNetworkProfileRequest$arn' => 'The Amazon Resource Name (ARN) of the network profile you want to return information about.
', 'GetProjectRequest$arn' => 'The project\'s ARN.
', 'GetRemoteAccessSessionRequest$arn' => 'The Amazon Resource Name (ARN) of the remote access session about which you want to get session information.
', 'GetRunRequest$arn' => 'The run\'s ARN.
', 'GetSuiteRequest$arn' => 'The suite\'s ARN.
', 'GetTestRequest$arn' => 'The test\'s ARN.
', 'GetUploadRequest$arn' => 'The upload\'s ARN.
', 'GetVPCEConfigurationRequest$arn' => 'The Amazon Resource Name (ARN) of the VPC endpoint configuration you want to describe.
', 'InstallToRemoteAccessSessionRequest$remoteAccessSessionArn' => 'The Amazon Resource Name (ARN) of the remote access session about which you are requesting information.
', 'InstallToRemoteAccessSessionRequest$appArn' => 'The Amazon Resource Name (ARN) of the app about which you are requesting information.
', 'InstanceProfile$arn' => 'The Amazon Resource Name (ARN) of the instance profile.
', 'Job$arn' => 'The job\'s ARN.
', 'Job$instanceArn' => 'The Amazon Resource Name (ARN) of the instance.
', 'ListArtifactsRequest$arn' => 'The Run, Job, Suite, or Test ARN.
', 'ListDevicePoolsRequest$arn' => 'The project ARN.
', 'ListDevicesRequest$arn' => 'The Amazon Resource Name (ARN) of the project.
', 'ListJobsRequest$arn' => 'The run\'s Amazon Resource Name (ARN).
', 'ListNetworkProfilesRequest$arn' => 'The Amazon Resource Name (ARN) of the project for which you want to list network profiles.
', 'ListProjectsRequest$arn' => 'Optional. If no Amazon Resource Name (ARN) is specified, then AWS Device Farm returns a list of all projects for the AWS account. You can also specify a project ARN.
', 'ListRemoteAccessSessionsRequest$arn' => 'The Amazon Resource Name (ARN) of the remote access session about which you are requesting information.
', 'ListRunsRequest$arn' => 'The Amazon Resource Name (ARN) of the project for which you want to list runs.
', 'ListSamplesRequest$arn' => 'The Amazon Resource Name (ARN) of the job used to list samples.
', 'ListSuitesRequest$arn' => 'The job\'s Amazon Resource Name (ARN).
', 'ListTestsRequest$arn' => 'The test suite\'s Amazon Resource Name (ARN).
', 'ListUniqueProblemsRequest$arn' => 'The unique problems\' ARNs.
', 'ListUploadsRequest$arn' => 'The Amazon Resource Name (ARN) of the project for which you want to list uploads.
', 'NetworkProfile$arn' => 'The Amazon Resource Name (ARN) of the network profile.
', 'ProblemDetail$arn' => 'The problem detail\'s ARN.
', 'Project$arn' => 'The project\'s ARN.
', 'RemoteAccessSession$arn' => 'The Amazon Resource Name (ARN) of the remote access session.
', 'RemoteAccessSession$instanceArn' => 'The Amazon Resource Name (ARN) of the instance.
', 'RemoteAccessSession$remoteRecordAppArn' => 'The Amazon Resource Name (ARN) for the app to be recorded in the remote access session.
', 'Run$arn' => 'The run\'s ARN.
', 'Run$appUpload' => 'An app to upload or that has been uploaded.
', 'Run$devicePoolArn' => 'The ARN of the device pool for the run.
', 'Run$testSpecArn' => 'The ARN of the YAML-formatted test specification for the run.
', 'Sample$arn' => 'The sample\'s ARN.
', 'ScheduleRunConfiguration$extraDataPackageArn' => 'The ARN of the extra data for the run. The extra data is a .zip file that AWS Device Farm will extract to external data for Android or the app\'s sandbox for iOS.
', 'ScheduleRunConfiguration$networkProfileArn' => 'Reserved for internal use.
', 'ScheduleRunRequest$projectArn' => 'The ARN of the project for the run to be scheduled.
', 'ScheduleRunRequest$appArn' => 'The ARN of the app to schedule a run.
', 'ScheduleRunRequest$devicePoolArn' => 'The ARN of the device pool for the run to be scheduled.
Either devicePoolArn
or deviceSelectionConfiguration
is required in a request.
The ARN of the uploaded test that will be run.
', 'ScheduleRunTest$testSpecArn' => 'The ARN of the YAML-formatted test specification.
', 'StopJobRequest$arn' => 'Represents the Amazon Resource Name (ARN) of the Device Farm job you wish to stop.
', 'StopRemoteAccessSessionRequest$arn' => 'The Amazon Resource Name (ARN) of the remote access session you wish to stop.
', 'StopRunRequest$arn' => 'Represents the Amazon Resource Name (ARN) of the Device Farm run you wish to stop.
', 'Suite$arn' => 'The suite\'s ARN.
', 'Test$arn' => 'The test\'s ARN.
', 'UpdateDeviceInstanceRequest$arn' => 'The Amazon Resource Name (ARN) of the device instance.
', 'UpdateDeviceInstanceRequest$profileArn' => 'The Amazon Resource Name (ARN) of the profile that you want to associate with the device instance.
', 'UpdateDevicePoolRequest$arn' => 'The Amazon Resourc Name (ARN) of the Device Farm device pool you wish to update.
', 'UpdateInstanceProfileRequest$arn' => 'The Amazon Resource Name (ARN) of the instance profile.
', 'UpdateNetworkProfileRequest$arn' => 'The Amazon Resource Name (ARN) of the project for which you want to update network profile settings.
', 'UpdateProjectRequest$arn' => 'The Amazon Resource Name (ARN) of the project whose name you wish to update.
', 'UpdateUploadRequest$arn' => 'The Amazon Resource Name (ARN) of the uploaded test spec.
', 'UpdateVPCEConfigurationRequest$arn' => 'The Amazon Resource Name (ARN) of the VPC endpoint configuration you want to update.
', 'Upload$arn' => 'The upload\'s ARN.
', 'VPCEConfiguration$arn' => 'The Amazon Resource Name (ARN) of the VPC endpoint configuration.
', ], ], 'AmazonResourceNames' => [ 'base' => NULL, 'refs' => [ 'CreateRemoteAccessSessionConfiguration$vpceConfigurationArns' => 'An array of Amazon Resource Names (ARNs) included in the VPC endpoint configuration.
', 'ScheduleRunConfiguration$vpceConfigurationArns' => 'An array of Amazon Resource Names (ARNs) for your VPC endpoint configurations.
', 'ScheduleRunConfiguration$auxiliaryApps' => 'A list of auxiliary apps for the run.
', ], ], 'AndroidPaths' => [ 'base' => NULL, 'refs' => [ 'CustomerArtifactPaths$androidPaths' => 'Comma-separated list of paths on the Android device where the artifacts generated by the customer\'s tests will be pulled from.
', ], ], 'AppPackagesCleanup' => [ 'base' => NULL, 'refs' => [ 'ExecutionConfiguration$appPackagesCleanup' => 'True if app package cleanup is enabled at the beginning of the test; otherwise, false.
', ], ], 'ArgumentException' => [ 'base' => 'An invalid argument was specified.
', 'refs' => [], ], 'Artifact' => [ 'base' => 'Represents the output of a test. Examples of artifacts include logs and screenshots.
', 'refs' => [ 'Artifacts$member' => NULL, ], ], 'ArtifactCategory' => [ 'base' => NULL, 'refs' => [ 'ListArtifactsRequest$type' => 'The artifacts\' type.
Allowed values include:
FILE: The artifacts are files.
LOG: The artifacts are logs.
SCREENSHOT: The artifacts are screenshots.
The artifact\'s type.
Allowed values include the following:
UNKNOWN: An unknown type.
SCREENSHOT: The screenshot type.
DEVICE_LOG: The device log type.
MESSAGE_LOG: The message log type.
VIDEO_LOG: The video log type.
RESULT_LOG: The result log type.
SERVICE_LOG: The service log type.
WEBKIT_LOG: The web kit log type.
INSTRUMENTATION_OUTPUT: The instrumentation type.
EXERCISER_MONKEY_OUTPUT: For Android, the artifact (log) generated by an Android fuzz test.
CALABASH_JSON_OUTPUT: The Calabash JSON output type.
CALABASH_PRETTY_OUTPUT: The Calabash pretty output type.
CALABASH_STANDARD_OUTPUT: The Calabash standard output type.
CALABASH_JAVA_XML_OUTPUT: The Calabash Java XML output type.
AUTOMATION_OUTPUT: The automation output type.
APPIUM_SERVER_OUTPUT: The Appium server output type.
APPIUM_JAVA_OUTPUT: The Appium Java output type.
APPIUM_JAVA_XML_OUTPUT: The Appium Java XML output type.
APPIUM_PYTHON_OUTPUT: The Appium Python output type.
APPIUM_PYTHON_XML_OUTPUT: The Appium Python XML output type.
EXPLORER_EVENT_LOG: The Explorer event log output type.
EXPLORER_SUMMARY_LOG: The Explorer summary log output type.
APPLICATION_CRASH_REPORT: The application crash report output type.
XCTEST_LOG: The XCode test output type.
VIDEO: The Video output type.
CUSTOMER_ARTIFACT:The Customer Artifact output type.
CUSTOMER_ARTIFACT_LOG: The Customer Artifact Log output type.
TESTSPEC_OUTPUT: The Test Spec Output type.
Information about the artifacts.
', ], ], 'BillingMethod' => [ 'base' => NULL, 'refs' => [ 'CreateRemoteAccessSessionConfiguration$billingMethod' => 'The billing method for the remote access session.
', 'RemoteAccessSession$billingMethod' => '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."
Specifies the billing method for a test run: metered
or unmetered
. If the parameter is not specified, the default value is metered
.
Specifies the billing method for a test run: metered
or unmetered
. If the parameter is not specified, the default value is metered
.
When set to true
, Device Farm will remove app packages after a test run. The default value is false
for private devices.
When set to true
, Device Farm will reboot the instance after a test run. The default value is true
.
Set to true
if you want to access devices remotely for debugging in your remote access session.
Set to true
to enable remote recording for the remote access session.
When set to true
, for private devices, Device Farm will not sign your app again. For public devices, Device Farm always signs your apps again and this parameter has no effect.
For more information about how Device Farm re-signs your app(s), see Do you modify my app? in the AWS Device Farm FAQs.
', 'Device$remoteAccessEnabled' => 'Specifies whether remote access has been enabled for the specified device.
', 'Device$remoteDebugEnabled' => 'This flag is set to true
if remote debugging is enabled for the device.
Whether the result was compatible with the device pool.
', 'InstanceProfile$packageCleanup' => 'When set to true
, Device Farm will remove app packages after a test run. The default value is false
for private devices.
When set to true
, Device Farm will reboot the instance after a test run. The default value is true
.
True if Wi-Fi is enabled at the beginning of the test; otherwise, false.
', 'Radios$bluetooth' => 'True if Bluetooth is enabled at the beginning of the test; otherwise, false.
', 'Radios$nfc' => 'True if NFC is enabled at the beginning of the test; otherwise, false.
', 'Radios$gps' => 'True if GPS is enabled at the beginning of the test; otherwise, false.
', 'RemoteAccessSession$remoteDebugEnabled' => 'This flag is set to true
if remote debugging is enabled for the remote access session.
This flag is set to true
if remote recording is enabled for the remote access session.
The updated choice for whether you want to specify package cleanup. The default value is false
for private devices.
The updated choice for whether you want to reboot the device after use. The default value is true
.
Set to true if the YAML file has changed and needs to be updated; otherwise, set to false.
', ], ], 'CPU' => [ 'base' => 'Represents the amount of CPU that an app is using on a physical device.
Note that this does not represent system-wide CPU usage.
', 'refs' => [ 'Device$cpu' => 'Information about the device\'s CPU.
', ], ], 'ClientId' => [ 'base' => NULL, 'refs' => [ 'CreateRemoteAccessSessionRequest$clientId' => 'Unique identifier for the client. If you want access to multiple devices on the same client, you should pass the same clientId
value in each call to CreateRemoteAccessSession
. This is required only if remoteDebugEnabled
is set to true
.
Unique identifier of your client for the remote access session. Only returned if remote debugging is enabled for the remote access session.
', ], ], 'ContentType' => [ 'base' => NULL, 'refs' => [ 'CreateUploadRequest$contentType' => 'The upload\'s content type (for example, "application/octet-stream").
', 'UpdateUploadRequest$contentType' => 'The upload\'s content type (for example, "application/x-yaml").
', 'Upload$contentType' => 'The upload\'s content type (for example, "application/octet-stream").
', ], ], 'Counters' => [ 'base' => 'Represents entity counters.
', 'refs' => [ 'Job$counters' => 'The job\'s result counters.
', 'Run$counters' => 'The run\'s result counters.
', 'Suite$counters' => 'The suite\'s result counters.
', 'Test$counters' => 'The test\'s result counters.
', ], ], 'CreateDevicePoolRequest' => [ 'base' => 'Represents a request to the create device pool operation.
', 'refs' => [], ], 'CreateDevicePoolResult' => [ 'base' => 'Represents the result of a create device pool request.
', 'refs' => [], ], 'CreateInstanceProfileRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateInstanceProfileResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateNetworkProfileRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateNetworkProfileResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateProjectRequest' => [ 'base' => 'Represents a request to the create project operation.
', 'refs' => [], ], 'CreateProjectResult' => [ 'base' => 'Represents the result of a create project request.
', 'refs' => [], ], 'CreateRemoteAccessSessionConfiguration' => [ 'base' => 'Configuration settings for a remote access session, including billing method.
', 'refs' => [ 'CreateRemoteAccessSessionRequest$configuration' => 'The configuration information for the remote access session request.
', ], ], 'CreateRemoteAccessSessionRequest' => [ 'base' => 'Creates and submits a request to start a remote access session.
', 'refs' => [], ], 'CreateRemoteAccessSessionResult' => [ 'base' => 'Represents the server response from a request to create a remote access session.
', 'refs' => [], ], 'CreateUploadRequest' => [ 'base' => 'Represents a request to the create upload operation.
', 'refs' => [], ], 'CreateUploadResult' => [ 'base' => 'Represents the result of a create upload request.
', 'refs' => [], ], 'CreateVPCEConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateVPCEConfigurationResult' => [ 'base' => NULL, 'refs' => [], ], 'CurrencyCode' => [ 'base' => NULL, 'refs' => [ 'MonetaryAmount$currencyCode' => 'The currency code of a monetary amount. For example, USD
means "U.S. dollars."
A JSON object specifying the paths where the artifacts generated by the customer\'s tests, on the device or in the test environment, will be pulled from.
Specify deviceHostPaths
and optionally specify either iosPaths
or androidPaths
.
For web app tests, you can specify both iosPaths
and androidPaths
.
Output CustomerArtifactPaths
object for the test run.
Input CustomerArtifactPaths
object for the scheduled run configuration.
When the job was created.
', 'Job$started' => 'The job\'s start time.
', 'Job$stopped' => 'The job\'s stop time.
', 'OfferingStatus$effectiveOn' => 'The date on which the offering is effective.
', 'OfferingTransaction$createdOn' => 'The date on which an offering transaction was created.
', 'Project$created' => 'When the project was created.
', 'RemoteAccessSession$created' => 'The date and time the remote access session was created.
', 'RemoteAccessSession$started' => 'The date and time the remote access session was started.
', 'RemoteAccessSession$stopped' => 'The date and time the remote access session was stopped.
', 'Run$created' => 'When the run was created.
', 'Run$started' => 'The run\'s start time.
', 'Run$stopped' => 'The run\'s stop time.
', 'Suite$created' => 'When the suite was created.
', 'Suite$started' => 'The suite\'s start time.
', 'Suite$stopped' => 'The suite\'s stop time.
', 'Test$created' => 'When the test was created.
', 'Test$started' => 'The test\'s start time.
', 'Test$stopped' => 'The test\'s stop time.
', 'Upload$created' => 'When the upload was created.
', ], ], 'DeleteDevicePoolRequest' => [ 'base' => 'Represents a request to the delete device pool operation.
', 'refs' => [], ], 'DeleteDevicePoolResult' => [ 'base' => 'Represents the result of a delete device pool request.
', 'refs' => [], ], 'DeleteInstanceProfileRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteInstanceProfileResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteNetworkProfileRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteNetworkProfileResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteProjectRequest' => [ 'base' => 'Represents a request to the delete project operation.
', 'refs' => [], ], 'DeleteProjectResult' => [ 'base' => 'Represents the result of a delete project request.
', 'refs' => [], ], 'DeleteRemoteAccessSessionRequest' => [ 'base' => 'Represents the request to delete the specified remote access session.
', 'refs' => [], ], 'DeleteRemoteAccessSessionResult' => [ 'base' => 'The response from the server when a request is made to delete the remote access session.
', 'refs' => [], ], 'DeleteRunRequest' => [ 'base' => 'Represents a request to the delete run operation.
', 'refs' => [], ], 'DeleteRunResult' => [ 'base' => 'Represents the result of a delete run request.
', 'refs' => [], ], 'DeleteUploadRequest' => [ 'base' => 'Represents a request to the delete upload operation.
', 'refs' => [], ], 'DeleteUploadResult' => [ 'base' => 'Represents the result of a delete upload request.
', 'refs' => [], ], 'DeleteVPCEConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteVPCEConfigurationResult' => [ 'base' => NULL, 'refs' => [], ], 'Device' => [ 'base' => 'Represents a device type that an app is tested against.
', 'refs' => [ 'DevicePoolCompatibilityResult$device' => 'The device (phone or tablet) that you wish to return information about.
', 'Devices$member' => NULL, 'GetDeviceResult$device' => 'An object containing information about the requested device.
', 'Job$device' => 'The device (phone or tablet).
', 'Problem$device' => 'Information about the associated device.
', 'RemoteAccessSession$device' => 'The device (phone or tablet) used in the remote access session.
', ], ], 'DeviceAttribute' => [ 'base' => NULL, 'refs' => [ 'IncompatibilityMessage$type' => 'The type of incompatibility.
Allowed values include:
ARN: The ARN.
FORM_FACTOR: The form factor (for example, phone or tablet).
MANUFACTURER: The manufacturer.
PLATFORM: The platform (for example, Android or iOS).
REMOTE_ACCESS_ENABLED: Whether the device is enabled for remote access.
APPIUM_VERSION: The Appium version for the test.
The rule\'s attribute. It is the aspect of a device such as platform or model used as selection criteria to create or update a device pool.
Allowed values include:
ARN: The Amazon Resource Name (ARN) of a device. For example, "arn:aws:devicefarm:us-west-2::device:12345Example".
PLATFORM: The device platform. Valid values are "ANDROID" or "IOS".
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 values are "TRUE" or "FALSE".
APPIUM_VERSION: The Appium version for the test.
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".
Reflects how likely a device will be available for a test run. It is currently available in the ListDevices and GetDevice API methods.
', ], ], 'DeviceFilter' => [ 'base' => 'Represents a device filter used to select a set of devices to be included in a test run. This data structure is passed in as the deviceSelectionConfiguration
parameter to ScheduleRun. For an example of the JSON request syntax, see ScheduleRun.
It is also passed in as the filters
parameter to ListDevices. For an example of the JSON request syntax, see ListDevices.
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 values are "TRUE" or "FALSE".
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".
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.
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".
Used to dynamically select a set of devices for a test run. A filter is made up of an attribute, an operator, 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 are "TRUE" or "FALSE".
REMOTE_DEBUG_ENABLED: Whether the device is enabled for remote debugging. Valid values are "TRUE" or "FALSE".
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.
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".
The filters in a device selection result.
', 'ListDevicesRequest$filters' => 'Used to select a set of devices. A filter is made up of an attribute, an operator, and one or more values.
Attribute: The aspect of a device such as platform or model used as the selction 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 values are "TRUE" or "FALSE".
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 "AVAILABLE", "HIGHLY_AVAILABLE", "BUSY", or "TEMPORARY_NOT_AVAILABLE" as values.
The device\'s form factor.
Allowed values include:
PHONE: The phone form factor.
TABLET: The tablet form factor.
Comma-separated list of paths in the test execution environment where the artifacts generated by the customer\'s tests will be pulled from.
', ], ], 'DeviceInstance' => [ 'base' => 'Represents the device instance.
', 'refs' => [ 'DeviceInstances$member' => NULL, 'GetDeviceInstanceResult$deviceInstance' => 'An object containing information about your device instance.
', 'UpdateDeviceInstanceResult$deviceInstance' => 'An object containing information about your device instance.
', ], ], 'DeviceInstances' => [ 'base' => NULL, 'refs' => [ 'Device$instances' => 'The instances belonging to this device.
', 'ListDeviceInstancesResult$deviceInstances' => 'An object containing information about your device instances.
', ], ], 'DeviceMinutes' => [ 'base' => 'Represents the total (metered or unmetered) minutes used by the resource to run tests. Contains the sum of minutes consumed by all children.
', 'refs' => [ 'Job$deviceMinutes' => 'Represents the total (metered or unmetered) minutes used by the job.
', 'RemoteAccessSession$deviceMinutes' => 'The number of minutes a device is used in a remote access sesssion (including setup and teardown minutes).
', 'Run$deviceMinutes' => 'Represents the total (metered or unmetered) minutes used by the test run.
', 'Suite$deviceMinutes' => 'Represents the total (metered or unmetered) minutes used by the test suite.
', 'Test$deviceMinutes' => 'Represents the total (metered or unmetered) minutes used by the test.
', ], ], 'DevicePlatform' => [ 'base' => NULL, 'refs' => [ 'Device$platform' => 'The device\'s platform.
Allowed values include:
ANDROID: The Android platform.
IOS: The iOS platform.
The platform of the device (e.g., ANDROID or IOS).
', 'PurchasedDevicesMap$key' => NULL, 'Run$platform' => 'The run\'s platform.
Allowed values include:
ANDROID: The Android platform.
IOS: The iOS platform.
Represents a collection of device types.
', 'refs' => [ 'CreateDevicePoolResult$devicePool' => 'The newly created device pool.
', 'DevicePools$member' => NULL, 'GetDevicePoolResult$devicePool' => 'An object containing information about the requested device pool.
', 'UpdateDevicePoolResult$devicePool' => 'The device pool you just updated.
', ], ], 'DevicePoolCompatibilityResult' => [ 'base' => 'Represents a device pool compatibility result.
', 'refs' => [ 'DevicePoolCompatibilityResults$member' => NULL, ], ], 'DevicePoolCompatibilityResults' => [ 'base' => NULL, 'refs' => [ 'GetDevicePoolCompatibilityResult$compatibleDevices' => 'Information about compatible devices.
', 'GetDevicePoolCompatibilityResult$incompatibleDevices' => 'Information about incompatible devices.
', ], ], 'DevicePoolType' => [ 'base' => NULL, 'refs' => [ 'DevicePool$type' => '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.
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.
Information about the device pools.
', ], ], 'DeviceSelectionConfiguration' => [ 'base' => 'Represents the device filters used in a test run as well as the maximum number of devices to be included in the run. It is passed in as the deviceSelectionConfiguration
request parameter in ScheduleRun.
The filter criteria used to dynamically select a set of devices for a test run, as well as the maximum number of devices to be included in the run.
Either devicePoolArn
or deviceSelectionConfiguration
is required in a request.
Contains the run results requested by the device selection configuration as well as how many devices were returned. For an example of the JSON response syntax, see ScheduleRun.
', 'refs' => [ 'Run$deviceSelectionResult' => 'The results of a device filter used to select the devices for a test run.
', ], ], 'Devices' => [ 'base' => NULL, 'refs' => [ 'ListDevicesResult$devices' => 'Information about the devices.
', ], ], 'Double' => [ 'base' => NULL, 'refs' => [ 'CPU$clock' => 'The clock speed of the device\'s CPU, expressed in hertz (Hz). For example, a 1.2 GHz CPU is expressed as 1200000000.
', 'DeviceMinutes$total' => 'When specified, represents the total minutes used by the resource to run tests.
', 'DeviceMinutes$metered' => 'When specified, represents only the sum of metered minutes used by the resource to run tests.
', 'DeviceMinutes$unmetered' => 'When specified, represents only the sum of unmetered minutes used by the resource to run tests.
', 'Location$latitude' => 'The latitude.
', 'Location$longitude' => 'The longitude.
', 'MonetaryAmount$amount' => 'The numerical amount of an offering or transaction.
', 'TrialMinutes$total' => 'The total number of free trial minutes that the account started with.
', 'TrialMinutes$remaining' => 'The number of free trial minutes remaining in the account.
', ], ], 'ExecutionConfiguration' => [ 'base' => 'Represents configuration information about a test run, such as the execution timeout (in minutes).
', 'refs' => [ 'ScheduleRunRequest$executionConfiguration' => 'Specifies configuration information about a test run, such as the execution timeout (in minutes).
', ], ], 'ExecutionResult' => [ 'base' => NULL, 'refs' => [ 'Job$result' => 'The job\'s result.
Allowed values include:
PENDING: A pending condition.
PASSED: A passing condition.
WARNED: A warning condition.
FAILED: A failed condition.
SKIPPED: A skipped condition.
ERRORED: An error condition.
STOPPED: A stopped condition.
The problem\'s result.
Allowed values include:
PENDING: A pending condition.
PASSED: A passing condition.
WARNED: A warning condition.
FAILED: A failed condition.
SKIPPED: A skipped condition.
ERRORED: An error condition.
STOPPED: A stopped condition.
The result of the remote access session. Can be any of the following:
PENDING: A pending condition.
PASSED: A passing condition.
WARNED: A warning condition.
FAILED: A failed condition.
SKIPPED: A skipped condition.
ERRORED: An error condition.
STOPPED: A stopped condition.
The run\'s result.
Allowed values include:
PENDING: A pending condition.
PASSED: A passing condition.
WARNED: A warning condition.
FAILED: A failed condition.
SKIPPED: A skipped condition.
ERRORED: An error condition.
STOPPED: A stopped condition.
The suite\'s result.
Allowed values include:
PENDING: A pending condition.
PASSED: A passing condition.
WARNED: A warning condition.
FAILED: A failed condition.
SKIPPED: A skipped condition.
ERRORED: An error condition.
STOPPED: A stopped condition.
The test\'s result.
Allowed values include:
PENDING: A pending condition.
PASSED: A passing condition.
WARNED: A warning condition.
FAILED: A failed condition.
SKIPPED: A skipped condition.
ERRORED: An error condition.
STOPPED: A stopped condition.
Supporting field for the result field. Set only if result
is SKIPPED
. PARSING_FAILED
if the result is skipped because of test package parsing failure.
The job\'s status.
Allowed values include:
PENDING: A pending status.
PENDING_CONCURRENCY: A pending concurrency status.
PENDING_DEVICE: A pending device status.
PROCESSING: A processing status.
SCHEDULING: A scheduling status.
PREPARING: A preparing status.
RUNNING: A running status.
COMPLETED: A completed status.
STOPPING: A stopping status.
The status of the remote access session. Can be any of the following:
PENDING: A pending status.
PENDING_CONCURRENCY: A pending concurrency status.
PENDING_DEVICE: A pending device status.
PROCESSING: A processing status.
SCHEDULING: A scheduling status.
PREPARING: A preparing status.
RUNNING: A running status.
COMPLETED: A completed status.
STOPPING: A stopping status.
The run\'s status.
Allowed values include:
PENDING: A pending status.
PENDING_CONCURRENCY: A pending concurrency status.
PENDING_DEVICE: A pending device status.
PROCESSING: A processing status.
SCHEDULING: A scheduling status.
PREPARING: A preparing status.
RUNNING: A running status.
COMPLETED: A completed status.
STOPPING: A stopping status.
The suite\'s status.
Allowed values include:
PENDING: A pending status.
PENDING_CONCURRENCY: A pending concurrency status.
PENDING_DEVICE: A pending device status.
PROCESSING: A processing status.
SCHEDULING: A scheduling status.
PREPARING: A preparing status.
RUNNING: A running status.
COMPLETED: A completed status.
STOPPING: A stopping status.
The test\'s status.
Allowed values include:
PENDING: A pending status.
PENDING_CONCURRENCY: A pending concurrency status.
PENDING_DEVICE: A pending device status.
PROCESSING: A processing status.
SCHEDULING: A scheduling status.
PREPARING: A preparing status.
RUNNING: A running status.
COMPLETED: A completed status.
STOPPING: A stopping status.
The test\'s filter.
', ], ], 'GetAccountSettingsRequest' => [ 'base' => 'Represents the request sent to retrieve the account settings.
', 'refs' => [], ], 'GetAccountSettingsResult' => [ 'base' => 'Represents the account settings return values from the GetAccountSettings
request.
Represents a request to the get device pool compatibility operation.
', 'refs' => [], ], 'GetDevicePoolCompatibilityResult' => [ 'base' => 'Represents the result of describe device pool compatibility request.
', 'refs' => [], ], 'GetDevicePoolRequest' => [ 'base' => 'Represents a request to the get device pool operation.
', 'refs' => [], ], 'GetDevicePoolResult' => [ 'base' => 'Represents the result of a get device pool request.
', 'refs' => [], ], 'GetDeviceRequest' => [ 'base' => 'Represents a request to the get device request.
', 'refs' => [], ], 'GetDeviceResult' => [ 'base' => 'Represents the result of a get device request.
', 'refs' => [], ], 'GetInstanceProfileRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetInstanceProfileResult' => [ 'base' => NULL, 'refs' => [], ], 'GetJobRequest' => [ 'base' => 'Represents a request to the get job operation.
', 'refs' => [], ], 'GetJobResult' => [ 'base' => 'Represents the result of a get job request.
', 'refs' => [], ], 'GetNetworkProfileRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetNetworkProfileResult' => [ 'base' => NULL, 'refs' => [], ], 'GetOfferingStatusRequest' => [ 'base' => 'Represents the request to retrieve the offering status for the specified customer or account.
', 'refs' => [], ], 'GetOfferingStatusResult' => [ 'base' => 'Returns the status result for a device offering.
', 'refs' => [], ], 'GetProjectRequest' => [ 'base' => 'Represents a request to the get project operation.
', 'refs' => [], ], 'GetProjectResult' => [ 'base' => 'Represents the result of a get project request.
', 'refs' => [], ], 'GetRemoteAccessSessionRequest' => [ 'base' => 'Represents the request to get information about the specified remote access session.
', 'refs' => [], ], 'GetRemoteAccessSessionResult' => [ 'base' => 'Represents the response from the server that lists detailed information about the remote access session.
', 'refs' => [], ], 'GetRunRequest' => [ 'base' => 'Represents a request to the get run operation.
', 'refs' => [], ], 'GetRunResult' => [ 'base' => 'Represents the result of a get run request.
', 'refs' => [], ], 'GetSuiteRequest' => [ 'base' => 'Represents a request to the get suite operation.
', 'refs' => [], ], 'GetSuiteResult' => [ 'base' => 'Represents the result of a get suite request.
', 'refs' => [], ], 'GetTestRequest' => [ 'base' => 'Represents a request to the get test operation.
', 'refs' => [], ], 'GetTestResult' => [ 'base' => 'Represents the result of a get test request.
', 'refs' => [], ], 'GetUploadRequest' => [ 'base' => 'Represents a request to the get upload operation.
', 'refs' => [], ], 'GetUploadResult' => [ 'base' => 'Represents the result of a get upload request.
', 'refs' => [], ], 'GetVPCEConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetVPCEConfigurationResult' => [ 'base' => NULL, 'refs' => [], ], 'HostAddress' => [ 'base' => NULL, 'refs' => [ 'RemoteAccessSession$hostAddress' => 'IP address of the EC2 host where you need to connect to remotely debug devices. Only returned if remote debugging is enabled for the remote access session.
', ], ], 'IdempotencyException' => [ 'base' => 'An entity with the same name already exists.
', 'refs' => [], ], 'IncompatibilityMessage' => [ 'base' => 'Represents information about incompatibility.
', 'refs' => [ 'IncompatibilityMessages$member' => NULL, ], ], 'IncompatibilityMessages' => [ 'base' => NULL, 'refs' => [ 'DevicePoolCompatibilityResult$incompatibilityMessages' => 'Information about the compatibility.
', ], ], 'InstallToRemoteAccessSessionRequest' => [ 'base' => 'Represents the request to install an Android application (in .apk format) or an iOS application (in .ipa format) as part of a remote access session.
', 'refs' => [], ], 'InstallToRemoteAccessSessionResult' => [ 'base' => 'Represents the response from the server after AWS Device Farm makes a request to install to a remote access session.
', 'refs' => [], ], 'InstanceLabels' => [ 'base' => NULL, 'refs' => [ 'DeviceInstance$labels' => 'An array of strings describing the device instance.
', 'UpdateDeviceInstanceRequest$labels' => 'An array of strings that you want to associate with the device instance.
', ], ], 'InstanceProfile' => [ 'base' => 'Represents the instance profile.
', 'refs' => [ 'CreateInstanceProfileResult$instanceProfile' => 'An object containing information about your instance profile.
', 'DeviceInstance$instanceProfile' => 'A object containing information about the instance profile.
', 'GetInstanceProfileResult$instanceProfile' => 'An object containing information about your instance profile.
', 'InstanceProfiles$member' => NULL, 'UpdateInstanceProfileResult$instanceProfile' => 'An object containing information about your instance profile.
', ], ], 'InstanceProfiles' => [ 'base' => NULL, 'refs' => [ 'ListInstanceProfilesResult$instanceProfiles' => 'An object containing information about your instance profiles.
', ], ], 'InstanceStatus' => [ 'base' => NULL, 'refs' => [ 'DeviceInstance$status' => 'The status of the device instance. Valid values are listed below.
', ], ], 'Integer' => [ 'base' => NULL, 'refs' => [ 'Counters$total' => 'The total number of entities.
', 'Counters$passed' => 'The number of passed entities.
', 'Counters$failed' => 'The number of failed entities.
', 'Counters$warned' => 'The number of warned entities.
', 'Counters$errored' => 'The number of errored entities.
', 'Counters$stopped' => 'The number of stopped entities.
', 'Counters$skipped' => 'The number of skipped entities.
', 'DeviceSelectionConfiguration$maxDevices' => 'The maximum number of devices to be included in a test run.
', 'DeviceSelectionResult$matchedDevicesCount' => 'The number of devices that matched the device filter selection criteria.
', 'DeviceSelectionResult$maxDevices' => 'The maximum number of devices to be selected by a device filter and included in a test run.
', 'ListDeviceInstancesRequest$maxResults' => 'An integer specifying the maximum number of items you want to return in the API response.
', 'ListInstanceProfilesRequest$maxResults' => 'An integer specifying the maximum number of items you want to return in the API response.
', 'ListVPCEConfigurationsRequest$maxResults' => 'An integer specifying the maximum number of items you want to return in the API response.
', 'MaxSlotMap$value' => NULL, 'OfferingStatus$quantity' => 'The number of available devices in the offering.
', 'PurchaseOfferingRequest$quantity' => 'The number of device slots you wish to purchase in an offering request.
', 'PurchasedDevicesMap$value' => NULL, 'RenewOfferingRequest$quantity' => 'The quantity requested in an offering renewal.
', 'Resolution$width' => 'The screen resolution\'s width, expressed in pixels.
', 'Resolution$height' => 'The screen resolution\'s height, expressed in pixels.
', 'Run$totalJobs' => 'The total number of jobs for the run.
', 'Run$completedJobs' => 'The total number of completed jobs.
', 'Run$seed' => 'For fuzz tests, this is a seed to use for randomizing the UI fuzz test. Using the same seed value between tests ensures identical event sequences.
', 'Run$eventCount' => 'For fuzz tests, this is the number of events, between 1 and 10000, that the UI fuzz test should perform.
', ], ], 'InteractionMode' => [ 'base' => NULL, 'refs' => [ 'CreateRemoteAccessSessionRequest$interactionMode' => '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 this mode.
VIDEO_ONLY: You can view the screen but cannot touch or rotate it. You can run XCUITest framework-based tests and watch the screen in this mode.
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 this mode.
VIDEO_ONLY: You can view the screen but cannot touch or rotate it. You can run XCUITest framework-based tests and watch the screen in this mode.
There was an error with the update request, or you do not have sufficient permissions to update this VPC endpoint configuration.
', 'refs' => [], ], 'IosPaths' => [ 'base' => NULL, 'refs' => [ 'CustomerArtifactPaths$iosPaths' => 'Comma-separated list of paths on the iOS device where the artifacts generated by the customer\'s tests will be pulled from.
', ], ], 'Job' => [ 'base' => 'Represents a device.
', 'refs' => [ 'GetJobResult$job' => 'An object containing information about the requested job.
', 'Jobs$member' => NULL, 'StopJobResult$job' => 'The job that was stopped.
', ], ], 'JobTimeoutMinutes' => [ 'base' => NULL, 'refs' => [ 'AccountSettings$maxJobTimeoutMinutes' => 'The maximum number of minutes a test run will execute before it times out.
', 'AccountSettings$defaultJobTimeoutMinutes' => 'The default number of minutes (at the account level) a test run will execute before it times out. Default value is 60 minutes.
', 'CreateProjectRequest$defaultJobTimeoutMinutes' => 'Sets the execution timeout value (in minutes) for a project. All test runs in this project will use the specified execution timeout value unless overridden when scheduling a run.
', 'ExecutionConfiguration$jobTimeoutMinutes' => 'The number of minutes a test run will execute before it times out.
', 'Project$defaultJobTimeoutMinutes' => 'The default number of minutes (at the project level) a test run will execute before it times out. Default value is 60 minutes.
', 'Run$jobTimeoutMinutes' => 'The number of minutes the job will execute before it times out.
', 'UpdateProjectRequest$defaultJobTimeoutMinutes' => 'The number of minutes a test run in the project will execute before it times out.
', ], ], 'Jobs' => [ 'base' => NULL, 'refs' => [ 'ListJobsResult$jobs' => 'Information about the jobs.
', ], ], 'LimitExceededException' => [ 'base' => 'A limit was exceeded.
', 'refs' => [], ], 'ListArtifactsRequest' => [ 'base' => 'Represents a request to the list artifacts operation.
', 'refs' => [], ], 'ListArtifactsResult' => [ 'base' => 'Represents the result of a list artifacts operation.
', 'refs' => [], ], 'ListDeviceInstancesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListDeviceInstancesResult' => [ 'base' => NULL, 'refs' => [], ], 'ListDevicePoolsRequest' => [ 'base' => 'Represents the result of a list device pools request.
', 'refs' => [], ], 'ListDevicePoolsResult' => [ 'base' => 'Represents the result of a list device pools request.
', 'refs' => [], ], 'ListDevicesRequest' => [ 'base' => 'Represents the result of a list devices request.
', 'refs' => [], ], 'ListDevicesResult' => [ 'base' => 'Represents the result of a list devices operation.
', 'refs' => [], ], 'ListInstanceProfilesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListInstanceProfilesResult' => [ 'base' => NULL, 'refs' => [], ], 'ListJobsRequest' => [ 'base' => 'Represents a request to the list jobs operation.
', 'refs' => [], ], 'ListJobsResult' => [ 'base' => 'Represents the result of a list jobs request.
', 'refs' => [], ], 'ListNetworkProfilesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListNetworkProfilesResult' => [ 'base' => NULL, 'refs' => [], ], 'ListOfferingPromotionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListOfferingPromotionsResult' => [ 'base' => NULL, 'refs' => [], ], 'ListOfferingTransactionsRequest' => [ 'base' => 'Represents the request to list the offering transaction history.
', 'refs' => [], ], 'ListOfferingTransactionsResult' => [ 'base' => 'Returns the transaction log of the specified offerings.
', 'refs' => [], ], 'ListOfferingsRequest' => [ 'base' => 'Represents the request to list all offerings.
', 'refs' => [], ], 'ListOfferingsResult' => [ 'base' => 'Represents the return values of the list of offerings.
', 'refs' => [], ], 'ListProjectsRequest' => [ 'base' => 'Represents a request to the list projects operation.
', 'refs' => [], ], 'ListProjectsResult' => [ 'base' => 'Represents the result of a list projects request.
', 'refs' => [], ], 'ListRemoteAccessSessionsRequest' => [ 'base' => 'Represents the request to return information about the remote access session.
', 'refs' => [], ], 'ListRemoteAccessSessionsResult' => [ 'base' => 'Represents the response from the server after AWS Device Farm makes a request to return information about the remote access session.
', 'refs' => [], ], 'ListRunsRequest' => [ 'base' => 'Represents a request to the list runs operation.
', 'refs' => [], ], 'ListRunsResult' => [ 'base' => 'Represents the result of a list runs request.
', 'refs' => [], ], 'ListSamplesRequest' => [ 'base' => 'Represents a request to the list samples operation.
', 'refs' => [], ], 'ListSamplesResult' => [ 'base' => 'Represents the result of a list samples request.
', 'refs' => [], ], 'ListSuitesRequest' => [ 'base' => 'Represents a request to the list suites operation.
', 'refs' => [], ], 'ListSuitesResult' => [ 'base' => 'Represents the result of a list suites request.
', 'refs' => [], ], 'ListTestsRequest' => [ 'base' => 'Represents a request to the list tests operation.
', 'refs' => [], ], 'ListTestsResult' => [ 'base' => 'Represents the result of a list tests request.
', 'refs' => [], ], 'ListUniqueProblemsRequest' => [ 'base' => 'Represents a request to the list unique problems operation.
', 'refs' => [], ], 'ListUniqueProblemsResult' => [ 'base' => 'Represents the result of a list unique problems request.
', 'refs' => [], ], 'ListUploadsRequest' => [ 'base' => 'Represents a request to the list uploads operation.
', 'refs' => [], ], 'ListUploadsResult' => [ 'base' => 'Represents the result of a list uploads request.
', 'refs' => [], ], 'ListVPCEConfigurationsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListVPCEConfigurationsResult' => [ 'base' => NULL, 'refs' => [], ], 'Location' => [ 'base' => 'Represents a latitude and longitude pair, expressed in geographic coordinate system degrees (for example 47.6204, -122.3491).
Elevation is currently not supported.
', 'refs' => [ 'Run$location' => 'Information about the location that is used for the run.
', 'ScheduleRunConfiguration$location' => 'Information about the location that is used for the run.
', ], ], 'Long' => [ 'base' => NULL, 'refs' => [ 'CreateNetworkProfileRequest$uplinkBandwidthBits' => 'The data throughput rate in bits per second, as an integer from 0 to 104857600.
', 'CreateNetworkProfileRequest$downlinkBandwidthBits' => 'The data throughput rate in bits per second, as an integer from 0 to 104857600.
', 'CreateNetworkProfileRequest$uplinkDelayMs' => 'Delay time for all packets to destination in milliseconds as an integer from 0 to 2000.
', 'CreateNetworkProfileRequest$downlinkDelayMs' => 'Delay time for all packets to destination in milliseconds as an integer from 0 to 2000.
', 'CreateNetworkProfileRequest$uplinkJitterMs' => 'Time variation in the delay of received packets in milliseconds as an integer from 0 to 2000.
', 'CreateNetworkProfileRequest$downlinkJitterMs' => 'Time variation in the delay of received packets in milliseconds as an integer from 0 to 2000.
', 'Device$heapSize' => 'The device\'s heap size, expressed in bytes.
', 'Device$memory' => 'The device\'s total memory size, expressed in bytes.
', 'NetworkProfile$uplinkBandwidthBits' => 'The data throughput rate in bits per second, as an integer from 0 to 104857600.
', 'NetworkProfile$downlinkBandwidthBits' => 'The data throughput rate in bits per second, as an integer from 0 to 104857600.
', 'NetworkProfile$uplinkDelayMs' => 'Delay time for all packets to destination in milliseconds as an integer from 0 to 2000.
', 'NetworkProfile$downlinkDelayMs' => 'Delay time for all packets to destination in milliseconds as an integer from 0 to 2000.
', 'NetworkProfile$uplinkJitterMs' => 'Time variation in the delay of received packets in milliseconds as an integer from 0 to 2000.
', 'NetworkProfile$downlinkJitterMs' => 'Time variation in the delay of received packets in milliseconds as an integer from 0 to 2000.
', 'UpdateNetworkProfileRequest$uplinkBandwidthBits' => 'The data throughput rate in bits per second, as an integer from 0 to 104857600.
', 'UpdateNetworkProfileRequest$downlinkBandwidthBits' => 'The data throughput rate in bits per second, as an integer from 0 to 104857600.
', 'UpdateNetworkProfileRequest$uplinkDelayMs' => 'Delay time for all packets to destination in milliseconds as an integer from 0 to 2000.
', 'UpdateNetworkProfileRequest$downlinkDelayMs' => 'Delay time for all packets to destination in milliseconds as an integer from 0 to 2000.
', 'UpdateNetworkProfileRequest$uplinkJitterMs' => 'Time variation in the delay of received packets in milliseconds as an integer from 0 to 2000.
', 'UpdateNetworkProfileRequest$downlinkJitterMs' => 'Time variation in the delay of received packets in milliseconds as an integer from 0 to 2000.
', ], ], 'MaxSlotMap' => [ 'base' => NULL, 'refs' => [ 'AccountSettings$maxSlots' => 'The maximum number of device slots that the AWS account can purchase. Each maximum is expressed as an offering-id:number
pair, where the offering-id
represents one of the IDs returned by the ListOfferings
command.
Any additional information about the exception.
', 'CreateDevicePoolRequest$description' => 'The device pool\'s description.
', 'CreateInstanceProfileRequest$description' => 'The description of your instance profile.
', 'CreateNetworkProfileRequest$description' => 'The description of the network profile.
', 'DevicePool$description' => 'The device pool\'s description.
', 'IdempotencyException$message' => 'Any additional information about the exception.
', 'IncompatibilityMessage$message' => 'A message about the incompatibility.
', 'InstanceProfile$description' => 'The description of the instance profile.
', 'InvalidOperationException$message' => NULL, 'Job$message' => 'A message about the job\'s result.
', 'LimitExceededException$message' => 'Any additional information about the exception.
', 'NetworkProfile$description' => 'The description of the network profile.
', 'NotEligibleException$message' => 'The HTTP response code of a Not Eligible exception.
', 'NotFoundException$message' => 'Any additional information about the exception.
', 'Offering$description' => 'A string describing the offering.
', 'OfferingPromotion$description' => 'A string describing the offering promotion.
', 'Problem$message' => 'A message about the problem\'s result.
', 'RemoteAccessSession$message' => 'A message about the remote access session.
', 'Run$message' => 'A message about the run\'s result.
', 'ServiceAccountException$message' => 'Any additional information about the exception.
', 'Suite$message' => 'A message about the suite\'s result.
', 'Test$message' => 'A message about the test\'s result.
', 'UniqueProblem$message' => 'A message about the unique problems\' result.
', 'UpdateDevicePoolRequest$description' => 'A description of the device pool you wish to update.
', 'UpdateInstanceProfileRequest$description' => 'The updated description for your instance profile.
', 'UpdateNetworkProfileRequest$description' => 'The descriptoin of the network profile about which you are returning information.
', 'Upload$message' => 'A message about the upload\'s result.
', ], ], 'Metadata' => [ 'base' => NULL, 'refs' => [ 'Upload$metadata' => 'The upload\'s metadata. For example, for Android, this contains information that is parsed from the manifest and is displayed in the AWS Device Farm console after the associated app is uploaded.
', ], ], 'MonetaryAmount' => [ 'base' => 'A number representing the monetary amount for an offering or transaction.
', 'refs' => [ 'OfferingTransaction$cost' => 'The cost of an offering transaction.
', 'RecurringCharge$cost' => 'The cost of the recurring charge.
', ], ], 'Name' => [ 'base' => NULL, 'refs' => [ 'Artifact$name' => 'The artifact\'s name.
', 'CreateDevicePoolRequest$name' => 'The device pool\'s name.
', 'CreateInstanceProfileRequest$name' => 'The name of your instance profile.
', 'CreateNetworkProfileRequest$name' => 'The name you wish to specify for the new network profile.
', 'CreateProjectRequest$name' => 'The project\'s name.
', 'CreateRemoteAccessSessionRequest$name' => 'The name of the remote access session that you wish to create.
', 'CreateUploadRequest$name' => 'The upload\'s file name. The name should not contain the \'/\' character. If uploading an iOS app, the file name needs to end with the .ipa
extension. If uploading an Android app, the file name needs to end with the .apk
extension. For all others, the file name must end with the .zip
file extension.
The device\'s display name.
', 'DevicePool$name' => 'The device pool\'s name.
', 'InstanceProfile$name' => 'The name of the instance profile.
', 'Job$name' => 'The job\'s name.
', 'NetworkProfile$name' => 'The name of the network profile.
', 'ProblemDetail$name' => 'The problem detail\'s name.
', 'Project$name' => 'The project\'s name.
', 'RemoteAccessSession$name' => 'The name of the remote access session.
', 'Run$name' => 'The run\'s name.
', 'ScheduleRunRequest$name' => 'The name for the run to be scheduled.
', 'Suite$name' => 'The suite\'s name.
', 'Test$name' => 'The test\'s name.
', 'UpdateDevicePoolRequest$name' => 'A string representing the name of the device pool you wish to update.
', 'UpdateInstanceProfileRequest$name' => 'The updated name for your instance profile.
', 'UpdateNetworkProfileRequest$name' => 'The name of the network profile about which you are returning information.
', 'UpdateProjectRequest$name' => 'A string representing the new name of the project that you are updating.
', 'UpdateUploadRequest$name' => 'The upload\'s test spec file name. The name should not contain the \'/\' character. The test spec file name must end with the .yaml
or .yml
file extension.
The upload\'s file name.
', ], ], 'NetworkProfile' => [ 'base' => 'An array of settings that describes characteristics of a network profile.
', 'refs' => [ 'CreateNetworkProfileResult$networkProfile' => 'The network profile that is returned by the create network profile request.
', 'GetNetworkProfileResult$networkProfile' => 'The network profile.
', 'NetworkProfiles$member' => NULL, 'Run$networkProfile' => 'The network profile being used for a test run.
', 'UpdateNetworkProfileResult$networkProfile' => 'A list of the available network profiles.
', ], ], 'NetworkProfileType' => [ 'base' => NULL, 'refs' => [ 'CreateNetworkProfileRequest$type' => 'The type of network profile you wish to create. Valid values are listed below.
', 'ListNetworkProfilesRequest$type' => 'The type of network profile you wish to return information about. Valid values are listed below.
', 'NetworkProfile$type' => 'The type of network profile. Valid values are listed below.
', 'UpdateNetworkProfileRequest$type' => 'The type of network profile you wish to return information about. Valid values are listed below.
', ], ], 'NetworkProfiles' => [ 'base' => NULL, 'refs' => [ 'ListNetworkProfilesResult$networkProfiles' => 'A list of the available network profiles.
', ], ], 'NotEligibleException' => [ 'base' => 'Exception gets thrown when a user is not eligible to perform the specified transaction.
', 'refs' => [], ], 'NotFoundException' => [ 'base' => 'The specified entity was not found.
', 'refs' => [], ], 'Offering' => [ 'base' => 'Represents the metadata of a device offering.
', 'refs' => [ 'OfferingStatus$offering' => 'Represents the metadata of an offering status.
', 'Offerings$member' => NULL, ], ], 'OfferingIdentifier' => [ 'base' => NULL, 'refs' => [ 'Offering$id' => 'The ID that corresponds to a device offering.
', 'OfferingStatusMap$key' => NULL, 'PurchaseOfferingRequest$offeringId' => 'The ID of the offering.
', 'RenewOfferingRequest$offeringId' => 'The ID of a request to renew an offering.
', ], ], 'OfferingPromotion' => [ 'base' => 'Represents information about an offering promotion.
', 'refs' => [ 'OfferingPromotions$member' => NULL, ], ], 'OfferingPromotionIdentifier' => [ 'base' => NULL, 'refs' => [ 'OfferingPromotion$id' => 'The ID of the offering promotion.
', 'OfferingTransaction$offeringPromotionId' => 'The ID that corresponds to a device offering promotion.
', 'PurchaseOfferingRequest$offeringPromotionId' => 'The ID of the offering promotion to be applied to the purchase.
', ], ], 'OfferingPromotions' => [ 'base' => NULL, 'refs' => [ 'ListOfferingPromotionsResult$offeringPromotions' => 'Information about the offering promotions.
', ], ], 'OfferingStatus' => [ 'base' => 'The status of the offering.
', 'refs' => [ 'OfferingStatusMap$value' => NULL, 'OfferingTransaction$offeringStatus' => 'The status of an offering transaction.
', ], ], 'OfferingStatusMap' => [ 'base' => NULL, 'refs' => [ 'GetOfferingStatusResult$current' => 'When specified, gets the offering status for the current period.
', 'GetOfferingStatusResult$nextPeriod' => 'When specified, gets the offering status for the next period.
', ], ], 'OfferingTransaction' => [ 'base' => 'Represents the metadata of an offering transaction.
', 'refs' => [ 'OfferingTransactions$member' => NULL, 'PurchaseOfferingResult$offeringTransaction' => 'Represents the offering transaction for the purchase result.
', 'RenewOfferingResult$offeringTransaction' => 'Represents the status of the offering transaction for the renewal.
', ], ], 'OfferingTransactionType' => [ 'base' => NULL, 'refs' => [ 'OfferingStatus$type' => 'The type specified for the offering status.
', ], ], 'OfferingTransactions' => [ 'base' => NULL, 'refs' => [ 'ListOfferingTransactionsResult$offeringTransactions' => 'The audit log of subscriptions you have purchased and modified through AWS Device Farm.
', ], ], 'OfferingType' => [ 'base' => NULL, 'refs' => [ 'Offering$type' => 'The type of offering (e.g., "RECURRING") for a device.
', ], ], 'Offerings' => [ 'base' => NULL, 'refs' => [ 'ListOfferingsResult$offerings' => 'A value representing the list offering results.
', ], ], 'PackageIds' => [ 'base' => NULL, 'refs' => [ 'CreateInstanceProfileRequest$excludeAppPackagesFromCleanup' => 'An array of strings specifying the list of app packages that should not be cleaned up from the device after a test run is over.
The list of packages is only considered if you set packageCleanup
to true
.
An array of strings specifying the list of app packages that should not be cleaned up from the device after a test run is over.
The list of packages is only considered if you set packageCleanup
to true
.
An array of strings specifying the list of app packages that should not be cleaned up from the device after a test run is over.
The list of packages is only considered if you set packageCleanup
to true
.
An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
', 'GetOfferingStatusResult$nextToken' => 'An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
', 'ListArtifactsRequest$nextToken' => 'An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
', 'ListArtifactsResult$nextToken' => 'If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.
', 'ListDeviceInstancesRequest$nextToken' => 'An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
', 'ListDeviceInstancesResult$nextToken' => 'An identifier that can be used in the next call to this operation to return the next set of items in the list.
', 'ListDevicePoolsRequest$nextToken' => 'An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
', 'ListDevicePoolsResult$nextToken' => 'If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.
', 'ListDevicesRequest$nextToken' => 'An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
', 'ListDevicesResult$nextToken' => 'If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.
', 'ListInstanceProfilesRequest$nextToken' => 'An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
', 'ListInstanceProfilesResult$nextToken' => 'An identifier that can be used in the next call to this operation to return the next set of items in the list.
', 'ListJobsRequest$nextToken' => 'An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
', 'ListJobsResult$nextToken' => 'If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.
', 'ListNetworkProfilesRequest$nextToken' => 'An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
', 'ListNetworkProfilesResult$nextToken' => 'An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
', 'ListOfferingPromotionsRequest$nextToken' => 'An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
', 'ListOfferingPromotionsResult$nextToken' => 'An identifier to be used in the next call to this operation, to return the next set of items in the list.
', 'ListOfferingTransactionsRequest$nextToken' => 'An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
', 'ListOfferingTransactionsResult$nextToken' => 'An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
', 'ListOfferingsRequest$nextToken' => 'An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
', 'ListOfferingsResult$nextToken' => 'An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
', 'ListProjectsRequest$nextToken' => 'An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
', 'ListProjectsResult$nextToken' => 'If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.
', 'ListRemoteAccessSessionsRequest$nextToken' => 'An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
', 'ListRemoteAccessSessionsResult$nextToken' => 'An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
', 'ListRunsRequest$nextToken' => 'An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
', 'ListRunsResult$nextToken' => 'If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.
', 'ListSamplesRequest$nextToken' => 'An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
', 'ListSamplesResult$nextToken' => 'If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.
', 'ListSuitesRequest$nextToken' => 'An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
', 'ListSuitesResult$nextToken' => 'If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.
', 'ListTestsRequest$nextToken' => 'An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
', 'ListTestsResult$nextToken' => 'If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.
', 'ListUniqueProblemsRequest$nextToken' => 'An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
', 'ListUniqueProblemsResult$nextToken' => 'If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.
', 'ListUploadsRequest$nextToken' => 'An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
', 'ListUploadsResult$nextToken' => 'If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.
', 'ListVPCEConfigurationsRequest$nextToken' => 'An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
', 'ListVPCEConfigurationsResult$nextToken' => 'An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
', ], ], 'PercentInteger' => [ 'base' => NULL, 'refs' => [ 'CreateNetworkProfileRequest$uplinkLossPercent' => 'Proportion of transmitted packets that fail to arrive from 0 to 100 percent.
', 'CreateNetworkProfileRequest$downlinkLossPercent' => 'Proportion of received packets that fail to arrive from 0 to 100 percent.
', 'NetworkProfile$uplinkLossPercent' => 'Proportion of transmitted packets that fail to arrive from 0 to 100 percent.
', 'NetworkProfile$downlinkLossPercent' => 'Proportion of received packets that fail to arrive from 0 to 100 percent.
', 'UpdateNetworkProfileRequest$uplinkLossPercent' => 'Proportion of transmitted packets that fail to arrive from 0 to 100 percent.
', 'UpdateNetworkProfileRequest$downlinkLossPercent' => 'Proportion of received packets that fail to arrive from 0 to 100 percent.
', ], ], 'Problem' => [ 'base' => 'Represents a specific warning or failure.
', 'refs' => [ 'Problems$member' => NULL, ], ], 'ProblemDetail' => [ 'base' => 'Information about a problem detail.
', 'refs' => [ 'Problem$run' => 'Information about the associated run.
', 'Problem$job' => 'Information about the associated job.
', 'Problem$suite' => 'Information about the associated suite.
', 'Problem$test' => 'Information about the associated test.
', ], ], 'Problems' => [ 'base' => NULL, 'refs' => [ 'UniqueProblem$problems' => 'Information about the problems.
', ], ], 'Project' => [ 'base' => 'Represents an operating-system neutral workspace for running and managing tests.
', 'refs' => [ 'CreateProjectResult$project' => 'The newly created project.
', 'GetProjectResult$project' => 'The project you wish to get information about.
', 'Projects$member' => NULL, 'UpdateProjectResult$project' => 'The project you wish to update.
', ], ], 'Projects' => [ 'base' => NULL, 'refs' => [ 'ListProjectsResult$projects' => 'Information about the projects.
', ], ], 'PurchaseOfferingRequest' => [ 'base' => 'Represents a request for a purchase offering.
', 'refs' => [], ], 'PurchaseOfferingResult' => [ 'base' => 'The result of the purchase offering (e.g., success or failure).
', 'refs' => [], ], 'PurchasedDevicesMap' => [ 'base' => NULL, 'refs' => [ 'AccountSettings$unmeteredDevices' => 'Returns the unmetered devices you have purchased or want to purchase.
', 'AccountSettings$unmeteredRemoteAccessDevices' => 'Returns the unmetered remote access devices you have purchased or want to purchase.
', ], ], 'Radios' => [ 'base' => 'Represents the set of radios and their states on a device. Examples of radios include Wi-Fi, GPS, Bluetooth, and NFC.
', 'refs' => [ 'Run$radios' => 'Information about the radio states for the run.
', 'ScheduleRunConfiguration$radios' => 'Information about the radio states for the run.
', ], ], 'RecurringCharge' => [ 'base' => 'Specifies whether charges for devices will be recurring.
', 'refs' => [ 'RecurringCharges$member' => NULL, ], ], 'RecurringChargeFrequency' => [ 'base' => NULL, 'refs' => [ 'RecurringCharge$frequency' => 'The frequency in which charges will recur.
', ], ], 'RecurringCharges' => [ 'base' => NULL, 'refs' => [ 'Offering$recurringCharges' => 'Specifies whether there are recurring charges for the offering.
', ], ], 'RemoteAccessSession' => [ 'base' => 'Represents information about the remote access session.
', 'refs' => [ 'CreateRemoteAccessSessionResult$remoteAccessSession' => 'A container that describes the remote access session when the request to create a remote access session is sent.
', 'GetRemoteAccessSessionResult$remoteAccessSession' => 'A container that lists detailed information about the remote access session.
', 'RemoteAccessSessions$member' => NULL, 'StopRemoteAccessSessionResult$remoteAccessSession' => 'A container representing the metadata from the service about the remote access session you are stopping.
', ], ], 'RemoteAccessSessions' => [ 'base' => NULL, 'refs' => [ 'ListRemoteAccessSessionsResult$remoteAccessSessions' => 'A container representing the metadata from the service about each remote access session you are requesting.
', ], ], 'RenewOfferingRequest' => [ 'base' => 'A request representing an offering renewal.
', 'refs' => [], ], 'RenewOfferingResult' => [ 'base' => 'The result of a renewal offering.
', 'refs' => [], ], 'Resolution' => [ 'base' => 'Represents the screen resolution of a device in height and width, expressed in pixels.
', 'refs' => [ 'Device$resolution' => 'The resolution of the device.
', ], ], 'Rule' => [ 'base' => 'Represents a condition for a device pool. It is passed in as the rules
parameter to CreateDevicePool and UpdateDevicePool.
The rule\'s operator.
EQUALS: The equals operator.
GREATER_THAN: The greater-than operator.
IN: The in operator.
LESS_THAN: The less-than operator.
NOT_IN: The not-in operator.
CONTAINS: The contains operator.
The device pool\'s rules.
', 'DevicePool$rules' => 'Information about the device pool\'s rules.
', 'UpdateDevicePoolRequest$rules' => 'Represents the rules you wish to modify for the device pool. Updating rules is optional; however, if you choose to update rules for your request, the update will replace the existing rules.
', ], ], 'Run' => [ 'base' => 'Represents a test run on a set of devices with a given app package, test parameters, etc.
', 'refs' => [ 'GetRunResult$run' => 'The run you wish to get results from.
', 'Runs$member' => NULL, 'ScheduleRunResult$run' => 'Information about the scheduled run.
', 'StopRunResult$run' => 'The run that was stopped.
', ], ], 'Runs' => [ 'base' => NULL, 'refs' => [ 'ListRunsResult$runs' => 'Information about the runs.
', ], ], 'Sample' => [ 'base' => 'Represents a sample of performance data.
', 'refs' => [ 'Samples$member' => NULL, ], ], 'SampleType' => [ 'base' => NULL, 'refs' => [ 'Sample$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 child processes) as reported by process, as a percentage.
MEMORY: A memory usage sample type. This is expressed as the total proportional set size of an app 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 app process.
TX
TX_RATE: The total number of bytes per second (TCP and UDP) that are received, by app process.
Information about the samples.
', ], ], 'ScheduleRunConfiguration' => [ 'base' => 'Represents the settings for a run. Includes things like location, radio states, auxiliary apps, and network profiles.
', 'refs' => [ 'GetDevicePoolCompatibilityRequest$configuration' => 'An object containing information about the settings for a run.
', 'ScheduleRunRequest$configuration' => 'Information about the settings for the run to be scheduled.
', ], ], 'ScheduleRunRequest' => [ 'base' => 'Represents a request to the schedule run operation.
', 'refs' => [], ], 'ScheduleRunResult' => [ 'base' => 'Represents the result of a schedule run request.
', 'refs' => [], ], 'ScheduleRunTest' => [ 'base' => 'Represents test settings. This data structure is passed in as the test
parameter to ScheduleRun. For an example of the JSON request syntax, see ScheduleRun.
Information about the uploaded test to be run against the device pool.
', 'ScheduleRunRequest$test' => 'Information about the test for the run to be scheduled.
', ], ], 'ServiceAccountException' => [ 'base' => 'There was a problem with the service account.
', 'refs' => [], ], 'ServiceDnsName' => [ 'base' => NULL, 'refs' => [ 'CreateVPCEConfigurationRequest$serviceDnsName' => 'The DNS name of the service running in your VPC that you want Device Farm to test.
', 'UpdateVPCEConfigurationRequest$serviceDnsName' => 'The DNS (domain) name used to connect to your private service in your Amazon VPC. The DNS name must not already be in use on the Internet.
', 'VPCEConfiguration$serviceDnsName' => 'The DNS name that maps to the private IP address of the service you want to access.
', ], ], 'SkipAppResign' => [ 'base' => NULL, 'refs' => [ 'AccountSettings$skipAppResign' => 'When set to true
, for private devices, Device Farm will not sign your app again. For public devices, Device Farm always signs your apps again and this parameter has no effect.
For more information about how Device Farm re-signs your app(s), see Do you modify my app? in the AWS Device Farm FAQs.
', 'ExecutionConfiguration$skipAppResign' => 'When set to true
, for private devices, Device Farm will not sign your app again. For public devices, Device Farm always signs your apps again and this parameter has no effect.
For more information about how Device Farm re-signs your app(s), see Do you modify my app? in the AWS Device Farm FAQs.
', 'RemoteAccessSession$skipAppResign' => 'When set to true
, for private devices, Device Farm will not sign your app again. For public devices, Device Farm always signs your apps again and this parameter has no effect.
For more information about how Device Farm re-signs your app(s), see Do you modify my app? in the AWS Device Farm FAQs.
', 'Run$skipAppResign' => 'When set to true
, for private devices, Device Farm will not sign your app again. For public devices, Device Farm always signs your apps again and this parameter has no effect.
For more information about how Device Farm re-signs your app(s), see Do you modify my app? in the AWS Device Farm FAQs.
', ], ], 'SshPublicKey' => [ 'base' => NULL, 'refs' => [ 'CreateRemoteAccessSessionRequest$sshPublicKey' => 'The public key of the ssh
key pair you want to use for connecting to remote devices in your remote debugging session. This is only required if remoteDebugEnabled
is set to true
.
Represents the request to stop the remote access session.
', 'refs' => [], ], 'StopRemoteAccessSessionResult' => [ 'base' => 'Represents the response from the server that describes the remote access session when AWS Device Farm stops the session.
', 'refs' => [], ], 'StopRunRequest' => [ 'base' => 'Represents the request to stop a specific run.
', 'refs' => [], ], 'StopRunResult' => [ 'base' => 'Represents the results of your stop run attempt.
', 'refs' => [], ], 'String' => [ 'base' => NULL, 'refs' => [ 'AndroidPaths$member' => NULL, 'Artifact$extension' => 'The artifact\'s file extension.
', 'CPU$frequency' => 'The CPU\'s frequency.
', 'CPU$architecture' => 'The CPU\'s architecture, for example x86 or ARM.
', 'Device$manufacturer' => 'The device\'s manufacturer name.
', 'Device$model' => 'The device\'s model name.
', 'Device$modelId' => 'The device\'s model ID.
', 'Device$os' => 'The device\'s operating system type.
', 'Device$image' => 'The device\'s image name.
', 'Device$carrier' => 'The device\'s carrier.
', 'Device$radio' => 'The device\'s radio.
', 'Device$fleetType' => 'The type of fleet to which this device belongs. Possible values for fleet type are PRIVATE and PUBLIC.
', 'Device$fleetName' => 'The name of the fleet to which this device belongs.
', 'DeviceFilterValues$member' => NULL, 'DeviceHostPaths$member' => NULL, 'DeviceInstance$udid' => 'Unique device identifier for the device instance.
', 'InstanceLabels$member' => NULL, 'IosPaths$member' => NULL, 'Job$videoEndpoint' => 'The endpoint for streaming device video.
', 'MaxSlotMap$key' => NULL, 'PackageIds$member' => NULL, 'RemoteAccessSession$endpoint' => 'The endpoint for the remote access sesssion.
', 'RemoteAccessSession$deviceUdid' => 'Unique device identifier for the remote device. Only returned if remote debugging is enabled for the remote access session.
', 'Rule$value' => 'The rule\'s value.
The value must be passed in as a string using escaped quotes.
For example:
"value": "\\"ANDROID\\""
', 'Run$parsingResultUrl' => 'Read-only URL for an object in S3 bucket where you can get the parsing results of the test package. If the test package doesn\'t parse, the reason why it doesn\'t parse appears in the file that this URL points to.
', 'Run$locale' => 'Information about the locale that is used for the run.
', 'Run$webUrl' => 'The Device Farm console URL for the recording of the run.
', 'ScheduleRunConfiguration$locale' => 'Information about the locale that is used for the run.
', 'TestParameters$key' => NULL, 'TestParameters$value' => NULL, ], ], 'Suite' => [ 'base' => 'Represents a collection of one or more tests.
', 'refs' => [ 'GetSuiteResult$suite' => 'A collection of one or more tests.
', 'Suites$member' => NULL, ], ], 'Suites' => [ 'base' => NULL, 'refs' => [ 'ListSuitesResult$suites' => 'Information about the suites.
', ], ], 'Test' => [ 'base' => 'Represents a condition that is evaluated.
', 'refs' => [ 'GetTestResult$test' => 'A test condition that is evaluated.
', 'Tests$member' => NULL, ], ], 'TestParameters' => [ 'base' => NULL, 'refs' => [ 'ScheduleRunTest$parameters' => 'The test\'s parameters, such as test framework parameters and fixture settings. Parameters are represented 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 higher), "latest", and "default".
“latest” will run the latest Appium version supported by Device Farm (1.9.1).
For “default”, Device Farm will choose 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, 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 username to use if the Explorer encounters a login form. If not supplied, no username will be inserted.
password: A password to use if the Explorer encounters a login form. If not supplied, no password will be 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"
The test type for the specified device pool.
Allowed values include the following:
BUILTIN_FUZZ: The built-in fuzz type.
BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time.
APPIUM_JAVA_JUNIT: The Appium Java JUnit type.
APPIUM_JAVA_TESTNG: The Appium Java TestNG type.
APPIUM_PYTHON: The Appium Python type.
APPIUM_NODE: The Appium Node.js type.
APPIUM_RUBY: The Appium Ruby type.
APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for web apps.
APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for web apps.
APPIUM_WEB_PYTHON: The Appium Python type for web apps.
APPIUM_WEB_NODE: The Appium Node.js type for web apps.
APPIUM_WEB_RUBY: The Appium Ruby type for web apps.
CALABASH: The Calabash type.
INSTRUMENTATION: The Instrumentation type.
UIAUTOMATION: The uiautomation type.
UIAUTOMATOR: The uiautomator type.
XCTEST: The XCode test type.
XCTEST_UI: The XCode UI test type.
The job\'s type.
Allowed values include the following:
BUILTIN_FUZZ: The built-in fuzz type.
BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time.
APPIUM_JAVA_JUNIT: The Appium Java JUnit type.
APPIUM_JAVA_TESTNG: The Appium Java TestNG type.
APPIUM_PYTHON: The Appium Python type.
APPIUM_NODE: The Appium Node.js type.
APPIUM_RUBY: The Appium Ruby type.
APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for web apps.
APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for web apps.
APPIUM_WEB_PYTHON: The Appium Python type for web apps.
APPIUM_WEB_NODE: The Appium Node.js type for web apps.
APPIUM_WEB_RUBY: The Appium Ruby test type for web apps.
CALABASH: The Calabash type.
INSTRUMENTATION: The Instrumentation type.
UIAUTOMATION: The uiautomation type.
UIAUTOMATOR: The uiautomator type.
XCTEST: The XCode test type.
XCTEST_UI: The XCode UI test type.
The run\'s type.
Must be one of the following values:
BUILTIN_FUZZ: The built-in fuzz type.
BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time.
APPIUM_JAVA_JUNIT: The Appium Java JUnit type.
APPIUM_JAVA_TESTNG: The Appium Java TestNG type.
APPIUM_PYTHON: The Appium Python type.
APPIUM_NODE: The Appium Node.js type.
APPIUM_RUBY: The Appium Ruby type.
APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for web apps.
APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for web apps.
APPIUM_WEB_PYTHON: The Appium Python type for web apps.
APPIUM_WEB_NODE: The Appium Node.js type for web apps.
APPIUM_WEB_RUBY: The Appium Ruby type for web apps.
CALABASH: The Calabash type.
INSTRUMENTATION: The Instrumentation type.
UIAUTOMATION: The uiautomation type.
UIAUTOMATOR: The uiautomator type.
XCTEST: The XCode test type.
XCTEST_UI: The XCode UI test type.
The test\'s type.
Must be one of the following values:
BUILTIN_FUZZ: The built-in fuzz type.
BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time.
APPIUM_JAVA_JUNIT: The Appium Java JUnit type.
APPIUM_JAVA_TESTNG: The Appium Java TestNG type.
APPIUM_PYTHON: The Appium Python type.
APPIUM_NODE: The Appium Node.js type.
APPIUM_RUBY: The Appium Ruby type.
APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for web apps.
APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for web apps.
APPIUM_WEB_PYTHON: The Appium Python type for web apps.
APPIUM_WEB_NODE: The Appium Node.js type for web apps.
APPIUM_WEB_RUBY: The Appium Ruby type for web apps.
CALABASH: The Calabash type.
INSTRUMENTATION: The Instrumentation type.
UIAUTOMATION: The uiautomation type.
UIAUTOMATOR: The uiautomator type.
XCTEST: The XCode test type.
XCTEST_UI: The XCode UI test type.
The suite\'s type.
Must be one of the following values:
BUILTIN_FUZZ: The built-in fuzz type.
BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time.
APPIUM_JAVA_JUNIT: The Appium Java JUnit type.
APPIUM_JAVA_TESTNG: The Appium Java TestNG type.
APPIUM_PYTHON: The Appium Python type.
APPIUM_NODE: The Appium Node.js type.
APPIUM_RUBY: The Appium Ruby type.
APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for web apps.
APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for web apps.
APPIUM_WEB_PYTHON: The Appium Python type for web apps.
APPIUM_WEB_NODE: The Appium Node.js type for web apps.
APPIUM_WEB_RUBY: The Appium Ruby type for web apps.
CALABASH: The Calabash type.
INSTRUMENTATION: The Instrumentation type.
UIAUTOMATION: The uiautomation type.
UIAUTOMATOR: The uiautomator type.
XCTEST: The XCode test type.
XCTEST_UI: The XCode UI test type.
The test\'s type.
Must be one of the following values:
BUILTIN_FUZZ: The built-in fuzz type.
BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time.
APPIUM_JAVA_JUNIT: The Appium Java JUnit type.
APPIUM_JAVA_TESTNG: The Appium Java TestNG type.
APPIUM_PYTHON: The Appium Python type.
APPIUM_NODE: The Appium Node.js type.
APPIUM_RUBY: The Appium Ruby type.
APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for web apps.
APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for web apps.
APPIUM_WEB_PYTHON: The Appium Python type for web apps.
APPIUM_WEB_NODE: The Appium Node.js type for web apps.
APPIUM_WEB_RUBY: The Appium Ruby type for web apps.
CALABASH: The Calabash type.
INSTRUMENTATION: The Instrumentation type.
UIAUTOMATION: The uiautomation type.
UIAUTOMATOR: The uiautomator type.
XCTEST: The XCode test type.
XCTEST_UI: The XCode UI test type.
Information about the tests.
', ], ], 'TransactionIdentifier' => [ 'base' => NULL, 'refs' => [ 'OfferingTransaction$transactionId' => 'The transaction ID of the offering transaction.
', ], ], 'TrialMinutes' => [ 'base' => 'Represents information about free trial device minutes for an AWS account.
', 'refs' => [ 'AccountSettings$trialMinutes' => 'Information about an AWS account\'s usage of free trial device minutes.
', ], ], 'URL' => [ 'base' => NULL, 'refs' => [ 'Artifact$url' => 'The pre-signed Amazon S3 URL that can be used with a corresponding GET request to download the artifact\'s file.
', 'Sample$url' => 'The pre-signed Amazon S3 URL that can be used with a corresponding GET request to download the sample\'s file.
', 'Upload$url' => 'The pre-signed Amazon S3 URL that was used to store a file through a corresponding PUT request.
', ], ], 'UniqueProblem' => [ 'base' => 'A collection of one or more problems, grouped by their result.
', 'refs' => [ 'UniqueProblems$member' => NULL, ], ], 'UniqueProblems' => [ 'base' => NULL, 'refs' => [ 'UniqueProblemsByExecutionResultMap$value' => NULL, ], ], 'UniqueProblemsByExecutionResultMap' => [ 'base' => NULL, 'refs' => [ 'ListUniqueProblemsResult$uniqueProblems' => 'Information about the unique problems.
Allowed values include:
PENDING: A pending condition.
PASSED: A passing condition.
WARNED: A warning condition.
FAILED: A failed condition.
SKIPPED: A skipped condition.
ERRORED: An error condition.
STOPPED: A stopped condition.
Represents a request to the update device pool operation.
', 'refs' => [], ], 'UpdateDevicePoolResult' => [ 'base' => 'Represents the result of an update device pool request.
', 'refs' => [], ], 'UpdateInstanceProfileRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateInstanceProfileResult' => [ 'base' => NULL, 'refs' => [], ], 'UpdateNetworkProfileRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateNetworkProfileResult' => [ 'base' => NULL, 'refs' => [], ], 'UpdateProjectRequest' => [ 'base' => 'Represents a request to the update project operation.
', 'refs' => [], ], 'UpdateProjectResult' => [ 'base' => 'Represents the result of an update project request.
', 'refs' => [], ], 'UpdateUploadRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateUploadResult' => [ 'base' => NULL, 'refs' => [], ], 'UpdateVPCEConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateVPCEConfigurationResult' => [ 'base' => NULL, 'refs' => [], ], 'Upload' => [ 'base' => 'An app or a set of one or more tests to upload or that have been uploaded.
', 'refs' => [ 'CreateUploadResult$upload' => 'The newly created upload.
', 'GetUploadResult$upload' => 'An app or a set of one or more tests to upload or that have been uploaded.
', 'InstallToRemoteAccessSessionResult$appUpload' => 'An app to upload or that has been uploaded.
', 'UpdateUploadResult$upload' => 'A test spec uploaded to Device Farm.
', 'Uploads$member' => NULL, ], ], 'UploadCategory' => [ 'base' => NULL, 'refs' => [ 'Upload$category' => '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.
The upload\'s status.
Must be one of the following values:
FAILED: A failed status.
INITIALIZED: An initialized status.
PROCESSING: A processing status.
SUCCEEDED: A succeeded status.
The upload\'s upload type.
Must be one of the following values:
ANDROID_APP: An Android upload.
IOS_APP: An iOS upload.
WEB_APP: A web application upload.
EXTERNAL_DATA: An external data upload.
APPIUM_JAVA_JUNIT_TEST_PACKAGE: An Appium Java JUnit test package upload.
APPIUM_JAVA_TESTNG_TEST_PACKAGE: An Appium Java TestNG test package upload.
APPIUM_PYTHON_TEST_PACKAGE: An Appium Python test package upload.
APPIUM_NODE_TEST_PACKAGE: An Appium Node.js test package upload.
APPIUM_RUBY_TEST_PACKAGE: An Appium Ruby test package upload.
APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE: An Appium Java JUnit test package upload for a web app.
APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE: An Appium Java TestNG test package upload for a web app.
APPIUM_WEB_PYTHON_TEST_PACKAGE: An Appium Python test package upload for a web app.
APPIUM_WEB_NODE_TEST_PACKAGE: An Appium Node.js test package upload for a web app.
APPIUM_WEB_RUBY_TEST_PACKAGE: An Appium Ruby test package upload for a web app.
CALABASH_TEST_PACKAGE: A Calabash test package upload.
INSTRUMENTATION_TEST_PACKAGE: An instrumentation upload.
UIAUTOMATION_TEST_PACKAGE: A uiautomation test package upload.
UIAUTOMATOR_TEST_PACKAGE: A uiautomator test package upload.
XCTEST_TEST_PACKAGE: An XCode test package upload.
XCTEST_UI_TEST_PACKAGE: An XCode UI test package upload.
APPIUM_JAVA_JUNIT_TEST_SPEC: An Appium Java JUnit test spec upload.
APPIUM_JAVA_TESTNG_TEST_SPEC: An Appium Java TestNG test spec upload.
APPIUM_PYTHON_TEST_SPEC: An Appium Python test spec upload.
APPIUM_NODE_TEST_SPEC: An Appium Node.js test spec upload.
APPIUM_RUBY_TEST_SPEC: An Appium Ruby test spec upload.
APPIUM_WEB_JAVA_JUNIT_TEST_SPEC: An Appium Java JUnit test spec upload for a web app.
APPIUM_WEB_JAVA_TESTNG_TEST_SPEC: An Appium Java TestNG test spec upload for a web app.
APPIUM_WEB_PYTHON_TEST_SPEC: An Appium Python test spec upload for a web app.
APPIUM_WEB_NODE_TEST_SPEC: An Appium Node.js test spec upload for a web app.
APPIUM_WEB_RUBY_TEST_SPEC: An Appium Ruby test spec upload for a web app.
INSTRUMENTATION_TEST_SPEC: An instrumentation test spec upload.
XCTEST_UI_TEST_SPEC: An XCode UI test spec upload.
Note If you call CreateUpload
with WEB_APP
specified, AWS Device Farm throws an ArgumentException
error.
The type of upload.
Must be one of the following values:
ANDROID_APP: An Android upload.
IOS_APP: An iOS upload.
WEB_APP: A web appliction upload.
EXTERNAL_DATA: An external data upload.
APPIUM_JAVA_JUNIT_TEST_PACKAGE: An Appium Java JUnit test package upload.
APPIUM_JAVA_TESTNG_TEST_PACKAGE: An Appium Java TestNG test package upload.
APPIUM_PYTHON_TEST_PACKAGE: An Appium Python test package upload.
APPIUM_NODE_TEST_PACKAGE: An Appium Node.js test package upload.
APPIUM_RUBY_TEST_PACKAGE: An Appium Ruby test package upload.
APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE: An Appium Java JUnit test package upload for a web app.
APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE: An Appium Java TestNG test package upload for a web app.
APPIUM_WEB_PYTHON_TEST_PACKAGE: An Appium Python test package upload for a web app.
APPIUM_WEB_NODE_TEST_PACKAGE: An Appium Node.js test package upload for a web app.
APPIUM_WEB_RUBY_TEST_PACKAGE: An Appium Ruby test package upload for a web app.
CALABASH_TEST_PACKAGE: A Calabash test package upload.
INSTRUMENTATION_TEST_PACKAGE: An instrumentation upload.
UIAUTOMATION_TEST_PACKAGE: A uiautomation test package upload.
UIAUTOMATOR_TEST_PACKAGE: A uiautomator test package upload.
XCTEST_TEST_PACKAGE: An XCode test package upload.
XCTEST_UI_TEST_PACKAGE: An XCode UI test package upload.
APPIUM_JAVA_JUNIT_TEST_SPEC: An Appium Java JUnit test spec upload.
APPIUM_JAVA_TESTNG_TEST_SPEC: An Appium Java TestNG test spec upload.
APPIUM_PYTHON_TEST_SPEC: An Appium Python test spec upload.
APPIUM_NODE_TEST_SPEC: An Appium Node.js test spec upload.
APPIUM_RUBY_TEST_SPEC: An Appium Ruby test spec upload.
APPIUM_WEB_JAVA_JUNIT_TEST_SPEC: An Appium Java JUnit test spec upload for a web app.
APPIUM_WEB_JAVA_TESTNG_TEST_SPEC: An Appium Java TestNG test spec upload for a web app.
APPIUM_WEB_PYTHON_TEST_SPEC: An Appium Python test spec upload for a web app.
APPIUM_WEB_NODE_TEST_SPEC: An Appium Node.js test spec upload for a web app.
APPIUM_WEB_RUBY_TEST_SPEC: An Appium Ruby test spec upload for a web app.
INSTRUMENTATION_TEST_SPEC: An instrumentation test spec upload.
XCTEST_UI_TEST_SPEC: An XCode UI test spec upload.
The upload\'s type.
Must be one of the following values:
ANDROID_APP: An Android upload.
IOS_APP: An iOS upload.
WEB_APP: A web appliction upload.
EXTERNAL_DATA: An external data upload.
APPIUM_JAVA_JUNIT_TEST_PACKAGE: An Appium Java JUnit test package upload.
APPIUM_JAVA_TESTNG_TEST_PACKAGE: An Appium Java TestNG test package upload.
APPIUM_PYTHON_TEST_PACKAGE: An Appium Python test package upload.
APPIUM_NODE_TEST_PACKAGE: An Appium Node.js test package upload.
APPIUM_RUBY_TEST_PACKAGE: An Appium Ruby test package upload.
APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE: An Appium Java JUnit test package upload for web apps.
APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE: An Appium Java TestNG test package upload for web apps.
APPIUM_WEB_PYTHON_TEST_PACKAGE: An Appium Python test package upload for web apps.
APPIUM_WEB_NODE_TEST_PACKAGE: An Appium Node.js test package upload for web apps.
APPIUM_WEB_RUBY_TEST_PACKAGE: An Appium Ruby test package upload for web apps.
CALABASH_TEST_PACKAGE: A Calabash test package upload.
INSTRUMENTATION_TEST_PACKAGE: An instrumentation upload.
UIAUTOMATION_TEST_PACKAGE: A uiautomation test package upload.
UIAUTOMATOR_TEST_PACKAGE: A uiautomator test package upload.
XCTEST_TEST_PACKAGE: An XCode test package upload.
XCTEST_UI_TEST_PACKAGE: An XCode UI test package upload.
APPIUM_JAVA_JUNIT_TEST_SPEC: An Appium Java JUnit test spec upload.
APPIUM_JAVA_TESTNG_TEST_SPEC: An Appium Java TestNG test spec upload.
APPIUM_PYTHON_TEST_SPEC: An Appium Python test spec upload.
APPIUM_NODE_TEST_SPEC: An Appium Node.js test spec upload.
APPIUM_RUBY_TEST_SPEC: An Appium Ruby test spec upload.
APPIUM_WEB_JAVA_JUNIT_TEST_SPEC: An Appium Java JUnit test spec upload for a web app.
APPIUM_WEB_JAVA_TESTNG_TEST_SPEC: An Appium Java TestNG test spec upload for a web app.
APPIUM_WEB_PYTHON_TEST_SPEC: An Appium Python test spec upload for a web app.
APPIUM_WEB_NODE_TEST_SPEC: An Appium Node.js test spec upload for a web app.
APPIUM_WEB_RUBY_TEST_SPEC: An Appium Ruby test spec upload for a web app.
INSTRUMENTATION_TEST_SPEC: An instrumentation test spec upload.
XCTEST_UI_TEST_SPEC: An XCode UI test spec upload.
Information about the uploads.
', ], ], 'VPCEConfiguration' => [ 'base' => 'Represents an Amazon Virtual Private Cloud (VPC) endpoint configuration.
', 'refs' => [ 'CreateVPCEConfigurationResult$vpceConfiguration' => 'An object containing information about your VPC endpoint configuration.
', 'GetVPCEConfigurationResult$vpceConfiguration' => 'An object containing information about your VPC endpoint configuration.
', 'UpdateVPCEConfigurationResult$vpceConfiguration' => 'An object containing information about your VPC endpoint configuration.
', 'VPCEConfigurations$member' => NULL, ], ], 'VPCEConfigurationDescription' => [ 'base' => NULL, 'refs' => [ 'CreateVPCEConfigurationRequest$vpceConfigurationDescription' => 'An optional description, providing more details about your VPC endpoint configuration.
', 'UpdateVPCEConfigurationRequest$vpceConfigurationDescription' => 'An optional description, providing more details about your VPC endpoint configuration.
', 'VPCEConfiguration$vpceConfigurationDescription' => 'An optional description, providing more details about your VPC endpoint configuration.
', ], ], 'VPCEConfigurationName' => [ 'base' => NULL, 'refs' => [ 'CreateVPCEConfigurationRequest$vpceConfigurationName' => 'The friendly name you give to your VPC endpoint configuration, to manage your configurations more easily.
', 'UpdateVPCEConfigurationRequest$vpceConfigurationName' => 'The friendly name you give to your VPC endpoint configuration, to manage your configurations more easily.
', 'VPCEConfiguration$vpceConfigurationName' => 'The friendly name you give to your VPC endpoint configuration, to manage your configurations more easily.
', ], ], 'VPCEConfigurations' => [ 'base' => NULL, 'refs' => [ 'ListVPCEConfigurationsResult$vpceConfigurations' => 'An array of VPCEConfiguration
objects containing information about your VPC endpoint configuration.
The name of the VPC endpoint service running inside your AWS account that you want Device Farm to test.
', 'UpdateVPCEConfigurationRequest$vpceServiceName' => 'The name of the VPC endpoint service running inside your AWS account that you want Device Farm to test.
', 'VPCEConfiguration$vpceServiceName' => 'The name of the VPC endpoint service running inside your AWS account that you want Device Farm to test.
', ], ], 'VideoCapture' => [ 'base' => NULL, 'refs' => [ 'ExecutionConfiguration$videoCapture' => 'Set to true to enable video capture; otherwise, set to false. The default is true.
', 'Job$videoCapture' => 'This value is set to true if video capture is enabled; otherwise, it is set to false.
', ], ], ],]; diff --git a/src/data/ecs/2014-11-13/docs-2.json b/src/data/ecs/2014-11-13/docs-2.json index daf99e77e1..0a4d442fdc 100644 --- a/src/data/ecs/2014-11-13/docs-2.json +++ b/src/data/ecs/2014-11-13/docs-2.json @@ -128,11 +128,11 @@ "base": null, "refs": { "ContainerInstance$agentConnected": "This parameter returns true
if the agent is connected to Amazon ECS. Registered instances with an agent that may be unhealthy or stopped return false
. Only instances connected to an agent can accept placement requests.
Specifies whether to enable Amazon ECS managed tags for the tasks within the service. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.
", + "CreateServiceRequest$enableECSManagedTags": "Specifies whether to enable Amazon ECS managed tags for the tasks within the service. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.
", "ListAccountSettingsRequest$effectiveSettings": "Specifies whether to return the effective settings. If true
, the account settings for the root user or the default setting for the principalArn
. If false
, the account settings for the principalArn
are returned if they are set. Otherwise, no account settings are returned.
Specifies whether to enable Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.
", - "Service$enableECSManagedTags": "Specifies whether to enable Amazon ECS managed tags for the tasks in the service. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.
", - "StartTaskRequest$enableECSManagedTags": "Specifies whether to enable Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.
", + "RunTaskRequest$enableECSManagedTags": "Specifies whether to enable Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.
", + "Service$enableECSManagedTags": "Specifies whether to enable Amazon ECS managed tags for the tasks in the service. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.
", + "StartTaskRequest$enableECSManagedTags": "Specifies whether to enable Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.
", "UpdateServiceRequest$forceNewDeployment": "Whether to force a new deployment of the service. Deployments are not forced by default. You can use this option to trigger a new deployment with no service definition changes. For example, you can update a service's tasks to use a newer Docker image with the same image/tag combination (my_image:latest
) or to roll Fargate tasks onto a newer platform version.
Amazon Elastic Container Service (Amazon ECS) is a highly scalable, fast, container management service that makes it easy to run, stop, and manage Docker containers on a cluster. You can host your cluster on a serverless infrastructure that is managed by Amazon ECS by launching your services or tasks using the Fargate launch type. For more control, you can host your tasks on a cluster of Amazon Elastic Compute Cloud (Amazon EC2) instances that you manage by using the EC2 launch type. For more information about launch types, see Amazon ECS Launch Types.
Amazon ECS lets you launch and stop container-based applications with simple API calls, allows you to get the state of your cluster from a centralized service, and gives you access to many familiar Amazon EC2 features.
You can use Amazon ECS to schedule the placement of containers across your cluster based on your resource needs, isolation policies, and availability requirements. Amazon ECS eliminates the need for you to operate your own cluster management and configuration management systems or worry about scaling your management infrastructure.
', 'operations' => [ 'CreateCluster' => 'Creates a new Amazon ECS cluster. By default, your account receives a default
cluster when you launch your first container instance. However, you can create your own cluster with a unique name with the CreateCluster
action.
When you call the CreateCluster API operation, Amazon ECS attempts to create the service-linked role for your account so that required resources in other AWS services can be managed on your behalf. However, if the IAM user that makes the call does not have permissions to create the service-linked role, it is not created. For more information, see Using Service-Linked Roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.
Runs and maintains a desired number of tasks from a specified task definition. If the number of tasks running in a service drops below desiredCount
, Amazon ECS spawns another copy of the task in the specified cluster. To update an existing service, see UpdateService.
In addition to maintaining the desired count of tasks in your service, you can optionally run your service behind a load balancer. The load balancer distributes traffic across the tasks that are associated with the service. For more information, see Service Load Balancing in the Amazon Elastic Container Service Developer Guide.
You can optionally specify a deployment configuration for your service. The deployment is triggered by changing properties, such as the task definition or the desired count of a service, with an UpdateService operation.
If a service is using the ECS
deployment controller, the minimum healthy percent represents a lower limit on the number of tasks in a service that must remain in the RUNNING
state during a deployment, as a percentage of the desired number of tasks (rounded up to the nearest integer), and while any container instances are in the DRAINING
state if the service contains tasks using the EC2 launch type. This parameter enables you to deploy without using additional cluster capacity. For example, if your service has a desired number of four tasks and a minimum healthy percent of 50%, the scheduler may stop two existing tasks to free up cluster capacity before starting two new tasks. Tasks for services that do not use a load balancer are considered healthy if they are in the RUNNING
state; tasks for services that do use a load balancer are considered healthy if they are in the RUNNING
state and they are reported as healthy by the load balancer. The default value for minimum healthy percent is 100%.
If a service is using the ECS
deployment controller, the maximum percent parameter represents an upper limit on the number of tasks in a service that are allowed in the RUNNING
or PENDING
state during a deployment, as a percentage of the desired number of tasks (rounded down to the nearest integer), and while any container instances are in the DRAINING
state if the service contains tasks using the EC2 launch type. This parameter enables you to define the deployment batch size. For example, if your service has a desired number of four tasks and a maximum percent value of 200%, the scheduler may start four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available). The default value for maximum percent is 200%.
If a service is using the CODE_DEPLOY
deployment controller and tasks that use the EC2 launch type, the minimum healthy percent and maximum percent values are only used to define the lower and upper limit on the number of the tasks in the service that remain in the RUNNING
state while the container instances are in the DRAINING
state. If the tasks in the service use the Fargate launch type, the minimum healthy percent and maximum percent values are not used, although they are currently visible when describing your service.
Tasks for services that do not use a load balancer are considered healthy if they are in the RUNNING
state. Tasks for services that do use a load balancer are considered healthy if they are in the RUNNING
state and the container instance they are hosted on is reported as healthy by the load balancer. The default value for a replica service for minimumHealthyPercent
is 100%. The default value for a daemon service for minimumHealthyPercent
is 0%.
When the service scheduler launches new tasks, it determines task placement in your cluster using the following logic:
Determine which of the container instances in your cluster can support your service\'s task definition (for example, they have the required CPU, memory, ports, and container instance attributes).
By default, the service scheduler attempts to balance tasks across Availability Zones in this manner (although you can choose a different placement strategy) with the placementStrategy
parameter):
Sort the valid container instances, giving priority to instances that have the fewest number of running tasks for this service in their respective Availability Zone. For example, if zone A has one running service task and zones B and C each have zero, valid container instances in either zone B or C are considered optimal for placement.
Place the new service task on a valid container instance in an optimal Availability Zone (based on the previous steps), favoring container instances with the fewest number of running tasks for this service.
Modifies the ARN and resource ID format of a resource for a specified IAM user, IAM role, or the root user for an account. You can specify whether the new ARN and resource ID format are disabled for new resources that are created.
', 'DeleteAttributes' => 'Deletes one or more custom attributes from an Amazon ECS resource.
', 'DeleteCluster' => 'Deletes the specified cluster. You must deregister all container instances from this cluster before you may delete it. You can list the container instances in a cluster with ListContainerInstances and deregister them with DeregisterContainerInstance.
', 'DeleteService' => 'Deletes a specified service within a cluster. You can delete a service if you have no running tasks in it and the desired task count is zero. If the service is actively maintaining tasks, you cannot delete it, and you must update the service to a desired task count of zero. For more information, see UpdateService.
When you delete a service, if there are still running tasks that require cleanup, the service status moves from ACTIVE
to DRAINING
, and the service is no longer visible in the console or in the ListServices API operation. After the tasks have stopped, then the service status moves from DRAINING
to INACTIVE
. Services in the DRAINING
or INACTIVE
status can still be viewed with the DescribeServices API operation. However, in the future, INACTIVE
services may be cleaned up and purged from Amazon ECS record keeping, and DescribeServices calls on those services return a ServiceNotFoundException
error.
If you attempt to create a new service with the same name as an existing service in either ACTIVE
or DRAINING
status, you receive an error.
Deregisters an Amazon ECS container instance from the specified cluster. This instance is no longer available to run tasks.
If you intend to use the container instance for some other purpose after deregistration, you should stop all of the tasks running on the container instance before deregistration. That prevents any orphaned tasks from consuming resources.
Deregistering a container instance removes the instance from a cluster, but it does not terminate the EC2 instance. If you are finished using the instance, be sure to terminate it in the Amazon EC2 console to stop billing.
If you terminate a running container instance, Amazon ECS automatically deregisters the instance from your cluster (stopped container instances or instances with disconnected agents are not automatically deregistered when terminated).
Deregisters the specified task definition by family and revision. Upon deregistration, the task definition is marked as INACTIVE
. Existing tasks and services that reference an INACTIVE
task definition continue to run without disruption. Existing services that reference an INACTIVE
task definition can still scale up or down by modifying the service\'s desired count.
You cannot use an INACTIVE
task definition to run new tasks or create new services, and you cannot update an existing service to reference an INACTIVE
task definition. However, there may be up to a 10-minute window following deregistration where these restrictions have not yet taken effect.
At this time, INACTIVE
task definitions remain discoverable in your account indefinitely. However, this behavior is subject to change in the future, so you should not rely on INACTIVE
task definitions persisting beyond the lifecycle of any associated tasks and services.
Describes one or more of your clusters.
', 'DescribeContainerInstances' => 'Describes Amazon Elastic Container Service container instances. Returns metadata about registered and remaining resources on each container instance requested.
', 'DescribeServices' => 'Describes the specified services running in your cluster.
', 'DescribeTaskDefinition' => 'Describes a task definition. You can specify a family
and revision
to find information about a specific task definition, or you can simply specify the family to find the latest ACTIVE
revision in that family.
You can only describe INACTIVE
task definitions while an active task or service references them.
Describes a specified task or tasks.
', 'DiscoverPollEndpoint' => 'This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.
Returns an endpoint for the Amazon ECS agent to poll for updates.
', 'ListAccountSettings' => 'Lists the account settings for an Amazon ECS resource for a specified principal.
', 'ListAttributes' => 'Lists the attributes for Amazon ECS resources within a specified target type and cluster. When you specify a target type and cluster, ListAttributes
returns a list of attribute objects, one for each attribute on each resource. You can filter the list of results to a single attribute name to only return results that have that name. You can also filter the results by attribute name and value, for example, to see which container instances in a cluster are running a Linux AMI (ecs.os-type=linux
).
Returns a list of existing clusters.
', 'ListContainerInstances' => 'Returns a list of container instances in a specified cluster. You can filter the results of a ListContainerInstances
operation with cluster query language statements inside the filter
parameter. For more information, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide.
Lists the services that are running in a specified cluster.
', 'ListTagsForResource' => 'List the tags for an Amazon ECS resource.
', 'ListTaskDefinitionFamilies' => 'Returns a list of task definition families that are registered to your account (which may include task definition families that no longer have any ACTIVE
task definition revisions).
You can filter out task definition families that do not contain any ACTIVE
task definition revisions by setting the status
parameter to ACTIVE
. You can also filter the results with the familyPrefix
parameter.
Returns a list of task definitions that are registered to your account. You can filter the results by family name with the familyPrefix
parameter or by status with the status
parameter.
Returns a list of tasks for a specified cluster. You can filter the results by family name, by a particular container instance, or by the desired status of the task with the family
, containerInstance
, and desiredStatus
parameters.
Recently stopped tasks might appear in the returned results. Currently, stopped tasks appear in the returned results for at least one hour.
', 'PutAccountSetting' => 'Modifies the ARN and resource ID format of a resource for a specified IAM user, IAM role, or the root user for an account. You can specify whether the new ARN and resource ID format are enabled for new resources that are created. Enabling this setting is required to use new Amazon ECS features such as resource tagging.
', 'PutAttributes' => 'Create or update an attribute on an Amazon ECS resource. If the attribute does not exist, it is created. If the attribute exists, its value is replaced with the specified value. To delete an attribute, use DeleteAttributes. For more information, see Attributes in the Amazon Elastic Container Service Developer Guide.
', 'RegisterContainerInstance' => 'This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.
Registers an EC2 instance into the specified cluster. This instance becomes available to place containers on.
', 'RegisterTaskDefinition' => 'Registers a new task definition from the supplied family
and containerDefinitions
. Optionally, you can add data volumes to your containers with the volumes
parameter. For more information about task definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon Elastic Container Service Developer Guide.
You can specify an IAM role for your task with the taskRoleArn
parameter. When you specify an IAM role for a task, its containers can then use the latest versions of the AWS CLI or SDKs to make API requests to the AWS services that are specified in the IAM policy associated with the role. For more information, see IAM Roles for Tasks in the Amazon Elastic Container Service Developer Guide.
You can specify a Docker networking mode for the containers in your task definition with the networkMode
parameter. The available network modes correspond to those described in Network settings in the Docker run reference. If you specify the awsvpc
network mode, the task is allocated an elastic network interface, and you must specify a NetworkConfiguration when you create a service or run a task with the task definition. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide.
Starts a new task using the specified task definition.
You can allow Amazon ECS to place tasks for you, or you can customize how Amazon ECS places tasks using placement constraints and placement strategies. For more information, see Scheduling Tasks in the Amazon Elastic Container Service Developer Guide.
Alternatively, you can use StartTask to use your own scheduler or place tasks manually on specific container instances.
The Amazon ECS API follows an eventual consistency model, due to the distributed nature of the system supporting the API. This means that the result of an API command you run that affects your Amazon ECS resources might not be immediately visible to all subsequent commands you run. Keep this in mind when you carry out an API command that immediately follows a previous API command.
To manage eventual consistency, you can do the following:
Confirm the state of the resource before you run a command to modify it. Run the DescribeTasks command using an exponential backoff algorithm to ensure that you allow enough time for the previous command to propagate through the system. To do this, run the DescribeTasks command repeatedly, starting with a couple of seconds of wait time and increasing gradually up to five minutes of wait time.
Add wait time between subsequent commands, even if the DescribeTasks command returns an accurate response. Apply an exponential backoff algorithm starting with a couple of seconds of wait time, and increase gradually up to about five minutes of wait time.
Starts a new task from the specified task definition on the specified container instance or instances.
Alternatively, you can use RunTask to place tasks for you. For more information, see Scheduling Tasks in the Amazon Elastic Container Service Developer Guide.
', 'StopTask' => 'Stops a running task. Any tags associated with the task will be deleted.
When StopTask is called on a task, the equivalent of docker stop
is issued to the containers running in the task. This results in a SIGTERM
value and a default 30-second timeout, after which the SIGKILL
value is sent and the containers are forcibly stopped. If the container handles the SIGTERM
value gracefully and exits within 30 seconds from receiving it, no SIGKILL
value is sent.
The default 30-second timeout can be configured on the Amazon ECS container agent with the ECS_CONTAINER_STOP_TIMEOUT
variable. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide.
This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.
Sent to acknowledge that a container changed states.
', 'SubmitTaskStateChange' => 'This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.
Sent to acknowledge that a task changed states.
', 'TagResource' => 'Associates the specified tags to a resource with the specified resourceArn
. If existing tags on a resource are not specified in the request parameters, they are not changed. When a resource is deleted, the tags associated with that resource are deleted as well.
Deletes specified tags from a resource.
', 'UpdateContainerAgent' => 'Updates the Amazon ECS container agent on a specified container instance. Updating the Amazon ECS container agent does not interrupt running tasks or services on the container instance. The process for updating the agent differs depending on whether your container instance was launched with the Amazon ECS-optimized AMI or another operating system.
UpdateContainerAgent
requires the Amazon ECS-optimized AMI or Amazon Linux with the ecs-init
service installed and running. For help updating the Amazon ECS container agent on other operating systems, see Manually Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide.
Modifies the status of an Amazon ECS container instance.
You can change the status of a container instance to DRAINING
to manually remove an instance from a cluster, for example to perform system updates, update the Docker daemon, or scale down the cluster size.
When you set a container instance to DRAINING
, Amazon ECS prevents new tasks from being scheduled for placement on the container instance and replacement service tasks are started on other container instances in the cluster if the resources are available. Service tasks on the container instance that are in the PENDING
state are stopped immediately.
Service tasks on the container instance that are in the RUNNING
state are stopped and replaced according to the service\'s deployment configuration parameters, minimumHealthyPercent
and maximumPercent
. You can change the deployment configuration of your service using UpdateService.
If minimumHealthyPercent
is below 100%, the scheduler can ignore desiredCount
temporarily during task replacement. For example, desiredCount
is four tasks, a minimum of 50% allows the scheduler to stop two existing tasks before starting two new tasks. If the minimum is 100%, the service scheduler can\'t remove existing tasks until the replacement tasks are considered healthy. Tasks for services that do not use a load balancer are considered healthy if they are in the RUNNING
state. Tasks for services that use a load balancer are considered healthy if they are in the RUNNING
state and the container instance they are hosted on is reported as healthy by the load balancer.
The maximumPercent
parameter represents an upper limit on the number of running tasks during task replacement, which enables you to define the replacement batch size. For example, if desiredCount
is four tasks, a maximum of 200% starts four new tasks before stopping the four tasks to be drained, provided that the cluster resources required to do this are available. If the maximum is 100%, then replacement tasks can\'t start until the draining tasks have stopped.
Any PENDING
or RUNNING
tasks that do not belong to a service are not affected. You must wait for them to finish or stop them manually.
A container instance has completed draining when it has no more RUNNING
tasks. You can verify this using ListTasks.
When you set a container instance to ACTIVE
, the Amazon ECS scheduler can begin scheduling tasks on the instance again.
Modifies the parameters of a service.
For services using the rolling update (ECS
) deployment controller, the desired count, deployment configuration, network configuration, or task definition used can be updated.
For services using the blue/green (CODE_DEPLOY
) deployment controller, only the desired count, deployment configuration, and health check grace period can be updated using this API. If the network configuration, platform version, or task definition need to be updated, a new AWS CodeDeploy deployment should be created. For more information, see CreateDeployment in the AWS CodeDeploy API Reference.
You can add to or subtract from the number of instantiations of a task definition in a service by specifying the cluster that the service is running in and a new desiredCount
parameter.
If you have updated the Docker image of your application, you can create a new task definition with that image and deploy it to your service. The service scheduler uses the minimum healthy percent and maximum percent parameters (in the service\'s deployment configuration) to determine the deployment strategy.
If your updated Docker image uses the same tag as what is in the existing task definition for your service (for example, my_image:latest
), you do not need to create a new revision of your task definition. You can update the service using the forceNewDeployment
option. The new tasks launched by the deployment pull the current image/tag combination from your repository when they start.
You can also update the deployment configuration of a service. When a deployment is triggered by updating the task definition of a service, the service scheduler uses the deployment configuration parameters, minimumHealthyPercent
and maximumPercent
, to determine the deployment strategy.
If minimumHealthyPercent
is below 100%, the scheduler can ignore desiredCount
temporarily during a deployment. For example, if desiredCount
is four tasks, a minimum of 50% allows the scheduler to stop two existing tasks before starting two new tasks. Tasks for services that do not use a load balancer are considered healthy if they are in the RUNNING
state. Tasks for services that use a load balancer are considered healthy if they are in the RUNNING
state and the container instance they are hosted on is reported as healthy by the load balancer.
The maximumPercent
parameter represents an upper limit on the number of running tasks during a deployment, which enables you to define the deployment batch size. For example, if desiredCount
is four tasks, a maximum of 200% starts four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available).
When UpdateService stops a task during a deployment, the equivalent of docker stop
is issued to the containers running in the task. This results in a SIGTERM
and a 30-second timeout, after which SIGKILL
is sent and the containers are forcibly stopped. If the container handles the SIGTERM
gracefully and exits within 30 seconds from receiving it, no SIGKILL
is sent.
When the service scheduler launches new tasks, it determines task placement in your cluster with the following logic:
Determine which of the container instances in your cluster can support your service\'s task definition (for example, they have the required CPU, memory, ports, and container instance attributes).
By default, the service scheduler attempts to balance tasks across Availability Zones in this manner (although you can choose a different placement strategy):
Sort the valid container instances by the fewest number of running tasks for this service in the same Availability Zone as the instance. For example, if zone A has one running service task and zones B and C each have zero, valid container instances in either zone B or C are considered optimal for placement.
Place the new service task on a valid container instance in an optimal Availability Zone (based on the previous steps), favoring container instances with the fewest number of running tasks for this service.
When the service scheduler stops running tasks, it attempts to maintain balance across the Availability Zones in your cluster using the following logic:
Sort the container instances by the largest number of running tasks for this service in the same Availability Zone as the instance. For example, if zone A has one running service task and zones B and C each have two, container instances in either zone B or C are considered optimal for termination.
Stop the task on a container instance in an optimal Availability Zone (based on the previous steps), favoring container instances with the largest number of running tasks for this service.
You do not have authorization to perform the requested action.
', 'refs' => [], ], 'AgentUpdateStatus' => [ 'base' => NULL, 'refs' => [ 'ContainerInstance$agentUpdateStatus' => 'The status of the most recent agent update. If an update has never been requested, this value is NULL
.
Whether the task\'s elastic network interface receives a public IP address. The default value is DISABLED
.
An object representing a container instance or task attachment.
', 'refs' => [ 'Attachments$member' => NULL, ], ], 'AttachmentDetails' => [ 'base' => NULL, 'refs' => [ 'Attachment$details' => 'Details of the attachment. For elastic network interfaces, this includes the network interface ID, the MAC address, the subnet ID, and the private IPv4 address.
', ], ], 'AttachmentStateChange' => [ 'base' => 'An object representing a change in state for a task attachment.
', 'refs' => [ 'AttachmentStateChanges$member' => NULL, ], ], 'AttachmentStateChanges' => [ 'base' => NULL, 'refs' => [ 'SubmitTaskStateChangeRequest$attachments' => 'Any attachments associated with the state change request.
', ], ], 'Attachments' => [ 'base' => NULL, 'refs' => [ 'ContainerInstance$attachments' => 'The elastic network interfaces associated with the container instance.
', 'Task$attachments' => 'The Elastic Network Adapter associated with the task if the task uses the awsvpc
network mode.
An attribute is a name-value pair associated with an Amazon ECS object. Attributes enable you to extend the Amazon ECS data model by adding custom metadata to your resources. For more information, see Attributes in the Amazon Elastic Container Service Developer Guide.
', 'refs' => [ 'Attributes$member' => NULL, 'RequiresAttributes$member' => NULL, ], ], 'AttributeLimitExceededException' => [ 'base' => 'You can apply up to 10 custom attributes per resource. You can view the attributes of a resource with ListAttributes. You can remove existing attributes on a resource with DeleteAttributes.
', 'refs' => [], ], 'Attributes' => [ 'base' => NULL, 'refs' => [ 'ContainerInstance$attributes' => 'The attributes set for the container instance, either by the Amazon ECS container agent at instance registration or manually with the PutAttributes operation.
', 'DeleteAttributesRequest$attributes' => 'The attributes to delete from your resource. You can specify up to 10 attributes per request. For custom attributes, specify the attribute name and target ID, but do not specify the value. If you specify the target ID using the short form, you must also specify the target type.
', 'DeleteAttributesResponse$attributes' => 'A list of attribute objects that were successfully deleted from your resource.
', 'ListAttributesResponse$attributes' => 'A list of attribute objects that meet the criteria of the request.
', 'PutAttributesRequest$attributes' => 'The attributes to apply to your resource. You can specify up to 10 custom attributes per resource. You can specify up to 10 attributes in a single call.
', 'PutAttributesResponse$attributes' => 'The attributes applied to your resource.
', 'RegisterContainerInstanceRequest$attributes' => 'The container instance attributes that this container instance supports.
', ], ], 'AwsVpcConfiguration' => [ 'base' => 'An object representing the networking details for a task or service.
', 'refs' => [ 'NetworkConfiguration$awsvpcConfiguration' => 'The VPC subnets and security groups associated with a task.
All specified subnets and security groups must be from the same VPC.
Your AWS account has been blocked. For more information, contact AWS Support.
', 'refs' => [], ], 'Boolean' => [ 'base' => NULL, 'refs' => [ 'ContainerInstance$agentConnected' => 'This parameter returns true
if the agent is connected to Amazon ECS. Registered instances with an agent that may be unhealthy or stopped return false
. Only instances connected to an agent can accept placement requests.
Specifies whether to enable Amazon ECS managed tags for the tasks within the service. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.
', 'ListAccountSettingsRequest$effectiveSettings' => 'Specifies whether to return the effective settings. If true
, the account settings for the root user or the default setting for the principalArn
. If false
, the account settings for the principalArn
are returned if they are set. Otherwise, no account settings are returned.
Specifies whether to enable Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.
', 'Service$enableECSManagedTags' => 'Specifies whether to enable Amazon ECS managed tags for the tasks in the service. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.
', 'StartTaskRequest$enableECSManagedTags' => 'Specifies whether to enable Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.
', 'UpdateServiceRequest$forceNewDeployment' => 'Whether to force a new deployment of the service. Deployments are not forced by default. You can use this option to trigger a new deployment with no service definition changes. For example, you can update a service\'s tasks to use a newer Docker image with the same image/tag combination (my_image:latest
) or to roll Fargate tasks onto a newer platform version.
If the essential
parameter of a container is marked as true
, and that container fails or stops for any reason, all other containers that are part of the task are stopped. If the essential
parameter of a container is marked as false
, then its failure does not affect the rest of the containers in a task. If this parameter is omitted, a container is assumed to be essential.
All tasks must have at least one essential container. If you have an application that is composed of multiple containers, you should group containers that are used for a common purpose into components, and separate the different components into multiple task definitions. For more information, see Application Architecture in the Amazon Elastic Container Service Developer Guide.
', 'ContainerDefinition$disableNetworking' => 'When this parameter is true, networking is disabled within the container. This parameter maps to NetworkDisabled
in the Create a container section of the Docker Remote API.
This parameter is not supported for Windows containers.
When this parameter is true, the container is given elevated privileges on the host container instance (similar to the root
user). This parameter maps to Privileged
in the Create a container section of the Docker Remote API and the --privileged
option to docker run.
This parameter is not supported for Windows containers or tasks using the Fargate launch type.
When this parameter is true, the container is given read-only access to its root file system. This parameter maps to ReadonlyRootfs
in the Create a container section of the Docker Remote API and the --read-only
option to docker run.
This parameter is not supported for Windows containers.
When this parameter is true
, this allows you to deploy containerized applications that require stdin
or a tty
to be allocated. This parameter maps to OpenStdin
in the Create a container section of the Docker Remote API and the --interactive
option to docker run.
When this parameter is true
, a TTY is allocated. This parameter maps to Tty
in the Create a container section of the Docker Remote API and the --tty
option to docker run.
If true
, allows you to delete a service even if it has not been scaled down to zero tasks. It is only necessary to use this if the service is using the REPLICA
scheduling strategy.
Forces the deregistration of the container instance. If you have tasks running on the container instance when you deregister it with the force
option, these tasks remain running until you terminate the instance or the tasks stop through some other means, but they are orphaned (no longer monitored or accounted for by Amazon ECS). If an orphaned task on your container instance is part of an Amazon ECS service, then the service scheduler starts another copy of that task, on a different container instance if possible.
Any containers in orphaned service tasks that are registered with a Classic Load Balancer or an Application Load Balancer target group are deregistered. They begin connection draining according to the settings on the load balancer or target group.
', 'DockerVolumeConfiguration$autoprovision' => 'If this value is true
, the Docker volume is created if it does not already exist.
This field is only used if the scope
is shared
.
Run an init
process inside the container that forwards signals and reaps processes. This parameter maps to the --init
option to docker run. This parameter requires version 1.25 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format \'{{.Server.APIVersion}}\'
If this value is true
, the container has read-only access to the volume. If this value is false
, then the container can write to the volume. The default value is false
.
If this value is true
, the container has read-only access to the volume. If this value is false
, then the container can write to the volume. The default value is false
.
The exit code returned from the container.
', 'ContainerDefinition$memory' => 'The hard limit (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. This parameter maps to Memory
in the Create a container section of the Docker Remote API and the --memory
option to docker run.
If your containers are part of a task using the Fargate launch type, this field is optional and the only requirement is that the total amount of memory reserved for all containers within a task be lower than the task memory
value.
For containers that are part of a task using the EC2 launch type, you must specify a non-zero integer for one or both of memory
or memoryReservation
in container definitions. If you specify both, memory
must be greater than memoryReservation
. If you specify memoryReservation
, then that value is subtracted from the available memory resources for the container instance on which the container is placed. Otherwise, the value of memory
is used.
The Docker daemon reserves a minimum of 4 MiB of memory for a container, so you should not specify fewer than 4 MiB of memory for your containers.
', 'ContainerDefinition$memoryReservation' => 'The soft limit (in MiB) of memory to reserve for the container. When system memory is under heavy contention, Docker attempts to keep the container memory to this soft limit. However, your container can consume more memory when it needs to, up to either the hard limit specified with the memory
parameter (if applicable), or all of the available memory on the container instance, whichever comes first. This parameter maps to MemoryReservation
in the Create a container section of the Docker Remote API and the --memory-reservation
option to docker run.
You must specify a non-zero integer for one or both of memory
or memoryReservation
in container definitions. If you specify both, memory
must be greater than memoryReservation
. If you specify memoryReservation
, then that value is subtracted from the available memory resources for the container instance on which the container is placed. Otherwise, the value of memory
is used.
For example, if your container normally uses 128 MiB of memory, but occasionally bursts to 256 MiB of memory for short periods of time, you can set a memoryReservation
of 128 MiB, and a memory
hard limit of 300 MiB. This configuration would allow the container to only reserve 128 MiB of memory from the remaining resources on the container instance, but also allow the container to consume more memory resources when needed.
The Docker daemon reserves a minimum of 4 MiB of memory for a container, so you should not specify fewer than 4 MiB of memory for your containers.
', 'ContainerOverride$cpu' => 'The number of cpu
units reserved for the container, instead of the default value from the task definition. You must also specify a container name.
The hard limit (in MiB) of memory to present to the container, instead of the default value from the task definition. If your container attempts to exceed the memory specified here, the container is killed. You must also specify a container name.
', 'ContainerOverride$memoryReservation' => 'The soft limit (in MiB) of memory to reserve for the container, instead of the default value from the task definition. You must also specify a container name.
', 'ContainerStateChange$exitCode' => 'The exit code for the container, if the state change is a result of the container exiting.
', 'CreateServiceRequest$desiredCount' => 'The number of instantiations of the specified task definition to place and keep running on your cluster.
', 'CreateServiceRequest$healthCheckGracePeriodSeconds' => 'The period of time, in seconds, that the Amazon ECS service scheduler should ignore unhealthy Elastic Load Balancing target health checks after a task has first started. This is only valid if your service is configured to use a load balancer. If your service\'s tasks take a while to start and respond to Elastic Load Balancing health checks, you can specify a health check grace period of up to 7,200 seconds. During that time, the ECS service scheduler ignores health check status. This grace period can prevent the ECS service scheduler from marking tasks as unhealthy and stopping them before they have time to come up.
', 'DeploymentConfiguration$maximumPercent' => 'If a service is using the rolling update (ECS
) deployment type, the maximum percent parameter represents an upper limit on the number of tasks in a service that are allowed in the RUNNING
or PENDING
state during a deployment, as a percentage of the desired number of tasks (rounded down to the nearest integer), and while any container instances are in the DRAINING
state if the service contains tasks using the EC2 launch type. This parameter enables you to define the deployment batch size. For example, if your service has a desired number of four tasks and a maximum percent value of 200%, the scheduler may start four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available). The default value for maximum percent is 200%.
If a service is using the blue/green (CODE_DEPLOY
) deployment type and tasks that use the EC2 launch type, the maximum percent value is set to the default value and is used to define the upper limit on the number of the tasks in the service that remain in the RUNNING
state while the container instances are in the DRAINING
state. If the tasks in the service use the Fargate launch type, the maximum percent value is not used, although it is returned when describing your service.
If a service is using the rolling update (ECS
) deployment type, the minimum healthy percent represents a lower limit on the number of tasks in a service that must remain in the RUNNING
state during a deployment, as a percentage of the desired number of tasks (rounded up to the nearest integer), and while any container instances are in the DRAINING
state if the service contains tasks using the EC2 launch type. This parameter enables you to deploy without using additional cluster capacity. For example, if your service has a desired number of four tasks and a minimum healthy percent of 50%, the scheduler may stop two existing tasks to free up cluster capacity before starting two new tasks. Tasks for services that do not use a load balancer are considered healthy if they are in the RUNNING
state; tasks for services that do use a load balancer are considered healthy if they are in the RUNNING
state and they are reported as healthy by the load balancer. The default value for minimum healthy percent is 100%.
If a service is using the blue/green (CODE_DEPLOY
) deployment type and tasks that use the EC2 launch type, the minimum healthy percent value is set to the default value and is used to define the lower limit on the number of the tasks in the service that remain in the RUNNING
state while the container instances are in the DRAINING
state. If the tasks in the service use the Fargate launch type, the minimum healthy percent value is not used, although it is returned when describing your service.
The time period in seconds between each health check execution. You may specify between 5 and 300 seconds. The default value is 30 seconds.
', 'HealthCheck$timeout' => 'The time period in seconds to wait for a health check to succeed before it is considered a failure. You may specify between 2 and 60 seconds. The default value is 5.
', 'HealthCheck$retries' => 'The number of times to retry a failed health check before the container is considered unhealthy. You may specify between 1 and 10 retries. The default value is 3.
', 'HealthCheck$startPeriod' => 'The optional grace period within which to provide containers time to bootstrap before failed health checks count towards the maximum number of retries. You may specify between 0 and 300 seconds. The startPeriod
is disabled by default.
If a health check succeeds within the startPeriod
, then the container is considered healthy and any subsequent failures count toward the maximum number of retries.
The value for the size (in MiB) of the /dev/shm
volume. This parameter maps to the --shm-size
option to docker run.
If you are using tasks that use the Fargate launch type, the sharedMemorySize
parameter is not supported.
The maximum number of cluster results returned by ListAttributes
in paginated output. When this parameter is used, ListAttributes
only returns maxResults
results in a single page along with a nextToken
response element. The remaining results of the initial request can be seen by sending another ListAttributes
request with the returned nextToken
value. This value can be between 1 and 100. If this parameter is not used, then ListAttributes
returns up to 100 results and a nextToken
value if applicable.
The maximum number of cluster results returned by ListClusters
in paginated output. When this parameter is used, ListClusters
only returns maxResults
results in a single page along with a nextToken
response element. The remaining results of the initial request can be seen by sending another ListClusters
request with the returned nextToken
value. This value can be between 1 and 100. If this parameter is not used, then ListClusters
returns up to 100 results and a nextToken
value if applicable.
The maximum number of container instance results returned by ListContainerInstances
in paginated output. When this parameter is used, ListContainerInstances
only returns maxResults
results in a single page along with a nextToken
response element. The remaining results of the initial request can be seen by sending another ListContainerInstances
request with the returned nextToken
value. This value can be between 1 and 100. If this parameter is not used, then ListContainerInstances
returns up to 100 results and a nextToken
value if applicable.
The maximum number of service results returned by ListServices
in paginated output. When this parameter is used, ListServices
only returns maxResults
results in a single page along with a nextToken
response element. The remaining results of the initial request can be seen by sending another ListServices
request with the returned nextToken
value. This value can be between 1 and 100. If this parameter is not used, then ListServices
returns up to 10 results and a nextToken
value if applicable.
The maximum number of task definition family results returned by ListTaskDefinitionFamilies
in paginated output. When this parameter is used, ListTaskDefinitions
only returns maxResults
results in a single page along with a nextToken
response element. The remaining results of the initial request can be seen by sending another ListTaskDefinitionFamilies
request with the returned nextToken
value. This value can be between 1 and 100. If this parameter is not used, then ListTaskDefinitionFamilies
returns up to 100 results and a nextToken
value if applicable.
The maximum number of task definition results returned by ListTaskDefinitions
in paginated output. When this parameter is used, ListTaskDefinitions
only returns maxResults
results in a single page along with a nextToken
response element. The remaining results of the initial request can be seen by sending another ListTaskDefinitions
request with the returned nextToken
value. This value can be between 1 and 100. If this parameter is not used, then ListTaskDefinitions
returns up to 100 results and a nextToken
value if applicable.
The maximum number of task results returned by ListTasks
in paginated output. When this parameter is used, ListTasks
only returns maxResults
results in a single page along with a nextToken
response element. The remaining results of the initial request can be seen by sending another ListTasks
request with the returned nextToken
value. This value can be between 1 and 100. If this parameter is not used, then ListTasks
returns up to 100 results and a nextToken
value if applicable.
The port on the container to associate with the load balancer. This port must correspond to a containerPort
in the service\'s task definition. Your container instances must allow ingress traffic on the hostPort
of the port mapping.
The port number on the container that is used with the network binding.
', 'NetworkBinding$hostPort' => 'The port number on the host that is used with the network binding.
', 'PortMapping$containerPort' => 'The port number on the container that is bound to the user-specified or automatically assigned host port.
If you are using containers in a task with the awsvpc
or host
network mode, exposed ports should be specified using containerPort
.
If you are using containers in a task with the bridge
network mode and you specify a container port and not a host port, your container automatically receives a host port in the ephemeral port range. For more information, see hostPort
. Port mappings that are automatically assigned in this way do not count toward the 100 reserved ports limit of a container instance.
The port number on the container instance to reserve for your container.
If you are using containers in a task with the awsvpc
or host
network mode, the hostPort
can either be left blank or set to the same value as the containerPort
.
If you are using containers in a task with the bridge
network mode, you can specify a non-reserved host port for your container port mapping, or you can omit the hostPort
(or set it to 0
) while specifying a containerPort
and your container automatically receives a port in the ephemeral port range for your container instance operating system and Docker version.
The default ephemeral port range for Docker version 1.6.0 and later is listed on the instance under /proc/sys/net/ipv4/ip_local_port_range
. If this kernel parameter is unavailable, the default ephemeral port range from 49153 through 65535 is used. Do not attempt to specify a host port in the ephemeral port range as these are reserved for automatic assignment. In general, ports below 32768 are outside of the ephemeral port range.
The default ephemeral port range from 49153 through 65535 is always used for Docker versions before 1.6.0.
The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the Amazon ECS container agent ports 51678 and 51679. Any host port that was previously specified in a running task is also reserved while the task is running (after a task stops, the host port is released). The current reserved ports are displayed in the remainingResources
of DescribeContainerInstances output. A container instance may have up to 100 reserved ports at a time, including the default reserved ports. Aautomatically assigned ports do not count toward the 100 reserved ports limit.
The number of instantiations of the specified task to place on your cluster. You can specify up to 10 tasks per call.
', 'Service$healthCheckGracePeriodSeconds' => 'The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks after a task has first started.
', 'ServiceRegistry$port' => 'The port value used if your service discovery service specified an SRV record. This field may be used if both the awsvpc
network mode and SRV records are used.
The port value, already specified in the task definition, to be used for your service discovery service. If the task definition your service task specifies uses the bridge
or host
network mode, you must specify a containerName
and containerPort
combination from the task definition. If the task definition your service task specifies uses the awsvpc
network mode and a type SRV DNS record is used, you must specify either a containerName
and containerPort
combination or a port
value, but not both.
The exit code returned for the state change request.
', 'UpdateServiceRequest$desiredCount' => 'The number of instantiations of the task to place and keep running in your service.
', 'UpdateServiceRequest$healthCheckGracePeriodSeconds' => 'The period of time, in seconds, that the Amazon ECS service scheduler should ignore unhealthy Elastic Load Balancing target health checks after a task has first started. This is only valid if your service is configured to use a load balancer. If your service\'s tasks take a while to start and respond to Elastic Load Balancing health checks, you can specify a health check grace period of up to 1,800 seconds. During that time, the ECS service scheduler ignores the Elastic Load Balancing health check status. This grace period can prevent the ECS service scheduler from marking tasks as unhealthy and stopping them before they have time to come up.
', ], ], 'ClientException' => [ 'base' => 'These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn\'t have permissions to use the action or resource, or specifying an identifier that is not valid.
', 'refs' => [], ], 'Cluster' => [ 'base' => 'A regional grouping of one or more container instances on which you can run task requests. Each account receives a default cluster the first time you use the Amazon ECS service, but you may also create other clusters. Clusters may contain more than one instance type simultaneously.
', 'refs' => [ 'Clusters$member' => NULL, 'CreateClusterResponse$cluster' => 'The full description of your new cluster.
', 'DeleteClusterResponse$cluster' => 'The full description of the deleted cluster.
', ], ], 'ClusterContainsContainerInstancesException' => [ 'base' => 'You cannot delete a cluster that has registered container instances. First, deregister the container instances before you can delete the cluster. For more information, see DeregisterContainerInstance.
', 'refs' => [], ], 'ClusterContainsServicesException' => [ 'base' => 'You cannot delete a cluster that contains services. First, update the service to reduce its desired task count to 0 and then delete the service. For more information, see UpdateService and DeleteService.
', 'refs' => [], ], 'ClusterContainsTasksException' => [ 'base' => 'You cannot delete a cluster that has active tasks.
', 'refs' => [], ], 'ClusterField' => [ 'base' => NULL, 'refs' => [ 'ClusterFieldList$member' => NULL, ], ], 'ClusterFieldList' => [ 'base' => NULL, 'refs' => [ 'DescribeClustersRequest$include' => 'Additional information about your clusters to be separated by launch type, including:
runningEC2TasksCount
runningFargateTasksCount
pendingEC2TasksCount
pendingFargateTasksCount
activeEC2ServiceCount
activeFargateServiceCount
drainingEC2ServiceCount
drainingFargateServiceCount
The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region-specific.
', 'refs' => [], ], 'Clusters' => [ 'base' => NULL, 'refs' => [ 'DescribeClustersResponse$clusters' => 'The list of clusters.
', ], ], 'Compatibility' => [ 'base' => NULL, 'refs' => [ 'CompatibilityList$member' => NULL, ], ], 'CompatibilityList' => [ 'base' => NULL, 'refs' => [ 'RegisterTaskDefinitionRequest$requiresCompatibilities' => 'The launch type required by the task. If no value is specified, it defaults to EC2
.
The launch type to use with your task. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.
', 'TaskDefinition$requiresCompatibilities' => 'The launch type that the task is using.
', ], ], 'Connectivity' => [ 'base' => NULL, 'refs' => [ 'Task$connectivity' => 'The connectivity status of a task.
', ], ], 'Container' => [ 'base' => 'A Docker container that is part of a task.
', 'refs' => [ 'Containers$member' => NULL, ], ], 'ContainerDefinition' => [ 'base' => 'Container definitions are used in task definitions to describe the different containers that are launched as part of a task.
', 'refs' => [ 'ContainerDefinitions$member' => NULL, ], ], 'ContainerDefinitions' => [ 'base' => NULL, 'refs' => [ 'RegisterTaskDefinitionRequest$containerDefinitions' => 'A list of container definitions in JSON format that describe the different containers that make up your task.
', 'TaskDefinition$containerDefinitions' => 'A list of container definitions in JSON format that describe the different containers that make up your task. For more information about container definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon Elastic Container Service Developer Guide.
', ], ], 'ContainerInstance' => [ 'base' => 'An EC2 instance that is running the Amazon ECS agent and has been registered with a cluster.
', 'refs' => [ 'ContainerInstances$member' => NULL, 'DeregisterContainerInstanceResponse$containerInstance' => 'The container instance that was deregistered.
', 'RegisterContainerInstanceResponse$containerInstance' => 'The container instance that was registered.
', 'UpdateContainerAgentResponse$containerInstance' => 'The container instance for which the container agent was updated.
', ], ], 'ContainerInstanceField' => [ 'base' => NULL, 'refs' => [ 'ContainerInstanceFieldList$member' => NULL, ], ], 'ContainerInstanceFieldList' => [ 'base' => NULL, 'refs' => [ 'DescribeContainerInstancesRequest$include' => 'Specifies whether you want to see the resource tags for the container instance. If TAGS
is specified, the tags are included in the response. If this field is omitted, tags are not included in the response.
Filters the container instances by status. For example, if you specify the DRAINING
status, the results include only container instances that have been set to DRAINING
using UpdateContainerInstancesState. If you do not specify this parameter, the default is to include container instances set to ACTIVE
and DRAINING
.
The container instance state with which to update the container instance.
', ], ], 'ContainerInstances' => [ 'base' => NULL, 'refs' => [ 'DescribeContainerInstancesResponse$containerInstances' => 'The list of container instances.
', 'UpdateContainerInstancesStateResponse$containerInstances' => 'The list of container instances.
', ], ], 'ContainerOverride' => [ 'base' => 'The overrides that should be sent to a container.
', 'refs' => [ 'ContainerOverrides$member' => NULL, ], ], 'ContainerOverrides' => [ 'base' => NULL, 'refs' => [ 'TaskOverride$containerOverrides' => 'One or more container overrides sent to a task.
', ], ], 'ContainerStateChange' => [ 'base' => 'An object representing a change in state for a container.
', 'refs' => [ 'ContainerStateChanges$member' => NULL, ], ], 'ContainerStateChanges' => [ 'base' => NULL, 'refs' => [ 'SubmitTaskStateChangeRequest$containers' => 'Any containers associated with the state change request.
', ], ], 'Containers' => [ 'base' => NULL, 'refs' => [ 'Task$containers' => 'The containers associated with the task.
', ], ], 'CreateClusterRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateClusterResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateServiceRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateServiceResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAccountSettingRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAccountSettingResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAttributesRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAttributesResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteClusterRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteClusterResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteServiceRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteServiceResponse' => [ 'base' => NULL, 'refs' => [], ], 'Deployment' => [ 'base' => 'The details of an Amazon ECS service deployment. This is used when a service uses the CODE_DEPLOY
deployment controller type.
Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
', 'refs' => [ 'CreateServiceRequest$deploymentConfiguration' => 'Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
', 'Service$deploymentConfiguration' => 'Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
', 'UpdateServiceRequest$deploymentConfiguration' => 'Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
', ], ], 'DeploymentController' => [ 'base' => 'The deployment controller to use for the service. For more information, see Amazon ECS Deployment Types in the Amazon Elastic Container Service Developer Guide.
', 'refs' => [ 'CreateServiceRequest$deploymentController' => 'The deployment controller to use for the service.
', 'Service$deploymentController' => 'The deployment controller type the service is using.
', ], ], 'DeploymentControllerType' => [ 'base' => NULL, 'refs' => [ 'DeploymentController$type' => 'The deployment controller type to use.
There are two deployment controller types available:
The rolling update (ECS
) deployment type involves replacing the current running version of the container with the latest version. The number of containers Amazon ECS adds or removes from the service during a rolling update is controlled by adjusting the minimum and maximum number of healthy tasks allowed during a service deployment, as specified in the DeploymentConfiguration.
The blue/green (CODE_DEPLOY
) deployment type uses the blue/green deployment model powered by AWS CodeDeploy, which allows you to verify a new deployment of a service before sending production traffic to it. For more information, see Amazon ECS Deployment Types in the Amazon Elastic Container Service Developer Guide.
The current state of deployments for the service.
', ], ], 'DeregisterContainerInstanceRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeregisterContainerInstanceResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeregisterTaskDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeregisterTaskDefinitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeClustersRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeClustersResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeContainerInstancesRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeContainerInstancesResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeServicesRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeServicesResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTaskDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTaskDefinitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTasksRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTasksResponse' => [ 'base' => NULL, 'refs' => [], ], 'DesiredStatus' => [ 'base' => NULL, 'refs' => [ 'ListTasksRequest$desiredStatus' => 'The task desired status with which to filter the ListTasks
results. Specifying a desiredStatus
of STOPPED
limits the results to tasks that Amazon ECS has set the desired status to STOPPED
. This can be useful for debugging tasks that are not starting properly or have died or finished. The default status filter is RUNNING
, which shows tasks that Amazon ECS has set the desired status to RUNNING
.
Although you can filter results based on a desired status of PENDING
, this does not return any results. Amazon ECS never sets the desired status of a task to that value (only a task\'s lastStatus
may have a value of PENDING
).
An object representing a container instance host device.
', 'refs' => [ 'DevicesList$member' => NULL, ], ], 'DeviceCgroupPermission' => [ 'base' => NULL, 'refs' => [ 'DeviceCgroupPermissions$member' => NULL, ], ], 'DeviceCgroupPermissions' => [ 'base' => NULL, 'refs' => [ 'Device$permissions' => 'The explicit permissions to provide to the container for the device. By default, the container has permissions for read
, write
, and mknod
for the device.
Any host devices to expose to the container. This parameter maps to Devices
in the Create a container section of the Docker Remote API and the --device
option to docker run.
If you are using tasks that use the Fargate launch type, the devices
parameter is not supported.
A key/value map of labels to add to the container. This parameter maps to Labels
in the Create a container section of the Docker Remote API and the --label
option to docker run. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format \'{{.Server.APIVersion}}\'
This parameter is specified when you are using Docker volumes. Docker volumes are only supported when you are using the EC2 launch type. Windows containers only support the use of the local
driver. To use bind mounts, specify a host
instead.
This parameter is specified when you are using Docker volumes. Docker volumes are only supported when you are using the EC2 launch type. Windows containers only support the use of the local
driver. To use bind mounts, specify a host
instead.
When the doubleValue
type is set, the value of the resource must be a double precision floating-point type.
The value, specified as a percent total of a service\'s desiredCount
, to scale the task set.
The environment variables to pass to a container. This parameter maps to Env
in the Create a container section of the Docker Remote API and the --env
option to docker run.
We do not recommend using plaintext environment variables for sensitive information, such as credential data.
The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the task definition. You must also specify a container name.
', ], ], 'Failure' => [ 'base' => 'A failed resource.
', 'refs' => [ 'Failures$member' => NULL, ], ], 'Failures' => [ 'base' => NULL, 'refs' => [ 'DescribeClustersResponse$failures' => 'Any failures associated with the call.
', 'DescribeContainerInstancesResponse$failures' => 'Any failures associated with the call.
', 'DescribeServicesResponse$failures' => 'Any failures associated with the call.
', 'DescribeTasksResponse$failures' => 'Any failures associated with the call.
', 'RunTaskResponse$failures' => 'Any failures associated with the call.
', 'StartTaskResponse$failures' => 'Any failures associated with the call.
', 'UpdateContainerInstancesStateResponse$failures' => 'Any failures associated with the call.
', ], ], 'HealthCheck' => [ 'base' => 'An object representing a container health check. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image (such as those specified in a parent image or from the image\'s Dockerfile).
The following are notes about container health check support:
Container health checks require version 1.17.0 or greater of the Amazon ECS container agent. For more information, see Updating the Amazon ECS Container Agent.
Container health checks are supported for Fargate tasks if you are using platform version 1.1.0 or greater. For more information, see AWS Fargate Platform Versions.
Container health checks are not supported for tasks that are part of a service that is configured to use a Classic Load Balancer.
The health check command and associated configuration parameters for the container. This parameter maps to HealthCheck
in the Create a container section of the Docker Remote API and the HEALTHCHECK
parameter of docker run.
The health status of the container. If health checks are not configured for this container in its task definition, then it reports the health status as UNKNOWN
.
The health status for the task, which is determined by the health of the essential containers in the task. If all essential containers in the task are reporting as HEALTHY
, then the task status also reports as HEALTHY
. If any essential containers in the task are reporting as UNHEALTHY
or UNKNOWN
, then the task status also reports as UNHEALTHY
or UNKNOWN
, accordingly.
The Amazon ECS container agent does not monitor or report on Docker health checks that are embedded in a container image (such as those specified in a parent image or from the image\'s Dockerfile) and not specified in the container definition. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image.
Hostnames and IP address entries that are added to the /etc/hosts
file of a container via the extraHosts
parameter of its ContainerDefinition.
A list of hostnames and IP address mappings to append to the /etc/hosts
file on the container. This parameter maps to ExtraHosts
in the Create a container section of the Docker Remote API and the --add-host
option to docker run.
This parameter is not supported for Windows containers or tasks that use the awsvpc
network mode.
Details on a container instance bind mount host volume.
', 'refs' => [ 'Volume$host' => 'This parameter is specified when you are using bind mount host volumes. Bind mount host volumes are supported when you are using either the EC2 or Fargate launch types. The contents of the host
parameter determine whether your bind mount host volume persists on the host container instance and where it is stored. If the host
parameter is empty, then the Docker daemon assigns a host path for your data volume. However, the data is not guaranteed to persist after the containers associated with it stop running.
Windows containers can mount whole directories on the same drive as $env:ProgramData
. Windows containers cannot mount directories on a different drive, and mount point cannot be across drives. For example, you can mount C:\\my\\path:C:\\my\\path
and D:\\:D:\\
, but not D:\\my\\path:C:\\my\\path
or D:\\:C:\\my\\path
.
The number of container instances registered into the cluster. This includes container instances in both ACTIVE
and DRAINING
status.
The number of tasks in the cluster that are in the RUNNING
state.
The number of tasks in the cluster that are in the PENDING
state.
The number of services that are running on the cluster in an ACTIVE
state. You can view these services with ListServices.
The number of cpu
units reserved for the container. This parameter maps to CpuShares
in the Create a container section of the Docker Remote API and the --cpu-shares
option to docker run.
This field is optional for tasks using the Fargate launch type, and the only requirement is that the total amount of CPU reserved for all containers within a task be lower than the task-level cpu
value.
You can determine the number of CPU units that are available per EC2 instance type by multiplying the vCPUs listed for that instance type on the Amazon EC2 Instances detail page by 1,024.
For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that is the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task would be guaranteed a minimum of 512 CPU units when needed, and each container could float to higher CPU usage if the other container was not using it, but if both tasks were 100% active all of the time, they would be limited to 512 CPU units.
Linux containers share unallocated CPU units with other containers on the container instance with the same ratio as their allocated amount. For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that is the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task would be guaranteed a minimum of 512 CPU units when needed, and each container could float to higher CPU usage if the other container was not using it, but if both tasks were 100% active all of the time, they would be limited to 512 CPU units.
On Linux container instances, the Docker daemon on the container instance uses the CPU value to calculate the relative CPU share ratios for running containers. For more information, see CPU share constraint in the Docker documentation. The minimum valid CPU share value that the Linux kernel allows is 2. However, the CPU parameter is not required, and you can use CPU values below 2 in your container definitions. For CPU values below 2 (including null), the behavior varies based on your Amazon ECS container agent version:
Agent versions less than or equal to 1.1.0: Null and zero CPU values are passed to Docker as 0, which Docker then converts to 1,024 CPU shares. CPU values of 1 are passed to Docker as 1, which the Linux kernel converts to two CPU shares.
Agent versions greater than or equal to 1.2.0: Null, zero, and CPU values of 1 are passed to Docker as 2.
On Windows container instances, the CPU limit is enforced as an absolute limit, or a quota. Windows containers only have access to the specified amount of CPU that is described in the task definition.
', 'ContainerInstance$runningTasksCount' => 'The number of tasks on the container instance that are in the RUNNING
status.
The number of tasks on the container instance that are in the PENDING
status.
The most recent desired count of tasks that was specified for the service to deploy or maintain.
', 'Deployment$pendingCount' => 'The number of tasks in the deployment that are in the PENDING
status.
The number of tasks in the deployment that are in the RUNNING
status.
The maximum number of account setting results returned by ListAccountSettings
in paginated output. When this parameter is used, ListAccountSettings
only returns maxResults
results in a single page along with a nextToken
response element. The remaining results of the initial request can be seen by sending another ListAccountSettings
request with the returned nextToken
value. This value can be between 1 and 10. If this parameter is not used, then ListAccountSettings
returns up to 10 results and a nextToken
value if applicable.
When the integerValue
type is set, the value of the resource must be an integer.
The desired number of instantiations of the task definition to keep running on the service. This value is specified when the service is created with CreateService, and it can be modified with UpdateService.
', 'Service$runningCount' => 'The number of tasks in the cluster that are in the RUNNING
state.
The number of tasks in the cluster that are in the PENDING
state.
The revision of the task in a particular family. The revision is a version number of a task definition in a family. When you register a task definition for the first time, the revision is 1
. Each time that you register a new revision of a task definition in the same family, the revision value always increases by one, even if you have deregistered previous revisions in this family.
The computed desired count for the task set. This is calculated by multiplying the service\'s desiredCount
by the task set\'s scale
percentage.
The number of tasks in the task set that are in the PENDING
status during a deployment. A task in the PENDING
state is preparing to enter the RUNNING
state. A task set enters the PENDING
status when it launches for the first time, or when it is restarted after being in the STOPPED
state.
The number of tasks in the task set that are in the RUNNING
status during a deployment. A task in the RUNNING
state is running and ready for use.
The size (in MiB) of the tmpfs volume.
', 'Ulimit$softLimit' => 'The soft limit for the ulimit type.
', 'Ulimit$hardLimit' => 'The hard limit for the ulimit type.
', ], ], 'InvalidParameterException' => [ 'base' => 'The specified parameter is invalid. Review the available parameters for the API request.
', 'refs' => [], ], 'IpcMode' => [ 'base' => NULL, 'refs' => [ 'RegisterTaskDefinitionRequest$ipcMode' => 'The IPC resource namespace to use for the containers in the task. The valid values are host
, task
, or none
. If host
is specified, then all containers within the tasks that specified the host
IPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. If task
is specified, all containers within the specified task share the same IPC resources. If none
is specified, then IPC resources within the containers of a task are private and not shared with other containers in a task or on the container instance. If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance. For more information, see IPC settings in the Docker run reference.
If the host
IPC mode is used, be aware that there is a heightened risk of undesired IPC namespace expose. For more information, see Docker security.
If you are setting namespaced kernel parameters using systemControls
for the containers in the task, the following will apply to your IPC resource namespace. For more information, see System Controls in the Amazon Elastic Container Service Developer Guide.
For tasks that use the host
IPC mode, IPC namespace related systemControls
are not supported.
For tasks that use the task
IPC mode, IPC namespace related systemControls
will apply to all containers within a task.
This parameter is not supported for Windows containers or tasks using the Fargate launch type.
The IPC resource namespace to use for the containers in the task. The valid values are host
, task
, or none
. If host
is specified, then all containers within the tasks that specified the host
IPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. If task
is specified, all containers within the specified task share the same IPC resources. If none
is specified, then IPC resources within the containers of a task are private and not shared with other containers in a task or on the container instance. If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance. For more information, see IPC settings in the Docker run reference.
If the host
IPC mode is used, be aware that there is a heightened risk of undesired IPC namespace expose. For more information, see Docker security.
If you are setting namespaced kernel parameters using systemControls
for the containers in the task, the following will apply to your IPC resource namespace. For more information, see System Controls in the Amazon Elastic Container Service Developer Guide.
For tasks that use the host
IPC mode, IPC namespace related systemControls
are not supported.
For tasks that use the task
IPC mode, IPC namespace related systemControls
will apply to all containers within a task.
This parameter is not supported for Windows containers or tasks using the Fargate launch type.
The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker. For more information on the default capabilities and the non-default available capabilities, see Runtime privilege and Linux capabilities in the Docker run reference. For more detailed information on these Linux capabilities, see the capabilities(7) Linux manual page.
', 'refs' => [ 'LinuxParameters$capabilities' => 'The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker.
If you are using tasks that use the Fargate launch type, capabilities
is supported but the add
parameter is not supported.
A key-value pair object.
', 'refs' => [ 'AttachmentDetails$member' => NULL, 'EnvironmentVariables$member' => NULL, 'Statistics$member' => NULL, ], ], 'LaunchType' => [ 'base' => NULL, 'refs' => [ 'CreateServiceRequest$launchType' => 'The launch type on which to run your service. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.
', 'Deployment$launchType' => 'The launch type the tasks in the service are using. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.
', 'ListServicesRequest$launchType' => 'The launch type for the services to list.
', 'ListTasksRequest$launchType' => 'The launch type for services to list.
', 'RunTaskRequest$launchType' => 'The launch type on which to run your task. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.
', 'Service$launchType' => 'The launch type on which your service is running. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.
', 'Task$launchType' => 'The launch type on which your task is running. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.
', 'TaskSet$launchType' => 'The launch type the tasks in the task set are using. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.
', ], ], 'LinuxParameters' => [ 'base' => 'Linux-specific options that are applied to the container, such as Linux KernelCapabilities.
', 'refs' => [ 'ContainerDefinition$linuxParameters' => 'Linux-specific modifications that are applied to the container, such as Linux KernelCapabilities.
This parameter is not supported for Windows containers.
Details on a load balancer that is used with a service.
If the service is using the ECS
deployment controller, you are limited to one load balancer or target group.
If the service is using the CODE_DEPLOY
deployment controller, the service is required to use either an Application Load Balancer or Network Load Balancer. When you are creating an AWS CodeDeploy deployment group, you specify two target groups (referred to as a targetGroupPair
). Each target group binds to a separate task set in the deployment. The load balancer can also have up to two listeners, a required listener for production traffic and an optional listener that allows you to test new revisions of the service before routing production traffic to it.
Services with tasks that use the awsvpc
network mode (for example, those with the Fargate launch type) only support Application Load Balancers and Network Load Balancers. Classic Load Balancers are not supported. Also, when you create any target groups for these services, you must choose ip
as the target type, not instance
. Tasks that use the awsvpc
network mode are associated with an elastic network interface, not an Amazon EC2 instance.
A load balancer object representing the load balancer to use with your service.
If the service is using the ECS
deployment controller, you are limited to one load balancer or target group.
If the service is using the CODE_DEPLOY
deployment controller, the service is required to use either an Application Load Balancer or Network Load Balancer. When creating an AWS CodeDeploy deployment group, you specify two target groups (referred to as a targetGroupPair
). During a deployment, AWS CodeDeploy determines which task set in your service has the status PRIMARY
and associates one target group with it, and then associates the other target group with the replacement task set. The load balancer can also have up to two listeners: a required listener for production traffic and an optional listener that allows you perform validation tests with Lambda functions before routing production traffic to it.
After you create a service using the ECS
deployment controller, the load balancer name or target group ARN, container name, and container port specified in the service definition are immutable. If you are using the CODE_DEPLOY
deployment controller, these values can be changed when updating the service.
For Classic Load Balancers, this object must contain the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer. When a task from this service is placed on a container instance, the container instance is registered with the load balancer specified here.
For Application Load Balancers and Network Load Balancers, this object must contain the load balancer target group ARN, the container name (as it appears in a container definition), and the container port to access from the load balancer. When a task from this service is placed on a container instance, the container instance and port combination is registered as a target in the target group specified here.
Services with tasks that use the awsvpc
network mode (for example, those with the Fargate launch type) only support Application Load Balancers and Network Load Balancers. Classic Load Balancers are not supported. Also, when you create any target groups for these services, you must choose ip
as the target type, not instance
, because tasks that use the awsvpc
network mode are associated with an elastic network interface, not an Amazon EC2 instance.
A list of Elastic Load Balancing load balancer objects, containing the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer.
Services with tasks that use the awsvpc
network mode (for example, those with the Fargate launch type) only support Application Load Balancers and Network Load Balancers. Classic Load Balancers are not supported. Also, when you create any target groups for these services, you must choose ip
as the target type, not instance
. Tasks that use the awsvpc
network mode are associated with an elastic network interface, not an Amazon EC2 instance.
Details on a load balancer that is used with a task set.
', ], ], 'LogConfiguration' => [ 'base' => 'Log configuration options to send to a custom log driver for the container.
', 'refs' => [ 'ContainerDefinition$logConfiguration' => 'The log configuration specification for the container.
If you are using the Fargate launch type, the only supported value is awslogs
.
This parameter maps to LogConfig
in the Create a container section of the Docker Remote API and the --log-driver
option to docker run. By default, containers use the same logging driver that the Docker daemon uses. However the container may use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance (or on a different log server for remote logging options). For more information on the options for different supported log drivers, see Configure logging drivers in the Docker documentation.
Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type). Additional log drivers may be available in future releases of the Amazon ECS container agent.
This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format \'{{.Server.APIVersion}}\'
The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the ECS_AVAILABLE_LOGGING_DRIVERS
environment variable before containers placed on that instance can use these log configuration options. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide.
The configuration options to send to the log driver. This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format \'{{.Server.APIVersion}}\'
The log driver to use for the container. The valid values listed for this parameter are log drivers that the Amazon ECS container agent can communicate with by default. If you are using the Fargate launch type, the only supported value is awslogs
. For more information about using the awslogs
driver, see Using the awslogs Log Driver in the Amazon Elastic Container Service Developer Guide.
If you have a custom driver that is not listed above that you would like to work with the Amazon ECS container agent, you can fork the Amazon ECS container agent project that is available on GitHub and customize it to work with that driver. We encourage you to submit pull requests for changes that you would like to have included. However, Amazon Web Services does not currently support running modified copies of this software.
This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format \'{{.Server.APIVersion}}\'
The version counter for the container instance. Every time a container instance experiences a change that triggers a CloudWatch event, the version counter is incremented. If you are replicating your Amazon ECS container instance state with CloudWatch Events, you can compare the version of a container instance reported by the Amazon ECS APIs with the version reported in CloudWatch Events for the container instance (inside the detail
object) to verify that the version in your event stream is current.
When the longValue
type is set, the value of the resource must be an extended precision floating-point type.
The version counter for the task. Every time a task experiences a change that triggers a CloudWatch event, the version counter is incremented. If you are replicating your Amazon ECS task state with CloudWatch Events, you can compare the version of a task reported by the Amazon ECS API actionss with the version reported in CloudWatch Events for the task (inside the detail
object) to verify that the version in your event stream is current.
Amazon ECS is unable to determine the current version of the Amazon ECS container agent on the container instance and does not have enough information to proceed with an update. This could be because the agent running on the container instance is an older or custom version that does not use our version information.
', 'refs' => [], ], 'MountPoint' => [ 'base' => 'Details on a volume mount point that is used in a container definition.
', 'refs' => [ 'MountPointList$member' => NULL, ], ], 'MountPointList' => [ 'base' => NULL, 'refs' => [ 'ContainerDefinition$mountPoints' => 'The mount points for data volumes in your container.
This parameter maps to Volumes
in the Create a container section of the Docker Remote API and the --volume
option to docker run.
Windows containers can mount whole directories on the same drive as $env:ProgramData
. Windows containers cannot mount directories on a different drive, and mount point cannot be across drives.
Details on the network bindings between a container and its host container instance. After a task reaches the RUNNING
status, manual and automatic host and container port assignments are visible in the networkBindings
section of DescribeTasks API responses.
The network bindings associated with the container.
', 'ContainerStateChange$networkBindings' => 'Any network bindings associated with the container.
', 'SubmitContainerStateChangeRequest$networkBindings' => 'The network bindings of the container.
', ], ], 'NetworkConfiguration' => [ 'base' => 'An object representing the network configuration for a task or service.
', 'refs' => [ 'CreateServiceRequest$networkConfiguration' => 'The network configuration for the service. This parameter is required for task definitions that use the awsvpc
network mode to receive their own elastic network interface, and it is not supported for other network modes. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide.
The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the awsvpc
networking mode.
The network configuration for the task. This parameter is required for task definitions that use the awsvpc
network mode to receive their own elastic network interface, and it is not supported for other network modes. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide.
The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the awsvpc
networking mode.
The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the awsvpc
networking mode.
The network configuration for the task set.
', 'UpdateServiceRequest$networkConfiguration' => 'The network configuration for the service. This parameter is required for task definitions that use the awsvpc
network mode to receive their own elastic network interface, and it is not supported for other network modes. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide.
Updating a service to add a subnet to a list of existing subnets does not trigger a service deployment. For example, if your network configuration change is to keep the existing subnets and simply add another subnet to the network configuration, this does not trigger a new service deployment.
An object representing the elastic network interface for tasks that use the awsvpc
network mode.
The network interfaces associated with the container.
', ], ], 'NetworkMode' => [ 'base' => NULL, 'refs' => [ 'RegisterTaskDefinitionRequest$networkMode' => 'The Docker networking mode to use for the containers in the task. The valid values are none
, bridge
, awsvpc
, and host
. The default Docker network mode is bridge
. If you are using the Fargate launch type, the awsvpc
network mode is required. If you are using the EC2 launch type, any network mode can be used. If the network mode is set to none
, you cannot specify port mappings in your container definitions, and the tasks containers do not have external connectivity. The host
and awsvpc
network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by the bridge
mode.
With the host
and awsvpc
network modes, exposed container ports are mapped directly to the corresponding host port (for the host
network mode) or the attached elastic network interface port (for the awsvpc
network mode), so you cannot take advantage of dynamic host port mappings.
If the network mode is awsvpc
, the task is allocated an elastic network interface, and you must specify a NetworkConfiguration value when you create a service or run a task with the task definition. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide.
Currently, only Amazon ECS-optimized AMIs, other Amazon Linux variants with the ecs-init
package, or AWS Fargate infrastructure support the awsvpc
network mode.
If the network mode is host
, you cannot run multiple instantiations of the same task on a single container instance when port mappings are used.
Docker for Windows uses different network modes than Docker for Linux. When you register a task definition with Windows containers, you must not specify a network mode. If you use the console to register a task definition with Windows containers, you must choose the <default>
network mode object.
For more information, see Network settings in the Docker run reference.
', 'TaskDefinition$networkMode' => 'The Docker networking mode to use for the containers in the task. The valid values are none
, bridge
, awsvpc
, and host
. The default Docker network mode is bridge
. If you are using the Fargate launch type, the awsvpc
network mode is required. If you are using the EC2 launch type, any network mode can be used. If the network mode is set to none
, you cannot specify port mappings in your container definitions, and the tasks containers do not have external connectivity. The host
and awsvpc
network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by the bridge
mode.
With the host
and awsvpc
network modes, exposed container ports are mapped directly to the corresponding host port (for the host
network mode) or the attached elastic network interface port (for the awsvpc
network mode), so you cannot take advantage of dynamic host port mappings.
If the network mode is awsvpc
, the task is allocated an elastic network interface, and you must specify a NetworkConfiguration value when you create a service or run a task with the task definition. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide.
Currently, only Amazon ECS-optimized AMIs, other Amazon Linux variants with the ecs-init
package, or AWS Fargate infrastructure support the awsvpc
network mode.
If the network mode is host
, you cannot run multiple instantiations of the same task on a single container instance when port mappings are used.
Docker for Windows uses different network modes than Docker for Linux. When you register a task definition with Windows containers, you must not specify a network mode. If you use the console to register a task definition with Windows containers, you must choose the <default>
network mode object.
For more information, see Network settings in the Docker run reference.
', ], ], 'NoUpdateAvailableException' => [ 'base' => 'There is no update available for this Amazon ECS container agent. This could be because the agent is already running the latest version, or it is so old that there is no update path to the current version.
', 'refs' => [], ], 'PidMode' => [ 'base' => NULL, 'refs' => [ 'RegisterTaskDefinitionRequest$pidMode' => 'The process namespace to use for the containers in the task. The valid values are host
or task
. If host
is specified, then all containers within the tasks that specified the host
PID mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. If task
is specified, all containers within the specified task share the same process namespace. If no value is specified, the default is a private namespace. For more information, see PID settings in the Docker run reference.
If the host
PID mode is used, be aware that there is a heightened risk of undesired process namespace expose. For more information, see Docker security.
This parameter is not supported for Windows containers or tasks using the Fargate launch type.
The process namespace to use for the containers in the task. The valid values are host
or task
. If host
is specified, then all containers within the tasks that specified the host
PID mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. If task
is specified, all containers within the specified task share the same process namespace. If no value is specified, the default is a private namespace. For more information, see PID settings in the Docker run reference.
If the host
PID mode is used, be aware that there is a heightened risk of undesired process namespace expose. For more information, see Docker security.
This parameter is not supported for Windows containers or tasks using the Fargate launch type.
An object representing a constraint on task placement. For more information, see Task Placement Constraints in the Amazon Elastic Container Service Developer Guide.
', 'refs' => [ 'PlacementConstraints$member' => NULL, ], ], 'PlacementConstraintType' => [ 'base' => NULL, 'refs' => [ 'PlacementConstraint$type' => 'The type of constraint. Use distinctInstance
to ensure that each task in a particular group is running on a different container instance. Use memberOf
to restrict the selection to a group of valid candidates. The value distinctInstance
is not supported in task definitions.
An array of placement constraint objects to use for tasks in your service. You can specify a maximum of 10 constraints per task (this limit includes constraints in the task definition and those specified at runtime).
', 'RunTaskRequest$placementConstraints' => 'An array of placement constraint objects to use for the task. You can specify up to 10 constraints per task (including constraints in the task definition and those specified at runtime).
', 'Service$placementConstraints' => 'The placement constraints for the tasks in the service.
', ], ], 'PlacementStrategies' => [ 'base' => NULL, 'refs' => [ 'CreateServiceRequest$placementStrategy' => 'The placement strategy objects to use for tasks in your service. You can specify a maximum of five strategy rules per service.
', 'RunTaskRequest$placementStrategy' => 'The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task.
', 'Service$placementStrategy' => 'The placement strategy that determines how tasks for the service are placed.
', ], ], 'PlacementStrategy' => [ 'base' => 'The task placement strategy for a task or service. For more information, see Task Placement Strategies in the Amazon Elastic Container Service Developer Guide.
', 'refs' => [ 'PlacementStrategies$member' => NULL, ], ], 'PlacementStrategyType' => [ 'base' => NULL, 'refs' => [ 'PlacementStrategy$type' => 'The type of placement strategy. The random
placement strategy randomly places tasks on available candidates. The spread
placement strategy spreads placement across available candidates evenly based on the field
parameter. The binpack
strategy places tasks on available candidates that have the least available amount of the resource that is specified with the field
parameter. For example, if you binpack on memory, a task is placed on the instance with the least amount of remaining memory (but still enough to run the task).
The specified platform version does not satisfy the task definition\'s required capabilities.
', 'refs' => [], ], 'PlatformUnknownException' => [ 'base' => 'The specified platform version does not exist.
', 'refs' => [], ], 'PortMapping' => [ 'base' => 'Port mappings allow containers to access ports on the host container instance to send or receive traffic. Port mappings are specified as part of the container definition.
If you are using containers in a task with the awsvpc
or host
network mode, exposed ports should be specified using containerPort
. The hostPort
can be left blank or it must be the same value as the containerPort
.
After a task reaches the RUNNING
status, manual and automatic host and container port assignments are visible in the networkBindings
section of DescribeTasks API responses.
The list of port mappings for the container. Port mappings allow containers to access ports on the host container instance to send or receive traffic.
For task definitions that use the awsvpc
network mode, you should only specify the containerPort
. The hostPort
can be left blank or it must be the same value as the containerPort
.
Port mappings on Windows use the NetNAT
gateway address rather than localhost
. There is no loopback for port mappings on Windows, so you cannot access a container\'s mapped port from the host itself.
This parameter maps to PortBindings
in the Create a container section of the Docker Remote API and the --publish
option to docker run. If the network mode of a task definition is set to none
, then you can\'t specify port mappings. If the network mode of a task definition is set to host
, then host ports must either be undefined or they must match the container port in the port mapping.
After a task reaches the RUNNING
status, manual and automatic host and container port assignments are visible in the Network Bindings section of a container description for a selected task in the Amazon ECS console. The assignments are also visible in the networkBindings
section DescribeTasks responses.
Specifies whether to propagate the tags from the task definition or the service to the tasks. If no value is specified, the tags are not propagated. Tags can only be propagated to the tasks within the service during service creation. To add tags to a task after service creation, use the TagResource API action.
', 'RunTaskRequest$propagateTags' => 'Specifies whether to propagate the tags from the task definition or the service to the task. If no value is specified, the tags are not propagated.
', 'Service$propagateTags' => 'Specifies whether to propagate the tags from the task definition or the service to the task. If no value is specified, the tags are not propagated.
', 'StartTaskRequest$propagateTags' => 'Specifies whether to propagate the tags from the task definition or the service to the task. If no value is specified, the tags are not propagated.
', ], ], 'PutAccountSettingRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutAccountSettingResponse' => [ 'base' => NULL, 'refs' => [], ], 'PutAttributesRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutAttributesResponse' => [ 'base' => NULL, 'refs' => [], ], 'RegisterContainerInstanceRequest' => [ 'base' => NULL, 'refs' => [], ], 'RegisterContainerInstanceResponse' => [ 'base' => NULL, 'refs' => [], ], 'RegisterTaskDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'RegisterTaskDefinitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'RepositoryCredentials' => [ 'base' => 'The repository credentials for private registry authentication.
', 'refs' => [ 'ContainerDefinition$repositoryCredentials' => 'The private repository authentication credentials to use.
', ], ], 'RequiresAttributes' => [ 'base' => NULL, 'refs' => [ 'TaskDefinition$requiresAttributes' => 'The container instance attributes required by your task. This field is not valid if you are using the Fargate launch type for your task.
', ], ], 'Resource' => [ 'base' => 'Describes the resources available for a container instance.
', 'refs' => [ 'Resources$member' => NULL, ], ], 'ResourceNotFoundException' => [ 'base' => 'The specified resource could not be found.
', 'refs' => [], ], 'Resources' => [ 'base' => NULL, 'refs' => [ 'ContainerInstance$remainingResources' => 'For CPU and memory resource types, this parameter describes the remaining CPU and memory that has not already been allocated to tasks and is therefore available for new tasks. For port resource types, this parameter describes the ports that were reserved by the Amazon ECS container agent (at instance registration time) and any task containers that have reserved port mappings on the host (with the host
or bridge
network mode). Any port that is not specified here is available for new tasks.
For CPU and memory resource types, this parameter describes the amount of each resource that was available on the container instance when the container agent registered it with Amazon ECS. This value represents the total amount of CPU and memory that can be allocated on this container instance to tasks. For port resource types, this parameter describes the ports that were reserved by the Amazon ECS container agent when it registered the container instance with Amazon ECS.
', 'RegisterContainerInstanceRequest$totalResources' => 'The resources available on the instance.
', ], ], 'RunTaskRequest' => [ 'base' => NULL, 'refs' => [], ], 'RunTaskResponse' => [ 'base' => NULL, 'refs' => [], ], 'Scale' => [ 'base' => 'A floating-point percentage of the desired number of tasks to place and keep running in the service. This is used when a service uses the CODE_DEPLOY
deployment controller type.
A floating-point percentage of the desired number of tasks to place and keep running in the service.
', ], ], 'ScaleUnit' => [ 'base' => NULL, 'refs' => [ 'Scale$unit' => 'The unit of measure for the scale value.
', ], ], 'SchedulingStrategy' => [ 'base' => NULL, 'refs' => [ 'CreateServiceRequest$schedulingStrategy' => 'The scheduling strategy to use for the service. For more information, see Services.
There are two service scheduler strategies available:
REPLICA
-The replica scheduling strategy places and maintains the desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions. This scheduler strategy is required if using the CODE_DEPLOY
deployment controller.
DAEMON
-The daemon scheduling strategy deploys exactly one task on each active container instance that meets all of the task placement constraints that you specify in your cluster. When you are using this strategy, there is no need to specify a desired number of tasks, a task placement strategy, or use Service Auto Scaling policies.
Tasks using the Fargate launch type or the CODE_DEPLOY
deploymenet controller do not support the DAEMON
scheduling strategy.
The scheduling strategy for services to list.
', 'Service$schedulingStrategy' => 'The scheduling strategy to use for the service. For more information, see Services.
There are two service scheduler strategies available:
REPLICA
-The replica scheduling strategy places and maintains the desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions.
DAEMON
-The daemon scheduling strategy deploys exactly one task on each container instance in your cluster. When you are using this strategy, do not specify a desired number of tasks or any task placement strategies.
Fargate tasks do not support the DAEMON
scheduling strategy.
The scope for the Docker volume that determines its lifecycle. Docker volumes that are scoped to a task
are automatically provisioned when the task starts and destroyed when the task stops. Docker volumes that are scoped as shared
persist after the task stops.
An object representing the secret to expose to your container.
', 'refs' => [ 'SecretList$member' => NULL, ], ], 'SecretList' => [ 'base' => NULL, 'refs' => [ 'ContainerDefinition$secrets' => 'The secrets to pass to the container.
', ], ], 'ServerException' => [ 'base' => 'These errors are usually caused by a server issue.
', 'refs' => [], ], 'Service' => [ 'base' => 'Details on a service within a cluster
', 'refs' => [ 'CreateServiceResponse$service' => 'The full description of your service following the create call.
If a service is using the ECS
deployment controller, the deploymentController
and taskSets
parameters will not be returned.
If the service is using the CODE_DEPLOY
deployment controller, the deploymentController
, taskSets
and deployments
parameters will be returned, however the deployments
parameter will be an empty list.
The full description of the deleted service.
', 'Services$member' => NULL, 'UpdateServiceResponse$service' => 'The full description of your service following the update call.
', ], ], 'ServiceEvent' => [ 'base' => 'Details on an event associated with a service.
', 'refs' => [ 'ServiceEvents$member' => NULL, ], ], 'ServiceEvents' => [ 'base' => NULL, 'refs' => [ 'Service$events' => 'The event stream for your service. A maximum of 100 of the latest events are displayed.
', ], ], 'ServiceField' => [ 'base' => NULL, 'refs' => [ 'ServiceFieldList$member' => NULL, ], ], 'ServiceFieldList' => [ 'base' => NULL, 'refs' => [ 'DescribeServicesRequest$include' => 'Specifies whether you want to see the resource tags for the service. If TAGS
is specified, the tags are included in the response. If this field is omitted, tags are not included in the response.
The specified service is not active. You can\'t update a service that is inactive. If you have previously deleted a service, you can re-create it with CreateService.
', 'refs' => [], ], 'ServiceNotFoundException' => [ 'base' => 'The specified service could not be found. You can view your available services with ListServices. Amazon ECS services are cluster-specific and Region-specific.
', 'refs' => [], ], 'ServiceRegistries' => [ 'base' => NULL, 'refs' => [ 'CreateServiceRequest$serviceRegistries' => 'The details of the service discovery registries to assign to this service. For more information, see Service Discovery.
Service discovery is supported for Fargate tasks if you are using platform version v1.1.0 or later. For more information, see AWS Fargate Platform Versions.
Details of the service registry.
', 'refs' => [ 'ServiceRegistries$member' => NULL, ], ], 'Services' => [ 'base' => NULL, 'refs' => [ 'DescribeServicesResponse$services' => 'The list of services described.
', ], ], 'Setting' => [ 'base' => 'The current account setting for a resource.
', 'refs' => [ 'DeleteAccountSettingResponse$setting' => 'The account setting for the specified principal ARN.
', 'PutAccountSettingResponse$setting' => 'The current account setting for a resource.
', 'Settings$member' => NULL, ], ], 'SettingName' => [ 'base' => NULL, 'refs' => [ 'DeleteAccountSettingRequest$name' => 'The resource name for which to disable the new format. If serviceLongArnFormat
is specified, the ARN for your Amazon ECS services is affected. If taskLongArnFormat
is specified, the ARN and resource ID for your Amazon ECS tasks is affected. If containerInstanceLongArnFormat
is specified, the ARN and resource ID for your Amazon ECS container instances is affected.
The resource name you want to list the account settings for.
', 'PutAccountSettingRequest$name' => 'The resource name for which to enable the new format. If serviceLongArnFormat
is specified, the ARN for your Amazon ECS services is affected. If taskLongArnFormat
is specified, the ARN and resource ID for your Amazon ECS tasks is affected. If containerInstanceLongArnFormat
is specified, the ARN and resource ID for your Amazon ECS container instances is affected.
The account resource name.
', ], ], 'Settings' => [ 'base' => NULL, 'refs' => [ 'ListAccountSettingsResponse$settings' => 'The account settings for the resource.
', ], ], 'SortOrder' => [ 'base' => NULL, 'refs' => [ 'ListTaskDefinitionsRequest$sort' => 'The order in which to sort the results. Valid values are ASC
and DESC
. By default (ASC
), task definitions are listed lexicographically by family name and in ascending numerical order by revision so that the newest task definitions in a family are listed last. Setting this parameter to DESC
reverses the sort order on family name and revision so that the newest task definitions in a family are listed first.
The stability status, which indicates whether the task set has reached a steady state. If the following conditions are met, the task set will be in STEADY_STATE
:
The task runningCount
is equal to the computedDesiredCount
.
The pendingCount
is 0
.
There are no tasks running on container instances in the DRAINING
status.
All tasks are reporting a healthy status from the load balancers, service discovery, and container health checks.
If any of those conditions are not met, the stability status returns STABILIZING
.
Additional information about your clusters that are separated by launch type, including:
runningEC2TasksCount
RunningFargateTasksCount
pendingEC2TasksCount
pendingFargateTasksCount
activeEC2ServiceCount
activeFargateServiceCount
drainingEC2ServiceCount
drainingFargateServiceCount
The unique identifier for the attachment.
', 'Attachment$type' => 'The type of the attachment, such as ElasticNetworkInterface
.
The status of the attachment. Valid values are PRECREATED
, CREATED
, ATTACHING
, ATTACHED
, DETACHING
, DETACHED
, and DELETED
.
The Amazon Resource Name (ARN) of the attachment.
', 'AttachmentStateChange$status' => 'The status of the attachment.
', 'Attribute$name' => 'The name of the attribute. Up to 128 letters (uppercase and lowercase), numbers, hyphens, underscores, and periods are allowed.
', 'Attribute$value' => 'The value of the attribute. Up to 128 letters (uppercase and lowercase), numbers, hyphens, underscores, periods, at signs (@), forward slashes, colons, and spaces are allowed.
', 'Attribute$targetId' => 'The ID of the target. You can specify the short form ID for a resource or the full Amazon Resource Name (ARN).
', 'ClientException$message' => NULL, 'Cluster$clusterArn' => 'The Amazon Resource Name (ARN) that identifies the cluster. The ARN contains the arn:aws:ecs
namespace, followed by the Region of the cluster, the AWS account ID of the cluster owner, the cluster
namespace, and then the cluster name. For example, arn:aws:ecs:region:012345678910:cluster/test
..
A user-generated string that you use to identify your cluster.
', 'Cluster$status' => 'The status of the cluster. The valid values are ACTIVE
or INACTIVE
. ACTIVE
indicates that you can register container instances with the cluster and the associated instances can accept tasks.
The Amazon Resource Name (ARN) of the container.
', 'Container$taskArn' => 'The ARN of the task.
', 'Container$name' => 'The name of the container.
', 'Container$lastStatus' => 'The last known status of the container.
', 'Container$reason' => 'A short (255 max characters) human-readable string to provide additional details about a running or stopped container.
', 'ContainerDefinition$name' => 'The name of a container. If you are linking multiple containers together in a task definition, the name
of one container can be entered in the links
of another container to connect the containers. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. This parameter maps to name
in the Create a container section of the Docker Remote API and the --name
option to docker run.
The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with either repository-url/image:tag
or repository-url/image@digest
. Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to Image
in the Create a container section of the Docker Remote API and the IMAGE
parameter of docker run.
When a new task starts, the Amazon ECS container agent pulls the latest version of the specified image and tag for the container to use. However, subsequent updates to a repository image are not propagated to already running tasks.
Images in Amazon ECR repositories can be specified by either using the full registry/repository:tag
or registry/repository@digest
. For example, 012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>:latest
or 012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>@sha256:94afd1f2e64d908bc90dbca0035a5b567EXAMPLE
.
Images in official repositories on Docker Hub use a single name (for example, ubuntu
or mongo
).
Images in other repositories on Docker Hub are qualified with an organization name (for example, amazon/amazon-ecs-agent
).
Images in other online repositories are qualified further by a domain name (for example, quay.io/assemblyline/ubuntu
).
The hostname to use for your container. This parameter maps to Hostname
in the Create a container section of the Docker Remote API and the --hostname
option to docker run.
The hostname
parameter is not supported if you are using the awsvpc
network mode.
The user name to use inside the container. This parameter maps to User
in the Create a container section of the Docker Remote API and the --user
option to docker run.
This parameter is not supported for Windows containers.
The working directory in which to run commands inside the container. This parameter maps to WorkingDir
in the Create a container section of the Docker Remote API and the --workdir
option to docker run.
The Amazon Resource Name (ARN) of the container instance. The ARN contains the arn:aws:ecs
namespace, followed by the Region of the container instance, the AWS account ID of the container instance owner, the container-instance
namespace, and then the container instance ID. For example, arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID
.
The EC2 instance ID of the container instance.
', 'ContainerInstance$status' => 'The status of the container instance. The valid values are ACTIVE
, INACTIVE
, or DRAINING
. ACTIVE
indicates that the container instance can accept tasks. DRAINING
indicates that new tasks are not placed on the container instance and any service tasks running on the container instance are removed if possible. For more information, see Container Instance Draining in the Amazon Elastic Container Service Developer Guide.
The name of the container that receives the override. This parameter is required if any override is specified.
', 'ContainerStateChange$containerName' => 'The name of the container.
', 'ContainerStateChange$reason' => 'The reason for the state change.
', 'ContainerStateChange$status' => 'The status of the container.
', 'CreateClusterRequest$clusterName' => 'The name of your cluster. If you do not specify a name for your cluster, you create a cluster named default
. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.
The short name or full Amazon Resource Name (ARN) of the cluster on which to run your service. If you do not specify a cluster, the default cluster is assumed.
', 'CreateServiceRequest$serviceName' => 'The name of your service. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. Service names must be unique within a cluster, but you can have similarly named services in multiple clusters within a Region or across multiple Regions.
', 'CreateServiceRequest$taskDefinition' => 'The family
and revision
(family:revision
) or full ARN of the task definition to run in your service. If a revision
is not specified, the latest ACTIVE
revision is used.
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 32 ASCII characters are allowed.
', 'CreateServiceRequest$platformVersion' => 'The platform version on which your tasks in the service are running. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the LATEST
platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.
The name or full Amazon Resource Name (ARN) of the IAM role that allows Amazon ECS to make calls to your load balancer on your behalf. This parameter is only permitted if you are using a load balancer with your service and your task definition does not use the awsvpc
network mode. If you specify the role
parameter, you must also specify a load balancer object with the loadBalancers
parameter.
If your account has already created the Amazon ECS service-linked role, that role is used by default for your service unless you specify a role here. The service-linked role is required if your task definition uses the awsvpc
network mode, in which case you should not specify a role here. For more information, see Using Service-Linked Roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.
If your specified role has a path other than /
, then you must either specify the full role ARN (this is recommended) or prefix the role name with the path. For example, if a role with the name bar
has a path of /foo/
then you would specify /foo/bar
as the role name. For more information, see Friendly Names and Paths in the IAM User Guide.
The ARN of the principal, which can be an IAM user, IAM role, or the root user. If you specify the root user, it modifies the ARN and resource ID format for all IAM users, IAM roles, and the root user of the account unless an IAM user or role explicitly overrides these settings for themselves. If this field is omitted, the setting are changed only for the authenticated user.
', 'DeleteAttributesRequest$cluster' => 'The short name or full Amazon Resource Name (ARN) of the cluster that contains the resource to delete attributes. If you do not specify a cluster, the default cluster is assumed.
', 'DeleteClusterRequest$cluster' => 'The short name or full Amazon Resource Name (ARN) of the cluster to delete.
', 'DeleteServiceRequest$cluster' => 'The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to delete. If you do not specify a cluster, the default cluster is assumed.
', 'DeleteServiceRequest$service' => 'The name of the service to delete.
', 'Deployment$id' => 'The ID of the deployment.
', 'Deployment$status' => 'The status of the deployment. The following describes each state:
The most recent deployment of a service.
A service deployment that still has running tasks, but are in the process of being replaced with a new PRIMARY
deployment.
A deployment that has been completely replaced.
The most recent task definition that was specified for the tasks in the service to use.
', 'Deployment$platformVersion' => 'The platform version on which your tasks in the service are running. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the LATEST
platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instance to deregister. If you do not specify a cluster, the default cluster is assumed.
', 'DeregisterContainerInstanceRequest$containerInstance' => 'The container instance ID or full ARN of the container instance to deregister. The ARN contains the arn:aws:ecs
namespace, followed by the Region of the container instance, the AWS account ID of the container instance owner, the container-instance
namespace, and then the container instance ID. For example, arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID
.
The family
and revision
(family:revision
) or full Amazon Resource Name (ARN) of the task definition to deregister. You must specify a revision
.
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to describe. If you do not specify a cluster, the default cluster is assumed.
', 'DescribeServicesRequest$cluster' => 'The short name or full Amazon Resource Name (ARN)the cluster that hosts the service to describe. If you do not specify a cluster, the default cluster is assumed.
', 'DescribeTaskDefinitionRequest$taskDefinition' => 'The family
for the latest ACTIVE
revision, family
and revision
(family:revision
) for a specific revision in the family, or full Amazon Resource Name (ARN) of the task definition to describe.
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task to describe. If you do not specify a cluster, the default cluster is assumed.
', 'Device$hostPath' => 'The path for the device on the host container instance.
', 'Device$containerPath' => 'The path inside the container at which to expose the host device.
', 'DiscoverPollEndpointRequest$containerInstance' => 'The container instance ID or full ARN of the container instance. The ARN contains the arn:aws:ecs
namespace, followed by the Region of the container instance, the AWS account ID of the container instance owner, the container-instance
namespace, and then the container instance ID. For example, arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID
.
The short name or full Amazon Resource Name (ARN) of the cluster to which the container instance belongs.
', 'DiscoverPollEndpointResponse$endpoint' => 'The endpoint for the Amazon ECS agent to poll.
', 'DiscoverPollEndpointResponse$telemetryEndpoint' => 'The telemetry endpoint for the Amazon ECS agent.
', 'DockerLabelsMap$key' => NULL, 'DockerLabelsMap$value' => NULL, 'DockerVolumeConfiguration$driver' => 'The Docker volume driver to use. The driver value must match the driver name provided by Docker because it is used for task placement. If the driver was installed using the Docker plugin CLI, use docker plugin ls
to retrieve the driver name from your container instance. If the driver was installed using another method, use Docker plugin discovery to retrieve the driver name. For more information, see Docker plugin discovery. This parameter maps to Driver
in the Create a volume section of the Docker Remote API and the xxdriver
option to docker volume create
.
The Amazon Resource Name (ARN) of the failed resource.
', 'Failure$reason' => 'The reason for the failure.
', 'HostEntry$hostname' => 'The hostname to use in the /etc/hosts
entry.
The IP address to use in the /etc/hosts
entry.
When the host
parameter is used, specify a sourcePath
to declare the path on the host container instance that is presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you. If the host
parameter contains a sourcePath
file location, then the data volume persists at the specified location on the host container instance until you delete it manually. If the sourcePath
value does not exist on the host container instance, the Docker daemon creates it. If the location does exist, the contents of the source path folder are exported.
If you are using the Fargate launch type, the sourcePath
parameter is not supported.
The name of the key-value pair. For environment variables, this is the name of the environment variable.
', 'KeyValuePair$value' => 'The value of the key-value pair. For environment variables, this is the value of the environment variable.
', 'ListAccountSettingsRequest$value' => 'The value of the account settings with which to filter results. You must also specify an account setting name to use this parameter.
', 'ListAccountSettingsRequest$principalArn' => 'The ARN of the principal, which can be an IAM user, IAM role, or the root user. If this field is omitted, the account settings are listed only for the authenticated user.
', 'ListAccountSettingsRequest$nextToken' => 'The nextToken
value returned from a previous paginated ListAccountSettings
request where maxResults
was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken
value.
This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
The nextToken
value to include in a future ListAccountSettings
request. When the results of a ListAccountSettings
request exceed maxResults
, this value can be used to retrieve the next page of results. This value is null
when there are no more results to return.
The short name or full Amazon Resource Name (ARN) of the cluster to list attributes. If you do not specify a cluster, the default cluster is assumed.
', 'ListAttributesRequest$attributeName' => 'The name of the attribute with which to filter the results.
', 'ListAttributesRequest$attributeValue' => 'The value of the attribute with which to filter results. You must also specify an attribute name to use this parameter.
', 'ListAttributesRequest$nextToken' => 'The nextToken
value returned from a previous paginated ListAttributes
request where maxResults
was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken
value.
This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
The nextToken
value to include in a future ListAttributes
request. When the results of a ListAttributes
request exceed maxResults
, this value can be used to retrieve the next page of results. This value is null
when there are no more results to return.
The nextToken
value returned from a previous paginated ListClusters
request where maxResults
was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken
value.
This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
The nextToken
value to include in a future ListClusters
request. When the results of a ListClusters
request exceed maxResults
, this value can be used to retrieve the next page of results. This value is null
when there are no more results to return.
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to list. If you do not specify a cluster, the default cluster is assumed.
', 'ListContainerInstancesRequest$filter' => 'You can filter the results of a ListContainerInstances
operation with cluster query language statements. For more information, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide.
The nextToken
value returned from a previous paginated ListContainerInstances
request where maxResults
was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken
value.
This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
The nextToken
value to include in a future ListContainerInstances
request. When the results of a ListContainerInstances
request exceed maxResults
, this value can be used to retrieve the next page of results. This value is null
when there are no more results to return.
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the services to list. If you do not specify a cluster, the default cluster is assumed.
', 'ListServicesRequest$nextToken' => 'The nextToken
value returned from a previous paginated ListServices
request where maxResults
was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken
value.
This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
The nextToken
value to include in a future ListServices
request. When the results of a ListServices
request exceed maxResults
, this value can be used to retrieve the next page of results. This value is null
when there are no more results to return.
The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, the supported resources are Amazon ECS tasks, services, task definitions, clusters, and container instances.
', 'ListTaskDefinitionFamiliesRequest$familyPrefix' => 'The familyPrefix
is a string that is used to filter the results of ListTaskDefinitionFamilies
. If you specify a familyPrefix
, only task definition family names that begin with the familyPrefix
string are returned.
The nextToken
value returned from a previous paginated ListTaskDefinitionFamilies
request where maxResults
was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken
value.
This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
The nextToken
value to include in a future ListTaskDefinitionFamilies
request. When the results of a ListTaskDefinitionFamilies
request exceed maxResults
, this value can be used to retrieve the next page of results. This value is null
when there are no more results to return.
The full family name with which to filter the ListTaskDefinitions
results. Specifying a familyPrefix
limits the listed task definitions to task definition revisions that belong to that family.
The nextToken
value returned from a previous paginated ListTaskDefinitions
request where maxResults
was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken
value.
This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
The nextToken
value to include in a future ListTaskDefinitions
request. When the results of a ListTaskDefinitions
request exceed maxResults
, this value can be used to retrieve the next page of results. This value is null
when there are no more results to return.
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the tasks to list. If you do not specify a cluster, the default cluster is assumed.
', 'ListTasksRequest$containerInstance' => 'The container instance ID or full ARN of the container instance with which to filter the ListTasks
results. Specifying a containerInstance
limits the results to tasks that belong to that container instance.
The name of the family with which to filter the ListTasks
results. Specifying a family
limits the results to tasks that belong to that family.
The nextToken
value returned from a previous paginated ListTasks
request where maxResults
was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken
value.
This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
The startedBy
value with which to filter the task results. Specifying a startedBy
value limits the results to tasks that were started with that value.
The name of the service with which to filter the ListTasks
results. Specifying a serviceName
limits the results to tasks that belong to that service.
The nextToken
value to include in a future ListTasks
request. When the results of a ListTasks
request exceed maxResults
, this value can be used to retrieve the next page of results. This value is null
when there are no more results to return.
The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service. For services using the ECS
deployment controller, you are limited to one target group. For services using the CODE_DEPLOY
deployment controller, you are required to define two target groups for the load balancer.
If your service\'s task definition uses the awsvpc
network mode (which is required for the Fargate launch type), you must choose ip
as the target type, not instance
, because tasks that use the awsvpc
network mode are associated with an elastic network interface, not an Amazon EC2 instance.
The name of a load balancer.
', 'LoadBalancer$containerName' => 'The name of the container (as it appears in a container definition) to associate with the load balancer.
', 'LogConfigurationOptionsMap$key' => NULL, 'LogConfigurationOptionsMap$value' => NULL, 'MountPoint$sourceVolume' => 'The name of the volume to mount. Must be a volume name referenced in the name
parameter of task definition volume
.
The path on the container to mount the host volume at.
', 'NetworkBinding$bindIP' => 'The IP address that the container is bound to on the container instance.
', 'NetworkInterface$attachmentId' => 'The attachment ID for the network interface.
', 'NetworkInterface$privateIpv4Address' => 'The private IPv4 address for the network interface.
', 'NetworkInterface$ipv6Address' => 'The private IPv6 address for the network interface.
', 'PlacementConstraint$expression' => 'A cluster query language expression to apply to the constraint. You cannot specify an expression if the constraint type is distinctInstance
. For more information, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide.
The field to apply the placement strategy against. For the spread
placement strategy, valid values are instanceId
(or host
, which has the same effect), or any platform or custom attribute that is applied to a container instance, such as attribute:ecs.availability-zone
. For the binpack
placement strategy, valid values are cpu
and memory
. For the random
placement strategy, this field is not used.
The account setting value for the specified principal ARN. Accepted values are enabled
and disabled
.
The ARN of the principal, which can be an IAM user, IAM role, or the root user. If you specify the root user, it modifies the ARN and resource ID format for all IAM users, IAM roles, and the root user of the account unless an IAM user or role explicitly overrides these settings for themselves. If this field is omitted, the setting are changed only for the authenticated user.
', 'PutAttributesRequest$cluster' => 'The short name or full Amazon Resource Name (ARN) of the cluster that contains the resource to apply attributes. If you do not specify a cluster, the default cluster is assumed.
', 'RegisterContainerInstanceRequest$cluster' => 'The short name or full Amazon Resource Name (ARN) of the cluster with which to register your container instance. If you do not specify a cluster, the default cluster is assumed.
', 'RegisterContainerInstanceRequest$instanceIdentityDocument' => 'The instance identity document for the EC2 instance to register. This document can be found by running the following command from the instance: curl http://169.254.169.254/latest/dynamic/instance-identity/document/
The instance identity document signature for the EC2 instance to register. This signature can be found by running the following command from the instance: curl http://169.254.169.254/latest/dynamic/instance-identity/signature/
The ARN of the container instance (if it was previously registered).
', 'RegisterTaskDefinitionRequest$family' => 'You must specify a family
for a task definition, which allows you to track multiple versions of the same task definition. The family
is used as a name for your task definition. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.
The short name or full Amazon Resource Name (ARN) of the IAM role that containers in this task can assume. All containers in this task are granted the permissions that are specified in this role. For more information, see IAM Roles for Tasks in the Amazon Elastic Container Service Developer Guide.
', 'RegisterTaskDefinitionRequest$executionRoleArn' => 'The Amazon Resource Name (ARN) of the task execution role that the Amazon ECS container agent and the Docker daemon can assume.
', 'RegisterTaskDefinitionRequest$cpu' => 'The number of CPU units used by the task. It can be expressed as an integer using CPU units, for example 1024
, or as a string using vCPUs, for example 1 vCPU
or 1 vcpu
, in a task definition. String values are converted to an integer indicating the CPU units when the task definition is registered.
Task-level CPU and memory parameters are ignored for Windows containers. We recommend specifying container-level resources for Windows containers.
If you are using the EC2 launch type, this field is optional. Supported values are between 128
CPU units (0.125
vCPUs) and 10240
CPU units (10
vCPUs).
If you are using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of supported values for the memory
parameter:
256 (.25 vCPU) - Available memory
values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)
512 (.5 vCPU) - Available memory
values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)
1024 (1 vCPU) - Available memory
values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)
2048 (2 vCPU) - Available memory
values: Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)
4096 (4 vCPU) - Available memory
values: Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)
The amount of memory (in MiB) used by the task. It can be expressed as an integer using MiB, for example 1024
, or as a string using GB, for example 1GB
or 1 GB
, in a task definition. String values are converted to an integer indicating the MiB when the task definition is registered.
Task-level CPU and memory parameters are ignored for Windows containers. We recommend specifying container-level resources for Windows containers.
If using the EC2 launch type, this field is optional.
If using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of supported values for the cpu
parameter:
512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu
values: 256 (.25 vCPU)
1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu
values: 512 (.5 vCPU)
2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available cpu
values: 1024 (1 vCPU)
Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu
values: 2048 (2 vCPU)
Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu
values: 4096 (4 vCPU)
The Amazon Resource Name (ARN) of the secret containing the private repository credentials.
When you are using the Amazon ECS API, AWS CLI, or AWS SDK, if the secret exists in the same Region as the task that you are launching then you can use either the full ARN or the name of the secret. When you are using the AWS Management Console, you must specify the full ARN of the secret.
The name of the resource, such as CPU
, MEMORY
, PORTS
, PORTS_UDP
, or a user-defined resource.
The type of the resource, such as INTEGER
, DOUBLE
, LONG
, or STRINGSET
.
The short name or full Amazon Resource Name (ARN) of the cluster on which to run your task. If you do not specify a cluster, the default cluster is assumed.
', 'RunTaskRequest$taskDefinition' => 'The family
and revision
(family:revision
) or full ARN of the task definition to run. If a revision
is not specified, the latest ACTIVE
revision is used.
An optional tag specified when a task is started. For example, if you automatically trigger a task to run a batch process job, you could apply a unique identifier for that job to your task with the startedBy
parameter. You can then identify which tasks belong to that job by filtering the results of a ListTasks call with the startedBy
value. Up to 36 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.
If a task is started by an Amazon ECS service, then the startedBy
parameter contains the deployment ID of the service that starts it.
The name of the task group to associate with the task. The default value is the family name of the task definition (for example, family:my-family-name).
', 'RunTaskRequest$platformVersion' => 'The platform version the task should run. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the LATEST
platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.
The value to set as the environment variable on the container.
', 'Secret$valueFrom' => 'The secret to expose to the container. Supported values are either the full ARN or the name of the parameter in the AWS Systems Manager Parameter Store.
', 'ServerException$message' => NULL, 'Service$serviceArn' => 'The ARN that identifies the service. The ARN contains the arn:aws:ecs
namespace, followed by the Region of the service, the AWS account ID of the service owner, the service
namespace, and then the service name. For example, arn:aws:ecs:region:012345678910:service/my-service
.
The name of your service. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. Service names must be unique within a cluster, but you can have similarly named services in multiple clusters within a Region or across multiple Regions.
', 'Service$clusterArn' => 'The Amazon Resource Name (ARN) of the cluster that hosts the service.
', 'Service$status' => 'The status of the service. The valid values are ACTIVE
, DRAINING
, or INACTIVE
.
The platform version on which your tasks in the service are running. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the LATEST
platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.
The task definition to use for tasks in the service. This value is specified when the service is created with CreateService, and it can be modified with UpdateService.
', 'Service$roleArn' => 'The ARN of the IAM role associated with the service that allows the Amazon ECS container agent to register container instances with an Elastic Load Balancing load balancer.
', 'Service$createdBy' => 'The principal that created the service.
', 'ServiceEvent$id' => 'The ID string of the event.
', 'ServiceEvent$message' => 'The event message.
', 'ServiceRegistry$registryArn' => 'The Amazon Resource Name (ARN) of the service registry. The currently supported service registry is Amazon Route 53 Auto Naming. For more information, see Service.
', 'ServiceRegistry$containerName' => 'The container name value, already specified in the task definition, to be used for your service discovery service. If the task definition that your service task specifies uses the bridge
or host
network mode, you must specify a containerName
and containerPort
combination from the task definition. If the task definition that your service task specifies uses the awsvpc
network mode and a type SRV DNS record is used, you must specify either a containerName
and containerPort
combination or a port
value, but not both.
The current account setting for the resource name. If enabled
, then the resource will receive the new Amazon Resource Name (ARN) and resource identifier (ID) format. If disabled
, then the resource will receive the old Amazon Resource Name (ARN) and resource identifier (ID) format.
The ARN of the principal, which can be an IAM user, IAM role, or the root user. If this field is omitted, the authenticated user is assumed.
', 'StartTaskRequest$cluster' => 'The short name or full Amazon Resource Name (ARN) of the cluster on which to start your task. If you do not specify a cluster, the default cluster is assumed.
', 'StartTaskRequest$taskDefinition' => 'The family
and revision
(family:revision
) or full ARN of the task definition to start. If a revision
is not specified, the latest ACTIVE
revision is used.
An optional tag specified when a task is started. For example, if you automatically trigger a task to run a batch process job, you could apply a unique identifier for that job to your task with the startedBy
parameter. You can then identify which tasks belong to that job by filtering the results of a ListTasks call with the startedBy
value. Up to 36 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.
If a task is started by an Amazon ECS service, then the startedBy
parameter contains the deployment ID of the service that starts it.
The name of the task group to associate with the task. The default value is the family name of the task definition (for example, family:my-family-name).
', 'StopTaskRequest$cluster' => 'The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task to stop. If you do not specify a cluster, the default cluster is assumed.
', 'StopTaskRequest$task' => 'The task ID or full ARN entry of the task to stop.
', 'StopTaskRequest$reason' => 'An optional message specified when a task is stopped. For example, if you are using a custom scheduler, you can use this parameter to specify the reason for stopping the task here, and the message appears in subsequent DescribeTasks API operations on this task. Up to 255 characters are allowed in this message.
', 'StringList$member' => NULL, 'StringMap$key' => NULL, 'StringMap$value' => NULL, 'SubmitContainerStateChangeRequest$cluster' => 'The short name or full ARN of the cluster that hosts the container.
', 'SubmitContainerStateChangeRequest$task' => 'The task ID or full Amazon Resource Name (ARN) of the task that hosts the container.
', 'SubmitContainerStateChangeRequest$containerName' => 'The name of the container.
', 'SubmitContainerStateChangeRequest$status' => 'The status of the state change request.
', 'SubmitContainerStateChangeRequest$reason' => 'The reason for the state change request.
', 'SubmitContainerStateChangeResponse$acknowledgment' => 'Acknowledgement of the state change.
', 'SubmitTaskStateChangeRequest$cluster' => 'The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task.
', 'SubmitTaskStateChangeRequest$task' => 'The task ID or full ARN of the task in the state change request.
', 'SubmitTaskStateChangeRequest$status' => 'The status of the state change request.
', 'SubmitTaskStateChangeRequest$reason' => 'The reason for the state change request.
', 'SubmitTaskStateChangeResponse$acknowledgment' => 'Acknowledgement of the state change.
', 'SystemControl$namespace' => 'The namespaced kernel parameter for which to set a value
.
The value for the namespaced kernel parameter specified in namespace
.
The Amazon Resource Name (ARN) of the resource to which to add tags. Currently, the supported resources are Amazon ECS tasks, services, task definitions, clusters, and container instances.
', 'Task$taskArn' => 'The Amazon Resource Name (ARN) of the task.
', 'Task$clusterArn' => 'The ARN of the cluster that hosts the task.
', 'Task$taskDefinitionArn' => 'The ARN of the task definition that creates the task.
', 'Task$containerInstanceArn' => 'The ARN of the container instances that host the task.
', 'Task$lastStatus' => 'The last known status of the task. For more information, see Task Lifecycle.
', 'Task$desiredStatus' => 'The desired status of the task. For more information, see Task Lifecycle.
', 'Task$cpu' => 'The number of CPU units used by the task as expressed in a task definition. It can be expressed as an integer using CPU units, for example 1024
. It can also be expressed as a string using vCPUs, for example 1 vCPU
or 1 vcpu
. String values are converted to an integer indicating the CPU units when the task definition is registered.
If you are using the EC2 launch type, this field is optional. Supported values are between 128
CPU units (0.125
vCPUs) and 10240
CPU units (10
vCPUs).
If you are using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of supported values for the memory
parameter:
256 (.25 vCPU) - Available memory
values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)
512 (.5 vCPU) - Available memory
values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)
1024 (1 vCPU) - Available memory
values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)
2048 (2 vCPU) - Available memory
values: Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)
4096 (4 vCPU) - Available memory
values: Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)
The amount of memory (in MiB) used by the task as expressed in a task definition. It can be expressed as an integer using MiB, for example 1024
. It can also be expressed as a string using GB, for example 1GB
or 1 GB
. String values are converted to an integer indicating the MiB when the task definition is registered.
If you are using the EC2 launch type, this field is optional.
If you are using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of supported values for the cpu
parameter:
512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu
values: 256 (.25 vCPU)
1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu
values: 512 (.5 vCPU)
2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available cpu
values: 1024 (1 vCPU)
Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu
values: 2048 (2 vCPU)
Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu
values: 4096 (4 vCPU)
The tag specified when a task is started. If the task is started by an Amazon ECS service, then the startedBy
parameter contains the deployment ID of the service that starts it.
The reason that the task was stopped.
', 'Task$group' => 'The name of the task group associated with the task.
', 'Task$platformVersion' => 'The platform version on which your task is running. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the LATEST
platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.
The full Amazon Resource Name (ARN) of the task definition.
', 'TaskDefinition$family' => 'The family of your task definition, used as the definition name.
', 'TaskDefinition$taskRoleArn' => 'The ARN of the IAM role that containers in this task can assume. All containers in this task are granted the permissions that are specified in this role.
IAM roles for tasks on Windows require that the -EnableTaskIAMRole
option is set when you launch the Amazon ECS-optimized Windows AMI. Your containers must also run some configuration code in order to take advantage of the feature. For more information, see Windows IAM Roles for Tasks in the Amazon Elastic Container Service Developer Guide.
The Amazon Resource Name (ARN) of the task execution role that the Amazon ECS container agent and the Docker daemon can assume.
', 'TaskDefinition$cpu' => 'The number of cpu
units used by the task. If you are using the EC2 launch type, this field is optional and any value can be used. If you are using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of valid values for the memory
parameter:
256 (.25 vCPU) - Available memory
values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)
512 (.5 vCPU) - Available memory
values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)
1024 (1 vCPU) - Available memory
values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)
2048 (2 vCPU) - Available memory
values: Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)
4096 (4 vCPU) - Available memory
values: Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)
The amount (in MiB) of memory used by the task. If using the EC2 launch type, this field is optional and any value can be used. If using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of valid values for the cpu
parameter:
512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu
values: 256 (.25 vCPU)
1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu
values: 512 (.5 vCPU)
2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available cpu
values: 1024 (1 vCPU)
Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu
values: 2048 (2 vCPU)
Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu
values: 4096 (4 vCPU)
A cluster query language expression to apply to the constraint. For more information, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide.
', 'TaskOverride$taskRoleArn' => 'The Amazon Resource Name (ARN) of the IAM role that containers in this task can assume. All containers in this task are granted the permissions that are specified in this role.
', 'TaskOverride$executionRoleArn' => 'The Amazon Resource Name (ARN) of the task execution role that the Amazon ECS container agent and the Docker daemon can assume.
', 'TaskSet$id' => 'The ID of the task set.
', 'TaskSet$taskSetArn' => 'The Amazon Resource Name (ARN) of the task set.
', 'TaskSet$startedBy' => 'The tag specified when a task set is started. If the task is started by an AWS CodeDeploy deployment, then the startedBy
parameter is CODE_DEPLOY
.
The deployment ID of the AWS CodeDeploy deployment.
', 'TaskSet$status' => 'The status of the task set. The following describes each state:
The task set is serving production traffic.
The task set is not serving production traffic.
The tasks in the task set are being stopped and their corresponding targets are being deregistered from their target group.
The task definition the task set is using.
', 'TaskSet$platformVersion' => 'The platform version on which the tasks in the task set are running. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the LATEST
platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.
The absolute file path where the tmpfs volume is to be mounted.
', 'UntagResourceRequest$resourceArn' => 'The Amazon Resource Name (ARN) of the resource from which to delete tags. Currently, the supported resources are Amazon ECS tasks, services, task definitions, clusters, and container instances.
', 'UpdateContainerAgentRequest$cluster' => 'The short name or full Amazon Resource Name (ARN) of the cluster that your container instance is running on. If you do not specify a cluster, the default cluster is assumed.
', 'UpdateContainerAgentRequest$containerInstance' => 'The container instance ID or full ARN entries for the container instance on which you would like to update the Amazon ECS container agent.
', 'UpdateContainerInstancesStateRequest$cluster' => 'The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instance to update. If you do not specify a cluster, the default cluster is assumed.
', 'UpdateServiceRequest$cluster' => 'The short name or full Amazon Resource Name (ARN) of the cluster that your service is running on. If you do not specify a cluster, the default cluster is assumed.
', 'UpdateServiceRequest$service' => 'The name of the service to update.
', 'UpdateServiceRequest$taskDefinition' => 'The family
and revision
(family:revision
) or full ARN of the task definition to run in your service. If a revision
is not specified, the latest ACTIVE
revision is used. If you modify the task definition with UpdateService
, Amazon ECS spawns a task with the new version of the task definition and then stops an old task after the new version is running.
The platform version on which your tasks in the service are running. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the LATEST
platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.
The version number of the Amazon ECS container agent.
', 'VersionInfo$agentHash' => 'The Git commit hash for the Amazon ECS container agent build on the amazon-ecs-agent GitHub repository.
', 'VersionInfo$dockerVersion' => 'The Docker version running on the container instance.
', 'Volume$name' => 'The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. This name is referenced in the sourceVolume
parameter of container definition mountPoints
.
The name of another container within the same task definition from which to mount volumes.
', ], ], 'StringList' => [ 'base' => NULL, 'refs' => [ 'AwsVpcConfiguration$subnets' => 'The subnets associated with the task or service. There is a limit of 16 subnets able to be specified per AwsVpcConfiguration
.
All specified subnets must be from the same VPC.
The security groups associated with the task or service. If you do not specify a security group, the default security group for the VPC is used. There is a limit of five security groups able to be specified per AwsVpcConfiguration
.
All specified security groups must be from the same VPC.
The link
parameter allows containers to communicate with each other without the need for port mappings. Only supported if the network mode of a task definition is set to bridge
. The name:internalName
construct is analogous to name:alias
in Docker links. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. For more information about linking Docker containers, go to https://docs.docker.com/engine/userguide/networking/default_network/dockerlinks/. This parameter maps to Links
in the Create a container section of the Docker Remote API and the --link
option to docker run
.
This parameter is not supported for Windows containers.
Containers that are collocated on a single container instance may be able to communicate with each other without requiring links or host port mappings. Network isolation is achieved on the container instance using security groups and VPC settings.
Early versions of the Amazon ECS container agent do not properly handle entryPoint
parameters. If you have problems using entryPoint
, update your container agent or enter your commands and arguments as command
array items instead.
The entry point that is passed to the container. This parameter maps to Entrypoint
in the Create a container section of the Docker Remote API and the --entrypoint
option to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#entrypoint.
The command that is passed to the container. This parameter maps to Cmd
in the Create a container section of the Docker Remote API and the COMMAND
parameter to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#cmd.
A list of DNS servers that are presented to the container. This parameter maps to Dns
in the Create a container section of the Docker Remote API and the --dns
option to docker run.
This parameter is not supported for Windows containers.
A list of DNS search domains that are presented to the container. This parameter maps to DnsSearch
in the Create a container section of the Docker Remote API and the --dns-search
option to docker run.
This parameter is not supported for Windows containers.
A list of strings to provide custom labels for SELinux and AppArmor multi-level security systems. This field is not valid for containers in tasks using the Fargate launch type.
This parameter maps to SecurityOpt
in the Create a container section of the Docker Remote API and the --security-opt
option to docker run.
The Amazon ECS container agent running on a container instance must register with the ECS_SELINUX_CAPABLE=true
or ECS_APPARMOR_CAPABLE=true
environment variables before containers placed on that instance can use these security options. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide.
This parameter is not supported for Windows containers.
The command to send to the container that overrides the default command from the Docker image or the task definition. You must also specify a container name.
', 'DescribeClustersRequest$clusters' => 'A list of up to 100 cluster names or full cluster Amazon Resource Name (ARN) entries. If you do not specify a cluster, the default cluster is assumed.
', 'DescribeContainerInstancesRequest$containerInstances' => 'A list of up to 100 container instance IDs or full Amazon Resource Name (ARN) entries.
', 'DescribeServicesRequest$services' => 'A list of services to describe. You may specify up to 10 services to describe in a single operation.
', 'DescribeTasksRequest$tasks' => 'A list of up to 100 task IDs or full ARN entries.
', 'HealthCheck$command' => 'A string array representing the command that the container runs to determine if it is healthy. The string array must start with CMD
to execute the command arguments directly, or CMD-SHELL
to run the command with the container\'s default shell. For example:
[ "CMD-SHELL", "curl -f http://localhost/ || exit 1" ]
An exit code of 0 indicates success, and non-zero exit code indicates failure. For more information, see HealthCheck
in the Create a container section of the Docker Remote API.
The Linux capabilities for the container that have been added to the default configuration provided by Docker. This parameter maps to CapAdd
in the Create a container section of the Docker Remote API and the --cap-add
option to docker run.
If you are using tasks that use the Fargate launch type, the add
parameter is not supported.
Valid values: "ALL" | "AUDIT_CONTROL" | "AUDIT_WRITE" | "BLOCK_SUSPEND" | "CHOWN" | "DAC_OVERRIDE" | "DAC_READ_SEARCH" | "FOWNER" | "FSETID" | "IPC_LOCK" | "IPC_OWNER" | "KILL" | "LEASE" | "LINUX_IMMUTABLE" | "MAC_ADMIN" | "MAC_OVERRIDE" | "MKNOD" | "NET_ADMIN" | "NET_BIND_SERVICE" | "NET_BROADCAST" | "NET_RAW" | "SETFCAP" | "SETGID" | "SETPCAP" | "SETUID" | "SYS_ADMIN" | "SYS_BOOT" | "SYS_CHROOT" | "SYS_MODULE" | "SYS_NICE" | "SYS_PACCT" | "SYS_PTRACE" | "SYS_RAWIO" | "SYS_RESOURCE" | "SYS_TIME" | "SYS_TTY_CONFIG" | "SYSLOG" | "WAKE_ALARM"
The Linux capabilities for the container that have been removed from the default configuration provided by Docker. This parameter maps to CapDrop
in the Create a container section of the Docker Remote API and the --cap-drop
option to docker run.
Valid values: "ALL" | "AUDIT_CONTROL" | "AUDIT_WRITE" | "BLOCK_SUSPEND" | "CHOWN" | "DAC_OVERRIDE" | "DAC_READ_SEARCH" | "FOWNER" | "FSETID" | "IPC_LOCK" | "IPC_OWNER" | "KILL" | "LEASE" | "LINUX_IMMUTABLE" | "MAC_ADMIN" | "MAC_OVERRIDE" | "MKNOD" | "NET_ADMIN" | "NET_BIND_SERVICE" | "NET_BROADCAST" | "NET_RAW" | "SETFCAP" | "SETGID" | "SETPCAP" | "SETUID" | "SYS_ADMIN" | "SYS_BOOT" | "SYS_CHROOT" | "SYS_MODULE" | "SYS_NICE" | "SYS_PACCT" | "SYS_PTRACE" | "SYS_RAWIO" | "SYS_RESOURCE" | "SYS_TIME" | "SYS_TTY_CONFIG" | "SYSLOG" | "WAKE_ALARM"
The list of full Amazon Resource Name (ARN) entries for each cluster associated with your account.
', 'ListContainerInstancesResponse$containerInstanceArns' => 'The list of container instances with full ARN entries for each container instance associated with the specified cluster.
', 'ListServicesResponse$serviceArns' => 'The list of full ARN entries for each service associated with the specified cluster.
', 'ListTaskDefinitionFamiliesResponse$families' => 'The list of task definition family names that match the ListTaskDefinitionFamilies
request.
The list of task definition Amazon Resource Name (ARN) entries for the ListTaskDefinitions
request.
The list of task ARN entries for the ListTasks
request.
When the stringSetValue
type is set, the value of the resource must be a string type.
The container instance IDs or full ARN entries for the container instances on which you would like to place your task. You can specify up to 10 container instances.
', 'Tmpfs$mountOptions' => 'The list of tmpfs volume mount options.
Valid values: "defaults" | "ro" | "rw" | "suid" | "nosuid" | "dev" | "nodev" | "exec" | "noexec" | "sync" | "async" | "dirsync" | "remount" | "mand" | "nomand" | "atime" | "noatime" | "diratime" | "nodiratime" | "bind" | "rbind" | "unbindable" | "runbindable" | "private" | "rprivate" | "shared" | "rshared" | "slave" | "rslave" | "relatime" | "norelatime" | "strictatime" | "nostrictatime" | "mode" | "uid" | "gid" | "nr_inodes" | "nr_blocks" | "mpol"
A list of container instance IDs or full ARN entries.
', ], ], 'StringMap' => [ 'base' => NULL, 'refs' => [ 'DockerVolumeConfiguration$driverOpts' => 'A map of Docker driver-specific options passed through. This parameter maps to DriverOpts
in the Create a volume section of the Docker Remote API and the xxopt
option to docker volume create
.
Custom metadata to add to your Docker volume. This parameter maps to Labels
in the Create a volume section of the Docker Remote API and the xxlabel
option to docker volume create
.
A list of namespaced kernel parameters to set in the container. This parameter maps to Sysctls
in the Create a container section of the Docker Remote API and the --sysctl
option to docker run.
It is not recommended that you specify network-related systemControls
parameters for multiple containers in a single task that also uses either the awsvpc
or host
network mode for the following reasons:
For tasks that use the awsvpc
network mode, if you set systemControls
for any container, it applies to all containers in the task. If you set different systemControls
for multiple containers in a single task, the container that is started last determines which systemControls
take effect.
For tasks that use the host
network mode, the systemControls
parameter applies to the container instance\'s kernel parameter as well as that of all containers of any tasks running on that container instance.
A list of namespaced kernel parameters to set in the container. This parameter maps to Sysctls
in the Create a container section of the Docker Remote API and the --sysctl
option to docker run.
It is not recommended that you specify network-related systemControls
parameters for multiple containers in a single task that also uses either the awsvpc
or host
network modes. For tasks that use the awsvpc
network mode, the container that is started last determines which systemControls
parameters take effect. For tasks that use the host
network mode, it changes the container instance\'s namespaced kernel parameters as well as the containers.
The metadata that you apply to a resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
', 'refs' => [ 'Tags$member' => NULL, ], ], 'TagKey' => [ 'base' => NULL, 'refs' => [ 'Tag$key' => 'One part of a key-value pair that make up a tag. A key
is a general label that acts like a category for more specific tag values.
The keys of the tags to be removed.
', ], ], 'TagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'TagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'TagValue' => [ 'base' => NULL, 'refs' => [ 'Tag$value' => 'The optional part of a key-value pair that make up a tag. A value
acts as a descriptor within a tag category (key).
The metadata that you apply to the cluster to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
', 'ContainerInstance$tags' => 'The metadata that you apply to the container instance to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
', 'CreateClusterRequest$tags' => 'The metadata that you apply to the cluster to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
', 'CreateServiceRequest$tags' => 'The metadata that you apply to the service to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. When a service is deleted, the tags are deleted as well. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
', 'DescribeTaskDefinitionResponse$tags' => 'The metadata that is applied to the task definition to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
', 'ListTagsForResourceResponse$tags' => 'The tags for the resource.
', 'RegisterContainerInstanceRequest$tags' => 'The metadata that you apply to the container instance to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
', 'RegisterTaskDefinitionRequest$tags' => 'The metadata that you apply to the task definition to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
', 'RegisterTaskDefinitionResponse$tags' => 'The list of tags associated with the task definition.
', 'RunTaskRequest$tags' => 'The metadata that you apply to the task to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
', 'Service$tags' => 'The metadata that you apply to the service to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
', 'StartTaskRequest$tags' => 'The metadata that you apply to the task to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
', 'TagResourceRequest$tags' => 'The tags to add to the resource. A tag is an array of key-value pairs. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
', 'Task$tags' => 'The metadata that you apply to the task to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
', ], ], 'TargetNotFoundException' => [ 'base' => 'The specified target could not be found. You can view your available container instances with ListContainerInstances. Amazon ECS container instances are cluster-specific and Region-specific.
', 'refs' => [], ], 'TargetType' => [ 'base' => NULL, 'refs' => [ 'Attribute$targetType' => 'The type of the target with which to attach the attribute. This parameter is required if you use the short form ID for a resource instead of the full ARN.
', 'ListAttributesRequest$targetType' => 'The type of the target with which to list attributes.
', ], ], 'Task' => [ 'base' => 'Details on a task in a cluster.
', 'refs' => [ 'StopTaskResponse$task' => 'The task that was stopped.
', 'Tasks$member' => NULL, ], ], 'TaskDefinition' => [ 'base' => 'Details of a task definition.
', 'refs' => [ 'DeregisterTaskDefinitionResponse$taskDefinition' => 'The full description of the deregistered task.
', 'DescribeTaskDefinitionResponse$taskDefinition' => 'The full task definition description.
', 'RegisterTaskDefinitionResponse$taskDefinition' => 'The full description of the registered task definition.
', ], ], 'TaskDefinitionFamilyStatus' => [ 'base' => NULL, 'refs' => [ 'ListTaskDefinitionFamiliesRequest$status' => 'The task definition family status with which to filter the ListTaskDefinitionFamilies
results. By default, both ACTIVE
and INACTIVE
task definition families are listed. If this parameter is set to ACTIVE
, only task definition families that have an ACTIVE
task definition revision are returned. If this parameter is set to INACTIVE
, only task definition families that do not have any ACTIVE
task definition revisions are returned. If you paginate the resulting output, be sure to keep the status
value constant in each subsequent request.
Specifies whether to see the resource tags for the task definition. If TAGS
is specified, the tags are included in the response. If this field is omitted, tags are not included in the response.
An object representing a constraint on task placement in the task definition.
If you are using the Fargate launch type, task placement constraints are not supported.
For more information, see Task Placement Constraints in the Amazon Elastic Container Service Developer Guide.
', 'refs' => [ 'TaskDefinitionPlacementConstraints$member' => NULL, ], ], 'TaskDefinitionPlacementConstraintType' => [ 'base' => NULL, 'refs' => [ 'TaskDefinitionPlacementConstraint$type' => 'The type of constraint. The DistinctInstance
constraint ensures that each task in a particular group is running on a different container instance. The MemberOf
constraint restricts selection to be from a group of valid candidates.
An array of placement constraint objects to use for the task. You can specify a maximum of 10 constraints per task (this limit includes constraints in the task definition and those specified at runtime).
', 'TaskDefinition$placementConstraints' => 'An array of placement constraint objects to use for tasks. This field is not valid if you are using the Fargate launch type for your task.
', ], ], 'TaskDefinitionStatus' => [ 'base' => NULL, 'refs' => [ 'ListTaskDefinitionsRequest$status' => 'The task definition status with which to filter the ListTaskDefinitions
results. By default, only ACTIVE
task definitions are listed. By setting this parameter to INACTIVE
, you can view task definitions that are INACTIVE
as long as an active task or service still references them. If you paginate the resulting output, be sure to keep the status
value constant in each subsequent request.
The status of the task definition.
', ], ], 'TaskField' => [ 'base' => NULL, 'refs' => [ 'TaskFieldList$member' => NULL, ], ], 'TaskFieldList' => [ 'base' => NULL, 'refs' => [ 'DescribeTasksRequest$include' => 'Specifies whether you want to see the resource tags for the task. If TAGS
is specified, the tags are included in the response. If this field is omitted, tags are not included in the response.
The overrides associated with a task.
', 'refs' => [ 'RunTaskRequest$overrides' => 'A list of container overrides in JSON format that specify the name of a container in the specified task definition and the overrides it should receive. You can override the default command for a container (that is specified in the task definition or Docker image) with a command
override. You can also override existing environment variables (that are specified in the task definition or Docker image) on a container or add new environment variables to it with an environment
override.
A total of 8192 characters are allowed for overrides. This limit includes the JSON formatting characters of the override structure.
A list of container overrides in JSON format that specify the name of a container in the specified task definition and the overrides it should receive. You can override the default command for a container (that is specified in the task definition or Docker image) with a command
override. You can also override existing environment variables (that are specified in the task definition or Docker image) on a container or add new environment variables to it with an environment
override.
A total of 8192 characters are allowed for overrides. This limit includes the JSON formatting characters of the override structure.
One or more container overrides.
', ], ], 'TaskSet' => [ 'base' => 'Information about a set of Amazon ECS tasks in an AWS CodeDeploy deployment. An Amazon ECS task set includes details such as the desired number of tasks, how many tasks are running, and whether the task set serves production traffic.
', 'refs' => [ 'TaskSets$member' => NULL, ], ], 'TaskSets' => [ 'base' => NULL, 'refs' => [ 'Service$taskSets' => 'Information about a set of Amazon ECS tasks in an AWS CodeDeploy deployment. An Amazon ECS task set includes details such as the desired number of tasks, how many tasks are running, and whether the task set serves production traffic.
', ], ], 'TaskStopCode' => [ 'base' => NULL, 'refs' => [ 'Task$stopCode' => 'The stop code indicating why a task was stopped. The stoppedReason
may contain additional details.
The list of tasks.
', 'RunTaskResponse$tasks' => 'A full description of the tasks that were run. The tasks that were successfully placed on your cluster are described here.
', 'StartTaskResponse$tasks' => 'A full description of the tasks that were started. Each task that was successfully placed on your container instances is described.
', ], ], 'Timestamp' => [ 'base' => NULL, 'refs' => [ 'ContainerInstance$registeredAt' => 'The Unix timestamp for when the container instance was registered.
', 'Deployment$createdAt' => 'The Unix timestamp for when the service deployment was created.
', 'Deployment$updatedAt' => 'The Unix timestamp for when the service deployment was last updated.
', 'Service$createdAt' => 'The Unix timestamp for when the service was created.
', 'ServiceEvent$createdAt' => 'The Unix timestamp for when the event was triggered.
', 'SubmitTaskStateChangeRequest$pullStartedAt' => 'The Unix timestamp for when the container image pull began.
', 'SubmitTaskStateChangeRequest$pullStoppedAt' => 'The Unix timestamp for when the container image pull completed.
', 'SubmitTaskStateChangeRequest$executionStoppedAt' => 'The Unix timestamp for when the task execution stopped.
', 'Task$connectivityAt' => 'The Unix timestamp for when the task last went into CONNECTED
status.
The Unix timestamp for when the container image pull began.
', 'Task$pullStoppedAt' => 'The Unix timestamp for when the container image pull completed.
', 'Task$executionStoppedAt' => 'The Unix timestamp for when the task execution stopped.
', 'Task$createdAt' => 'The Unix timestamp for when the task was created (the task entered the PENDING
state).
The Unix timestamp for when the task started (the task transitioned from the PENDING
state to the RUNNING
state).
The Unix timestamp for when the task stops (transitions from the RUNNING
state to STOPPED
).
The Unix timestamp for when the task was stopped (the task transitioned from the RUNNING
state to the STOPPED
state).
The Unix timestamp for when the task set was created.
', 'TaskSet$updatedAt' => 'The Unix timestamp for when the task set was last updated.
', 'TaskSet$stabilityStatusAt' => 'The Unix timestamp for when the task set stability status was retrieved.
', ], ], 'Tmpfs' => [ 'base' => 'The container path, mount options, and size of the tmpfs mount.
', 'refs' => [ 'TmpfsList$member' => NULL, ], ], 'TmpfsList' => [ 'base' => NULL, 'refs' => [ 'LinuxParameters$tmpfs' => 'The container path, mount options, and size (in MiB) of the tmpfs mount. This parameter maps to the --tmpfs
option to docker run.
If you are using tasks that use the Fargate launch type, the tmpfs
parameter is not supported.
The protocol used for the network binding.
', 'PortMapping$protocol' => 'The protocol used for the port mapping. Valid values are tcp
and udp
. The default is tcp
.
The ulimit
settings to pass to the container.
A list of ulimits
to set in the container. This parameter maps to Ulimits
in the Create a container section of the Docker Remote API and the --ulimit
option to docker run. Valid naming values are displayed in the Ulimit data type. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format \'{{.Server.APIVersion}}\'
This parameter is not supported for Windows containers.
The type
of the ulimit
.
The specified task is not supported in this Region.
', 'refs' => [], ], 'UntagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UntagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateContainerAgentRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateContainerAgentResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateContainerInstancesStateRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateContainerInstancesStateResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateInProgressException' => [ 'base' => 'There is already a current Amazon ECS container agent update in progress on the specified container instance. If the container agent becomes disconnected while it is in a transitional stage, such as PENDING
or STAGING
, the update process can get stuck in that state. However, when the agent reconnects, it resumes where it stopped previously.
The Docker and Amazon ECS container agent version information about a container instance.
', 'refs' => [ 'ContainerInstance$versionInfo' => 'The version information for the Amazon ECS container agent and Docker daemon running on the container instance.
', 'RegisterContainerInstanceRequest$versionInfo' => 'The version information for the Amazon ECS container agent and Docker daemon running on the container instance.
', ], ], 'Volume' => [ 'base' => 'A data volume used in a task definition. For tasks that use a Docker volume, specify a DockerVolumeConfiguration
. For tasks that use a bind mount host volume, specify a host
and optional sourcePath
. For more information, see Using Data Volumes in Tasks.
Details on a data volume from another container in the same task definition.
', 'refs' => [ 'VolumeFromList$member' => NULL, ], ], 'VolumeFromList' => [ 'base' => NULL, 'refs' => [ 'ContainerDefinition$volumesFrom' => 'Data volumes to mount from another container. This parameter maps to VolumesFrom
in the Create a container section of the Docker Remote API and the --volumes-from
option to docker run.
A list of volume definitions in JSON format that containers in your task may use.
', 'TaskDefinition$volumes' => 'The list of volumes in a task.
If you are using the Fargate launch type, the host
and sourcePath
parameters are not supported.
For more information about volume definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon Elastic Container Service Developer Guide.
', ], ], ],]; +return [ 'version' => '2.0', 'service' => 'Amazon Elastic Container Service (Amazon ECS) is a highly scalable, fast, container management service that makes it easy to run, stop, and manage Docker containers on a cluster. You can host your cluster on a serverless infrastructure that is managed by Amazon ECS by launching your services or tasks using the Fargate launch type. For more control, you can host your tasks on a cluster of Amazon Elastic Compute Cloud (Amazon EC2) instances that you manage by using the EC2 launch type. For more information about launch types, see Amazon ECS Launch Types.
Amazon ECS lets you launch and stop container-based applications with simple API calls, allows you to get the state of your cluster from a centralized service, and gives you access to many familiar Amazon EC2 features.
You can use Amazon ECS to schedule the placement of containers across your cluster based on your resource needs, isolation policies, and availability requirements. Amazon ECS eliminates the need for you to operate your own cluster management and configuration management systems or worry about scaling your management infrastructure.
', 'operations' => [ 'CreateCluster' => 'Creates a new Amazon ECS cluster. By default, your account receives a default
cluster when you launch your first container instance. However, you can create your own cluster with a unique name with the CreateCluster
action.
When you call the CreateCluster API operation, Amazon ECS attempts to create the service-linked role for your account so that required resources in other AWS services can be managed on your behalf. However, if the IAM user that makes the call does not have permissions to create the service-linked role, it is not created. For more information, see Using Service-Linked Roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.
Runs and maintains a desired number of tasks from a specified task definition. If the number of tasks running in a service drops below desiredCount
, Amazon ECS spawns another copy of the task in the specified cluster. To update an existing service, see UpdateService.
In addition to maintaining the desired count of tasks in your service, you can optionally run your service behind a load balancer. The load balancer distributes traffic across the tasks that are associated with the service. For more information, see Service Load Balancing in the Amazon Elastic Container Service Developer Guide.
You can optionally specify a deployment configuration for your service. The deployment is triggered by changing properties, such as the task definition or the desired count of a service, with an UpdateService operation.
If a service is using the ECS
deployment controller, the minimum healthy percent represents a lower limit on the number of tasks in a service that must remain in the RUNNING
state during a deployment, as a percentage of the desired number of tasks (rounded up to the nearest integer), and while any container instances are in the DRAINING
state if the service contains tasks using the EC2 launch type. This parameter enables you to deploy without using additional cluster capacity. For example, if your service has a desired number of four tasks and a minimum healthy percent of 50%, the scheduler may stop two existing tasks to free up cluster capacity before starting two new tasks. Tasks for services that do not use a load balancer are considered healthy if they are in the RUNNING
state; tasks for services that do use a load balancer are considered healthy if they are in the RUNNING
state and they are reported as healthy by the load balancer. The default value for minimum healthy percent is 100%.
If a service is using the ECS
deployment controller, the maximum percent parameter represents an upper limit on the number of tasks in a service that are allowed in the RUNNING
or PENDING
state during a deployment, as a percentage of the desired number of tasks (rounded down to the nearest integer), and while any container instances are in the DRAINING
state if the service contains tasks using the EC2 launch type. This parameter enables you to define the deployment batch size. For example, if your service has a desired number of four tasks and a maximum percent value of 200%, the scheduler may start four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available). The default value for maximum percent is 200%.
If a service is using the CODE_DEPLOY
deployment controller and tasks that use the EC2 launch type, the minimum healthy percent and maximum percent values are only used to define the lower and upper limit on the number of the tasks in the service that remain in the RUNNING
state while the container instances are in the DRAINING
state. If the tasks in the service use the Fargate launch type, the minimum healthy percent and maximum percent values are not used, although they are currently visible when describing your service.
Tasks for services that do not use a load balancer are considered healthy if they are in the RUNNING
state. Tasks for services that do use a load balancer are considered healthy if they are in the RUNNING
state and the container instance they are hosted on is reported as healthy by the load balancer. The default value for a replica service for minimumHealthyPercent
is 100%. The default value for a daemon service for minimumHealthyPercent
is 0%.
When the service scheduler launches new tasks, it determines task placement in your cluster using the following logic:
Determine which of the container instances in your cluster can support your service\'s task definition (for example, they have the required CPU, memory, ports, and container instance attributes).
By default, the service scheduler attempts to balance tasks across Availability Zones in this manner (although you can choose a different placement strategy) with the placementStrategy
parameter):
Sort the valid container instances, giving priority to instances that have the fewest number of running tasks for this service in their respective Availability Zone. For example, if zone A has one running service task and zones B and C each have zero, valid container instances in either zone B or C are considered optimal for placement.
Place the new service task on a valid container instance in an optimal Availability Zone (based on the previous steps), favoring container instances with the fewest number of running tasks for this service.
Modifies the ARN and resource ID format of a resource for a specified IAM user, IAM role, or the root user for an account. You can specify whether the new ARN and resource ID format are disabled for new resources that are created.
', 'DeleteAttributes' => 'Deletes one or more custom attributes from an Amazon ECS resource.
', 'DeleteCluster' => 'Deletes the specified cluster. You must deregister all container instances from this cluster before you may delete it. You can list the container instances in a cluster with ListContainerInstances and deregister them with DeregisterContainerInstance.
', 'DeleteService' => 'Deletes a specified service within a cluster. You can delete a service if you have no running tasks in it and the desired task count is zero. If the service is actively maintaining tasks, you cannot delete it, and you must update the service to a desired task count of zero. For more information, see UpdateService.
When you delete a service, if there are still running tasks that require cleanup, the service status moves from ACTIVE
to DRAINING
, and the service is no longer visible in the console or in the ListServices API operation. After the tasks have stopped, then the service status moves from DRAINING
to INACTIVE
. Services in the DRAINING
or INACTIVE
status can still be viewed with the DescribeServices API operation. However, in the future, INACTIVE
services may be cleaned up and purged from Amazon ECS record keeping, and DescribeServices calls on those services return a ServiceNotFoundException
error.
If you attempt to create a new service with the same name as an existing service in either ACTIVE
or DRAINING
status, you receive an error.
Deregisters an Amazon ECS container instance from the specified cluster. This instance is no longer available to run tasks.
If you intend to use the container instance for some other purpose after deregistration, you should stop all of the tasks running on the container instance before deregistration. That prevents any orphaned tasks from consuming resources.
Deregistering a container instance removes the instance from a cluster, but it does not terminate the EC2 instance. If you are finished using the instance, be sure to terminate it in the Amazon EC2 console to stop billing.
If you terminate a running container instance, Amazon ECS automatically deregisters the instance from your cluster (stopped container instances or instances with disconnected agents are not automatically deregistered when terminated).
Deregisters the specified task definition by family and revision. Upon deregistration, the task definition is marked as INACTIVE
. Existing tasks and services that reference an INACTIVE
task definition continue to run without disruption. Existing services that reference an INACTIVE
task definition can still scale up or down by modifying the service\'s desired count.
You cannot use an INACTIVE
task definition to run new tasks or create new services, and you cannot update an existing service to reference an INACTIVE
task definition. However, there may be up to a 10-minute window following deregistration where these restrictions have not yet taken effect.
At this time, INACTIVE
task definitions remain discoverable in your account indefinitely. However, this behavior is subject to change in the future, so you should not rely on INACTIVE
task definitions persisting beyond the lifecycle of any associated tasks and services.
Describes one or more of your clusters.
', 'DescribeContainerInstances' => 'Describes Amazon Elastic Container Service container instances. Returns metadata about registered and remaining resources on each container instance requested.
', 'DescribeServices' => 'Describes the specified services running in your cluster.
', 'DescribeTaskDefinition' => 'Describes a task definition. You can specify a family
and revision
to find information about a specific task definition, or you can simply specify the family to find the latest ACTIVE
revision in that family.
You can only describe INACTIVE
task definitions while an active task or service references them.
Describes a specified task or tasks.
', 'DiscoverPollEndpoint' => 'This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.
Returns an endpoint for the Amazon ECS agent to poll for updates.
', 'ListAccountSettings' => 'Lists the account settings for an Amazon ECS resource for a specified principal.
', 'ListAttributes' => 'Lists the attributes for Amazon ECS resources within a specified target type and cluster. When you specify a target type and cluster, ListAttributes
returns a list of attribute objects, one for each attribute on each resource. You can filter the list of results to a single attribute name to only return results that have that name. You can also filter the results by attribute name and value, for example, to see which container instances in a cluster are running a Linux AMI (ecs.os-type=linux
).
Returns a list of existing clusters.
', 'ListContainerInstances' => 'Returns a list of container instances in a specified cluster. You can filter the results of a ListContainerInstances
operation with cluster query language statements inside the filter
parameter. For more information, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide.
Lists the services that are running in a specified cluster.
', 'ListTagsForResource' => 'List the tags for an Amazon ECS resource.
', 'ListTaskDefinitionFamilies' => 'Returns a list of task definition families that are registered to your account (which may include task definition families that no longer have any ACTIVE
task definition revisions).
You can filter out task definition families that do not contain any ACTIVE
task definition revisions by setting the status
parameter to ACTIVE
. You can also filter the results with the familyPrefix
parameter.
Returns a list of task definitions that are registered to your account. You can filter the results by family name with the familyPrefix
parameter or by status with the status
parameter.
Returns a list of tasks for a specified cluster. You can filter the results by family name, by a particular container instance, or by the desired status of the task with the family
, containerInstance
, and desiredStatus
parameters.
Recently stopped tasks might appear in the returned results. Currently, stopped tasks appear in the returned results for at least one hour.
', 'PutAccountSetting' => 'Modifies the ARN and resource ID format of a resource for a specified IAM user, IAM role, or the root user for an account. You can specify whether the new ARN and resource ID format are enabled for new resources that are created. Enabling this setting is required to use new Amazon ECS features such as resource tagging.
', 'PutAttributes' => 'Create or update an attribute on an Amazon ECS resource. If the attribute does not exist, it is created. If the attribute exists, its value is replaced with the specified value. To delete an attribute, use DeleteAttributes. For more information, see Attributes in the Amazon Elastic Container Service Developer Guide.
', 'RegisterContainerInstance' => 'This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.
Registers an EC2 instance into the specified cluster. This instance becomes available to place containers on.
', 'RegisterTaskDefinition' => 'Registers a new task definition from the supplied family
and containerDefinitions
. Optionally, you can add data volumes to your containers with the volumes
parameter. For more information about task definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon Elastic Container Service Developer Guide.
You can specify an IAM role for your task with the taskRoleArn
parameter. When you specify an IAM role for a task, its containers can then use the latest versions of the AWS CLI or SDKs to make API requests to the AWS services that are specified in the IAM policy associated with the role. For more information, see IAM Roles for Tasks in the Amazon Elastic Container Service Developer Guide.
You can specify a Docker networking mode for the containers in your task definition with the networkMode
parameter. The available network modes correspond to those described in Network settings in the Docker run reference. If you specify the awsvpc
network mode, the task is allocated an elastic network interface, and you must specify a NetworkConfiguration when you create a service or run a task with the task definition. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide.
Starts a new task using the specified task definition.
You can allow Amazon ECS to place tasks for you, or you can customize how Amazon ECS places tasks using placement constraints and placement strategies. For more information, see Scheduling Tasks in the Amazon Elastic Container Service Developer Guide.
Alternatively, you can use StartTask to use your own scheduler or place tasks manually on specific container instances.
The Amazon ECS API follows an eventual consistency model, due to the distributed nature of the system supporting the API. This means that the result of an API command you run that affects your Amazon ECS resources might not be immediately visible to all subsequent commands you run. Keep this in mind when you carry out an API command that immediately follows a previous API command.
To manage eventual consistency, you can do the following:
Confirm the state of the resource before you run a command to modify it. Run the DescribeTasks command using an exponential backoff algorithm to ensure that you allow enough time for the previous command to propagate through the system. To do this, run the DescribeTasks command repeatedly, starting with a couple of seconds of wait time and increasing gradually up to five minutes of wait time.
Add wait time between subsequent commands, even if the DescribeTasks command returns an accurate response. Apply an exponential backoff algorithm starting with a couple of seconds of wait time, and increase gradually up to about five minutes of wait time.
Starts a new task from the specified task definition on the specified container instance or instances.
Alternatively, you can use RunTask to place tasks for you. For more information, see Scheduling Tasks in the Amazon Elastic Container Service Developer Guide.
', 'StopTask' => 'Stops a running task. Any tags associated with the task will be deleted.
When StopTask is called on a task, the equivalent of docker stop
is issued to the containers running in the task. This results in a SIGTERM
value and a default 30-second timeout, after which the SIGKILL
value is sent and the containers are forcibly stopped. If the container handles the SIGTERM
value gracefully and exits within 30 seconds from receiving it, no SIGKILL
value is sent.
The default 30-second timeout can be configured on the Amazon ECS container agent with the ECS_CONTAINER_STOP_TIMEOUT
variable. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide.
This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.
Sent to acknowledge that a container changed states.
', 'SubmitTaskStateChange' => 'This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.
Sent to acknowledge that a task changed states.
', 'TagResource' => 'Associates the specified tags to a resource with the specified resourceArn
. If existing tags on a resource are not specified in the request parameters, they are not changed. When a resource is deleted, the tags associated with that resource are deleted as well.
Deletes specified tags from a resource.
', 'UpdateContainerAgent' => 'Updates the Amazon ECS container agent on a specified container instance. Updating the Amazon ECS container agent does not interrupt running tasks or services on the container instance. The process for updating the agent differs depending on whether your container instance was launched with the Amazon ECS-optimized AMI or another operating system.
UpdateContainerAgent
requires the Amazon ECS-optimized AMI or Amazon Linux with the ecs-init
service installed and running. For help updating the Amazon ECS container agent on other operating systems, see Manually Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide.
Modifies the status of an Amazon ECS container instance.
You can change the status of a container instance to DRAINING
to manually remove an instance from a cluster, for example to perform system updates, update the Docker daemon, or scale down the cluster size.
When you set a container instance to DRAINING
, Amazon ECS prevents new tasks from being scheduled for placement on the container instance and replacement service tasks are started on other container instances in the cluster if the resources are available. Service tasks on the container instance that are in the PENDING
state are stopped immediately.
Service tasks on the container instance that are in the RUNNING
state are stopped and replaced according to the service\'s deployment configuration parameters, minimumHealthyPercent
and maximumPercent
. You can change the deployment configuration of your service using UpdateService.
If minimumHealthyPercent
is below 100%, the scheduler can ignore desiredCount
temporarily during task replacement. For example, desiredCount
is four tasks, a minimum of 50% allows the scheduler to stop two existing tasks before starting two new tasks. If the minimum is 100%, the service scheduler can\'t remove existing tasks until the replacement tasks are considered healthy. Tasks for services that do not use a load balancer are considered healthy if they are in the RUNNING
state. Tasks for services that use a load balancer are considered healthy if they are in the RUNNING
state and the container instance they are hosted on is reported as healthy by the load balancer.
The maximumPercent
parameter represents an upper limit on the number of running tasks during task replacement, which enables you to define the replacement batch size. For example, if desiredCount
is four tasks, a maximum of 200% starts four new tasks before stopping the four tasks to be drained, provided that the cluster resources required to do this are available. If the maximum is 100%, then replacement tasks can\'t start until the draining tasks have stopped.
Any PENDING
or RUNNING
tasks that do not belong to a service are not affected. You must wait for them to finish or stop them manually.
A container instance has completed draining when it has no more RUNNING
tasks. You can verify this using ListTasks.
When you set a container instance to ACTIVE
, the Amazon ECS scheduler can begin scheduling tasks on the instance again.
Modifies the parameters of a service.
For services using the rolling update (ECS
) deployment controller, the desired count, deployment configuration, network configuration, or task definition used can be updated.
For services using the blue/green (CODE_DEPLOY
) deployment controller, only the desired count, deployment configuration, and health check grace period can be updated using this API. If the network configuration, platform version, or task definition need to be updated, a new AWS CodeDeploy deployment should be created. For more information, see CreateDeployment in the AWS CodeDeploy API Reference.
You can add to or subtract from the number of instantiations of a task definition in a service by specifying the cluster that the service is running in and a new desiredCount
parameter.
If you have updated the Docker image of your application, you can create a new task definition with that image and deploy it to your service. The service scheduler uses the minimum healthy percent and maximum percent parameters (in the service\'s deployment configuration) to determine the deployment strategy.
If your updated Docker image uses the same tag as what is in the existing task definition for your service (for example, my_image:latest
), you do not need to create a new revision of your task definition. You can update the service using the forceNewDeployment
option. The new tasks launched by the deployment pull the current image/tag combination from your repository when they start.
You can also update the deployment configuration of a service. When a deployment is triggered by updating the task definition of a service, the service scheduler uses the deployment configuration parameters, minimumHealthyPercent
and maximumPercent
, to determine the deployment strategy.
If minimumHealthyPercent
is below 100%, the scheduler can ignore desiredCount
temporarily during a deployment. For example, if desiredCount
is four tasks, a minimum of 50% allows the scheduler to stop two existing tasks before starting two new tasks. Tasks for services that do not use a load balancer are considered healthy if they are in the RUNNING
state. Tasks for services that use a load balancer are considered healthy if they are in the RUNNING
state and the container instance they are hosted on is reported as healthy by the load balancer.
The maximumPercent
parameter represents an upper limit on the number of running tasks during a deployment, which enables you to define the deployment batch size. For example, if desiredCount
is four tasks, a maximum of 200% starts four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available).
When UpdateService stops a task during a deployment, the equivalent of docker stop
is issued to the containers running in the task. This results in a SIGTERM
and a 30-second timeout, after which SIGKILL
is sent and the containers are forcibly stopped. If the container handles the SIGTERM
gracefully and exits within 30 seconds from receiving it, no SIGKILL
is sent.
When the service scheduler launches new tasks, it determines task placement in your cluster with the following logic:
Determine which of the container instances in your cluster can support your service\'s task definition (for example, they have the required CPU, memory, ports, and container instance attributes).
By default, the service scheduler attempts to balance tasks across Availability Zones in this manner (although you can choose a different placement strategy):
Sort the valid container instances by the fewest number of running tasks for this service in the same Availability Zone as the instance. For example, if zone A has one running service task and zones B and C each have zero, valid container instances in either zone B or C are considered optimal for placement.
Place the new service task on a valid container instance in an optimal Availability Zone (based on the previous steps), favoring container instances with the fewest number of running tasks for this service.
When the service scheduler stops running tasks, it attempts to maintain balance across the Availability Zones in your cluster using the following logic:
Sort the container instances by the largest number of running tasks for this service in the same Availability Zone as the instance. For example, if zone A has one running service task and zones B and C each have two, container instances in either zone B or C are considered optimal for termination.
Stop the task on a container instance in an optimal Availability Zone (based on the previous steps), favoring container instances with the largest number of running tasks for this service.
You do not have authorization to perform the requested action.
', 'refs' => [], ], 'AgentUpdateStatus' => [ 'base' => NULL, 'refs' => [ 'ContainerInstance$agentUpdateStatus' => 'The status of the most recent agent update. If an update has never been requested, this value is NULL
.
Whether the task\'s elastic network interface receives a public IP address. The default value is DISABLED
.
An object representing a container instance or task attachment.
', 'refs' => [ 'Attachments$member' => NULL, ], ], 'AttachmentDetails' => [ 'base' => NULL, 'refs' => [ 'Attachment$details' => 'Details of the attachment. For elastic network interfaces, this includes the network interface ID, the MAC address, the subnet ID, and the private IPv4 address.
', ], ], 'AttachmentStateChange' => [ 'base' => 'An object representing a change in state for a task attachment.
', 'refs' => [ 'AttachmentStateChanges$member' => NULL, ], ], 'AttachmentStateChanges' => [ 'base' => NULL, 'refs' => [ 'SubmitTaskStateChangeRequest$attachments' => 'Any attachments associated with the state change request.
', ], ], 'Attachments' => [ 'base' => NULL, 'refs' => [ 'ContainerInstance$attachments' => 'The elastic network interfaces associated with the container instance.
', 'Task$attachments' => 'The Elastic Network Adapter associated with the task if the task uses the awsvpc
network mode.
An attribute is a name-value pair associated with an Amazon ECS object. Attributes enable you to extend the Amazon ECS data model by adding custom metadata to your resources. For more information, see Attributes in the Amazon Elastic Container Service Developer Guide.
', 'refs' => [ 'Attributes$member' => NULL, 'RequiresAttributes$member' => NULL, ], ], 'AttributeLimitExceededException' => [ 'base' => 'You can apply up to 10 custom attributes per resource. You can view the attributes of a resource with ListAttributes. You can remove existing attributes on a resource with DeleteAttributes.
', 'refs' => [], ], 'Attributes' => [ 'base' => NULL, 'refs' => [ 'ContainerInstance$attributes' => 'The attributes set for the container instance, either by the Amazon ECS container agent at instance registration or manually with the PutAttributes operation.
', 'DeleteAttributesRequest$attributes' => 'The attributes to delete from your resource. You can specify up to 10 attributes per request. For custom attributes, specify the attribute name and target ID, but do not specify the value. If you specify the target ID using the short form, you must also specify the target type.
', 'DeleteAttributesResponse$attributes' => 'A list of attribute objects that were successfully deleted from your resource.
', 'ListAttributesResponse$attributes' => 'A list of attribute objects that meet the criteria of the request.
', 'PutAttributesRequest$attributes' => 'The attributes to apply to your resource. You can specify up to 10 custom attributes per resource. You can specify up to 10 attributes in a single call.
', 'PutAttributesResponse$attributes' => 'The attributes applied to your resource.
', 'RegisterContainerInstanceRequest$attributes' => 'The container instance attributes that this container instance supports.
', ], ], 'AwsVpcConfiguration' => [ 'base' => 'An object representing the networking details for a task or service.
', 'refs' => [ 'NetworkConfiguration$awsvpcConfiguration' => 'The VPC subnets and security groups associated with a task.
All specified subnets and security groups must be from the same VPC.
Your AWS account has been blocked. For more information, contact AWS Support.
', 'refs' => [], ], 'Boolean' => [ 'base' => NULL, 'refs' => [ 'ContainerInstance$agentConnected' => 'This parameter returns true
if the agent is connected to Amazon ECS. Registered instances with an agent that may be unhealthy or stopped return false
. Only instances connected to an agent can accept placement requests.
Specifies whether to enable Amazon ECS managed tags for the tasks within the service. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.
', 'ListAccountSettingsRequest$effectiveSettings' => 'Specifies whether to return the effective settings. If true
, the account settings for the root user or the default setting for the principalArn
. If false
, the account settings for the principalArn
are returned if they are set. Otherwise, no account settings are returned.
Specifies whether to enable Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.
', 'Service$enableECSManagedTags' => 'Specifies whether to enable Amazon ECS managed tags for the tasks in the service. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.
', 'StartTaskRequest$enableECSManagedTags' => 'Specifies whether to enable Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.
', 'UpdateServiceRequest$forceNewDeployment' => 'Whether to force a new deployment of the service. Deployments are not forced by default. You can use this option to trigger a new deployment with no service definition changes. For example, you can update a service\'s tasks to use a newer Docker image with the same image/tag combination (my_image:latest
) or to roll Fargate tasks onto a newer platform version.
If the essential
parameter of a container is marked as true
, and that container fails or stops for any reason, all other containers that are part of the task are stopped. If the essential
parameter of a container is marked as false
, then its failure does not affect the rest of the containers in a task. If this parameter is omitted, a container is assumed to be essential.
All tasks must have at least one essential container. If you have an application that is composed of multiple containers, you should group containers that are used for a common purpose into components, and separate the different components into multiple task definitions. For more information, see Application Architecture in the Amazon Elastic Container Service Developer Guide.
', 'ContainerDefinition$disableNetworking' => 'When this parameter is true, networking is disabled within the container. This parameter maps to NetworkDisabled
in the Create a container section of the Docker Remote API.
This parameter is not supported for Windows containers.
When this parameter is true, the container is given elevated privileges on the host container instance (similar to the root
user). This parameter maps to Privileged
in the Create a container section of the Docker Remote API and the --privileged
option to docker run.
This parameter is not supported for Windows containers or tasks using the Fargate launch type.
When this parameter is true, the container is given read-only access to its root file system. This parameter maps to ReadonlyRootfs
in the Create a container section of the Docker Remote API and the --read-only
option to docker run.
This parameter is not supported for Windows containers.
When this parameter is true
, this allows you to deploy containerized applications that require stdin
or a tty
to be allocated. This parameter maps to OpenStdin
in the Create a container section of the Docker Remote API and the --interactive
option to docker run.
When this parameter is true
, a TTY is allocated. This parameter maps to Tty
in the Create a container section of the Docker Remote API and the --tty
option to docker run.
If true
, allows you to delete a service even if it has not been scaled down to zero tasks. It is only necessary to use this if the service is using the REPLICA
scheduling strategy.
Forces the deregistration of the container instance. If you have tasks running on the container instance when you deregister it with the force
option, these tasks remain running until you terminate the instance or the tasks stop through some other means, but they are orphaned (no longer monitored or accounted for by Amazon ECS). If an orphaned task on your container instance is part of an Amazon ECS service, then the service scheduler starts another copy of that task, on a different container instance if possible.
Any containers in orphaned service tasks that are registered with a Classic Load Balancer or an Application Load Balancer target group are deregistered. They begin connection draining according to the settings on the load balancer or target group.
', 'DockerVolumeConfiguration$autoprovision' => 'If this value is true
, the Docker volume is created if it does not already exist.
This field is only used if the scope
is shared
.
Run an init
process inside the container that forwards signals and reaps processes. This parameter maps to the --init
option to docker run. This parameter requires version 1.25 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format \'{{.Server.APIVersion}}\'
If this value is true
, the container has read-only access to the volume. If this value is false
, then the container can write to the volume. The default value is false
.
If this value is true
, the container has read-only access to the volume. If this value is false
, then the container can write to the volume. The default value is false
.
The exit code returned from the container.
', 'ContainerDefinition$memory' => 'The hard limit (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. This parameter maps to Memory
in the Create a container section of the Docker Remote API and the --memory
option to docker run.
If your containers are part of a task using the Fargate launch type, this field is optional and the only requirement is that the total amount of memory reserved for all containers within a task be lower than the task memory
value.
For containers that are part of a task using the EC2 launch type, you must specify a non-zero integer for one or both of memory
or memoryReservation
in container definitions. If you specify both, memory
must be greater than memoryReservation
. If you specify memoryReservation
, then that value is subtracted from the available memory resources for the container instance on which the container is placed. Otherwise, the value of memory
is used.
The Docker daemon reserves a minimum of 4 MiB of memory for a container, so you should not specify fewer than 4 MiB of memory for your containers.
', 'ContainerDefinition$memoryReservation' => 'The soft limit (in MiB) of memory to reserve for the container. When system memory is under heavy contention, Docker attempts to keep the container memory to this soft limit. However, your container can consume more memory when it needs to, up to either the hard limit specified with the memory
parameter (if applicable), or all of the available memory on the container instance, whichever comes first. This parameter maps to MemoryReservation
in the Create a container section of the Docker Remote API and the --memory-reservation
option to docker run.
You must specify a non-zero integer for one or both of memory
or memoryReservation
in container definitions. If you specify both, memory
must be greater than memoryReservation
. If you specify memoryReservation
, then that value is subtracted from the available memory resources for the container instance on which the container is placed. Otherwise, the value of memory
is used.
For example, if your container normally uses 128 MiB of memory, but occasionally bursts to 256 MiB of memory for short periods of time, you can set a memoryReservation
of 128 MiB, and a memory
hard limit of 300 MiB. This configuration would allow the container to only reserve 128 MiB of memory from the remaining resources on the container instance, but also allow the container to consume more memory resources when needed.
The Docker daemon reserves a minimum of 4 MiB of memory for a container, so you should not specify fewer than 4 MiB of memory for your containers.
', 'ContainerOverride$cpu' => 'The number of cpu
units reserved for the container, instead of the default value from the task definition. You must also specify a container name.
The hard limit (in MiB) of memory to present to the container, instead of the default value from the task definition. If your container attempts to exceed the memory specified here, the container is killed. You must also specify a container name.
', 'ContainerOverride$memoryReservation' => 'The soft limit (in MiB) of memory to reserve for the container, instead of the default value from the task definition. You must also specify a container name.
', 'ContainerStateChange$exitCode' => 'The exit code for the container, if the state change is a result of the container exiting.
', 'CreateServiceRequest$desiredCount' => 'The number of instantiations of the specified task definition to place and keep running on your cluster.
', 'CreateServiceRequest$healthCheckGracePeriodSeconds' => 'The period of time, in seconds, that the Amazon ECS service scheduler should ignore unhealthy Elastic Load Balancing target health checks after a task has first started. This is only valid if your service is configured to use a load balancer. If your service\'s tasks take a while to start and respond to Elastic Load Balancing health checks, you can specify a health check grace period of up to 7,200 seconds. During that time, the ECS service scheduler ignores health check status. This grace period can prevent the ECS service scheduler from marking tasks as unhealthy and stopping them before they have time to come up.
', 'DeploymentConfiguration$maximumPercent' => 'If a service is using the rolling update (ECS
) deployment type, the maximum percent parameter represents an upper limit on the number of tasks in a service that are allowed in the RUNNING
or PENDING
state during a deployment, as a percentage of the desired number of tasks (rounded down to the nearest integer), and while any container instances are in the DRAINING
state if the service contains tasks using the EC2 launch type. This parameter enables you to define the deployment batch size. For example, if your service has a desired number of four tasks and a maximum percent value of 200%, the scheduler may start four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available). The default value for maximum percent is 200%.
If a service is using the blue/green (CODE_DEPLOY
) deployment type and tasks that use the EC2 launch type, the maximum percent value is set to the default value and is used to define the upper limit on the number of the tasks in the service that remain in the RUNNING
state while the container instances are in the DRAINING
state. If the tasks in the service use the Fargate launch type, the maximum percent value is not used, although it is returned when describing your service.
If a service is using the rolling update (ECS
) deployment type, the minimum healthy percent represents a lower limit on the number of tasks in a service that must remain in the RUNNING
state during a deployment, as a percentage of the desired number of tasks (rounded up to the nearest integer), and while any container instances are in the DRAINING
state if the service contains tasks using the EC2 launch type. This parameter enables you to deploy without using additional cluster capacity. For example, if your service has a desired number of four tasks and a minimum healthy percent of 50%, the scheduler may stop two existing tasks to free up cluster capacity before starting two new tasks. Tasks for services that do not use a load balancer are considered healthy if they are in the RUNNING
state; tasks for services that do use a load balancer are considered healthy if they are in the RUNNING
state and they are reported as healthy by the load balancer. The default value for minimum healthy percent is 100%.
If a service is using the blue/green (CODE_DEPLOY
) deployment type and tasks that use the EC2 launch type, the minimum healthy percent value is set to the default value and is used to define the lower limit on the number of the tasks in the service that remain in the RUNNING
state while the container instances are in the DRAINING
state. If the tasks in the service use the Fargate launch type, the minimum healthy percent value is not used, although it is returned when describing your service.
The time period in seconds between each health check execution. You may specify between 5 and 300 seconds. The default value is 30 seconds.
', 'HealthCheck$timeout' => 'The time period in seconds to wait for a health check to succeed before it is considered a failure. You may specify between 2 and 60 seconds. The default value is 5.
', 'HealthCheck$retries' => 'The number of times to retry a failed health check before the container is considered unhealthy. You may specify between 1 and 10 retries. The default value is 3.
', 'HealthCheck$startPeriod' => 'The optional grace period within which to provide containers time to bootstrap before failed health checks count towards the maximum number of retries. You may specify between 0 and 300 seconds. The startPeriod
is disabled by default.
If a health check succeeds within the startPeriod
, then the container is considered healthy and any subsequent failures count toward the maximum number of retries.
The value for the size (in MiB) of the /dev/shm
volume. This parameter maps to the --shm-size
option to docker run.
If you are using tasks that use the Fargate launch type, the sharedMemorySize
parameter is not supported.
The maximum number of cluster results returned by ListAttributes
in paginated output. When this parameter is used, ListAttributes
only returns maxResults
results in a single page along with a nextToken
response element. The remaining results of the initial request can be seen by sending another ListAttributes
request with the returned nextToken
value. This value can be between 1 and 100. If this parameter is not used, then ListAttributes
returns up to 100 results and a nextToken
value if applicable.
The maximum number of cluster results returned by ListClusters
in paginated output. When this parameter is used, ListClusters
only returns maxResults
results in a single page along with a nextToken
response element. The remaining results of the initial request can be seen by sending another ListClusters
request with the returned nextToken
value. This value can be between 1 and 100. If this parameter is not used, then ListClusters
returns up to 100 results and a nextToken
value if applicable.
The maximum number of container instance results returned by ListContainerInstances
in paginated output. When this parameter is used, ListContainerInstances
only returns maxResults
results in a single page along with a nextToken
response element. The remaining results of the initial request can be seen by sending another ListContainerInstances
request with the returned nextToken
value. This value can be between 1 and 100. If this parameter is not used, then ListContainerInstances
returns up to 100 results and a nextToken
value if applicable.
The maximum number of service results returned by ListServices
in paginated output. When this parameter is used, ListServices
only returns maxResults
results in a single page along with a nextToken
response element. The remaining results of the initial request can be seen by sending another ListServices
request with the returned nextToken
value. This value can be between 1 and 100. If this parameter is not used, then ListServices
returns up to 10 results and a nextToken
value if applicable.
The maximum number of task definition family results returned by ListTaskDefinitionFamilies
in paginated output. When this parameter is used, ListTaskDefinitions
only returns maxResults
results in a single page along with a nextToken
response element. The remaining results of the initial request can be seen by sending another ListTaskDefinitionFamilies
request with the returned nextToken
value. This value can be between 1 and 100. If this parameter is not used, then ListTaskDefinitionFamilies
returns up to 100 results and a nextToken
value if applicable.
The maximum number of task definition results returned by ListTaskDefinitions
in paginated output. When this parameter is used, ListTaskDefinitions
only returns maxResults
results in a single page along with a nextToken
response element. The remaining results of the initial request can be seen by sending another ListTaskDefinitions
request with the returned nextToken
value. This value can be between 1 and 100. If this parameter is not used, then ListTaskDefinitions
returns up to 100 results and a nextToken
value if applicable.
The maximum number of task results returned by ListTasks
in paginated output. When this parameter is used, ListTasks
only returns maxResults
results in a single page along with a nextToken
response element. The remaining results of the initial request can be seen by sending another ListTasks
request with the returned nextToken
value. This value can be between 1 and 100. If this parameter is not used, then ListTasks
returns up to 100 results and a nextToken
value if applicable.
The port on the container to associate with the load balancer. This port must correspond to a containerPort
in the service\'s task definition. Your container instances must allow ingress traffic on the hostPort
of the port mapping.
The port number on the container that is used with the network binding.
', 'NetworkBinding$hostPort' => 'The port number on the host that is used with the network binding.
', 'PortMapping$containerPort' => 'The port number on the container that is bound to the user-specified or automatically assigned host port.
If you are using containers in a task with the awsvpc
or host
network mode, exposed ports should be specified using containerPort
.
If you are using containers in a task with the bridge
network mode and you specify a container port and not a host port, your container automatically receives a host port in the ephemeral port range. For more information, see hostPort
. Port mappings that are automatically assigned in this way do not count toward the 100 reserved ports limit of a container instance.
The port number on the container instance to reserve for your container.
If you are using containers in a task with the awsvpc
or host
network mode, the hostPort
can either be left blank or set to the same value as the containerPort
.
If you are using containers in a task with the bridge
network mode, you can specify a non-reserved host port for your container port mapping, or you can omit the hostPort
(or set it to 0
) while specifying a containerPort
and your container automatically receives a port in the ephemeral port range for your container instance operating system and Docker version.
The default ephemeral port range for Docker version 1.6.0 and later is listed on the instance under /proc/sys/net/ipv4/ip_local_port_range
. If this kernel parameter is unavailable, the default ephemeral port range from 49153 through 65535 is used. Do not attempt to specify a host port in the ephemeral port range as these are reserved for automatic assignment. In general, ports below 32768 are outside of the ephemeral port range.
The default ephemeral port range from 49153 through 65535 is always used for Docker versions before 1.6.0.
The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the Amazon ECS container agent ports 51678 and 51679. Any host port that was previously specified in a running task is also reserved while the task is running (after a task stops, the host port is released). The current reserved ports are displayed in the remainingResources
of DescribeContainerInstances output. A container instance may have up to 100 reserved ports at a time, including the default reserved ports. Aautomatically assigned ports do not count toward the 100 reserved ports limit.
The number of instantiations of the specified task to place on your cluster. You can specify up to 10 tasks per call.
', 'Service$healthCheckGracePeriodSeconds' => 'The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks after a task has first started.
', 'ServiceRegistry$port' => 'The port value used if your service discovery service specified an SRV record. This field may be used if both the awsvpc
network mode and SRV records are used.
The port value, already specified in the task definition, to be used for your service discovery service. If the task definition your service task specifies uses the bridge
or host
network mode, you must specify a containerName
and containerPort
combination from the task definition. If the task definition your service task specifies uses the awsvpc
network mode and a type SRV DNS record is used, you must specify either a containerName
and containerPort
combination or a port
value, but not both.
The exit code returned for the state change request.
', 'UpdateServiceRequest$desiredCount' => 'The number of instantiations of the task to place and keep running in your service.
', 'UpdateServiceRequest$healthCheckGracePeriodSeconds' => 'The period of time, in seconds, that the Amazon ECS service scheduler should ignore unhealthy Elastic Load Balancing target health checks after a task has first started. This is only valid if your service is configured to use a load balancer. If your service\'s tasks take a while to start and respond to Elastic Load Balancing health checks, you can specify a health check grace period of up to 1,800 seconds. During that time, the ECS service scheduler ignores the Elastic Load Balancing health check status. This grace period can prevent the ECS service scheduler from marking tasks as unhealthy and stopping them before they have time to come up.
', ], ], 'ClientException' => [ 'base' => 'These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn\'t have permissions to use the action or resource, or specifying an identifier that is not valid.
', 'refs' => [], ], 'Cluster' => [ 'base' => 'A regional grouping of one or more container instances on which you can run task requests. Each account receives a default cluster the first time you use the Amazon ECS service, but you may also create other clusters. Clusters may contain more than one instance type simultaneously.
', 'refs' => [ 'Clusters$member' => NULL, 'CreateClusterResponse$cluster' => 'The full description of your new cluster.
', 'DeleteClusterResponse$cluster' => 'The full description of the deleted cluster.
', ], ], 'ClusterContainsContainerInstancesException' => [ 'base' => 'You cannot delete a cluster that has registered container instances. First, deregister the container instances before you can delete the cluster. For more information, see DeregisterContainerInstance.
', 'refs' => [], ], 'ClusterContainsServicesException' => [ 'base' => 'You cannot delete a cluster that contains services. First, update the service to reduce its desired task count to 0 and then delete the service. For more information, see UpdateService and DeleteService.
', 'refs' => [], ], 'ClusterContainsTasksException' => [ 'base' => 'You cannot delete a cluster that has active tasks.
', 'refs' => [], ], 'ClusterField' => [ 'base' => NULL, 'refs' => [ 'ClusterFieldList$member' => NULL, ], ], 'ClusterFieldList' => [ 'base' => NULL, 'refs' => [ 'DescribeClustersRequest$include' => 'Additional information about your clusters to be separated by launch type, including:
runningEC2TasksCount
runningFargateTasksCount
pendingEC2TasksCount
pendingFargateTasksCount
activeEC2ServiceCount
activeFargateServiceCount
drainingEC2ServiceCount
drainingFargateServiceCount
The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region-specific.
', 'refs' => [], ], 'Clusters' => [ 'base' => NULL, 'refs' => [ 'DescribeClustersResponse$clusters' => 'The list of clusters.
', ], ], 'Compatibility' => [ 'base' => NULL, 'refs' => [ 'CompatibilityList$member' => NULL, ], ], 'CompatibilityList' => [ 'base' => NULL, 'refs' => [ 'RegisterTaskDefinitionRequest$requiresCompatibilities' => 'The launch type required by the task. If no value is specified, it defaults to EC2
.
The launch type to use with your task. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.
', 'TaskDefinition$requiresCompatibilities' => 'The launch type that the task is using.
', ], ], 'Connectivity' => [ 'base' => NULL, 'refs' => [ 'Task$connectivity' => 'The connectivity status of a task.
', ], ], 'Container' => [ 'base' => 'A Docker container that is part of a task.
', 'refs' => [ 'Containers$member' => NULL, ], ], 'ContainerDefinition' => [ 'base' => 'Container definitions are used in task definitions to describe the different containers that are launched as part of a task.
', 'refs' => [ 'ContainerDefinitions$member' => NULL, ], ], 'ContainerDefinitions' => [ 'base' => NULL, 'refs' => [ 'RegisterTaskDefinitionRequest$containerDefinitions' => 'A list of container definitions in JSON format that describe the different containers that make up your task.
', 'TaskDefinition$containerDefinitions' => 'A list of container definitions in JSON format that describe the different containers that make up your task. For more information about container definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon Elastic Container Service Developer Guide.
', ], ], 'ContainerInstance' => [ 'base' => 'An EC2 instance that is running the Amazon ECS agent and has been registered with a cluster.
', 'refs' => [ 'ContainerInstances$member' => NULL, 'DeregisterContainerInstanceResponse$containerInstance' => 'The container instance that was deregistered.
', 'RegisterContainerInstanceResponse$containerInstance' => 'The container instance that was registered.
', 'UpdateContainerAgentResponse$containerInstance' => 'The container instance for which the container agent was updated.
', ], ], 'ContainerInstanceField' => [ 'base' => NULL, 'refs' => [ 'ContainerInstanceFieldList$member' => NULL, ], ], 'ContainerInstanceFieldList' => [ 'base' => NULL, 'refs' => [ 'DescribeContainerInstancesRequest$include' => 'Specifies whether you want to see the resource tags for the container instance. If TAGS
is specified, the tags are included in the response. If this field is omitted, tags are not included in the response.
Filters the container instances by status. For example, if you specify the DRAINING
status, the results include only container instances that have been set to DRAINING
using UpdateContainerInstancesState. If you do not specify this parameter, the default is to include container instances set to ACTIVE
and DRAINING
.
The container instance state with which to update the container instance.
', ], ], 'ContainerInstances' => [ 'base' => NULL, 'refs' => [ 'DescribeContainerInstancesResponse$containerInstances' => 'The list of container instances.
', 'UpdateContainerInstancesStateResponse$containerInstances' => 'The list of container instances.
', ], ], 'ContainerOverride' => [ 'base' => 'The overrides that should be sent to a container.
', 'refs' => [ 'ContainerOverrides$member' => NULL, ], ], 'ContainerOverrides' => [ 'base' => NULL, 'refs' => [ 'TaskOverride$containerOverrides' => 'One or more container overrides sent to a task.
', ], ], 'ContainerStateChange' => [ 'base' => 'An object representing a change in state for a container.
', 'refs' => [ 'ContainerStateChanges$member' => NULL, ], ], 'ContainerStateChanges' => [ 'base' => NULL, 'refs' => [ 'SubmitTaskStateChangeRequest$containers' => 'Any containers associated with the state change request.
', ], ], 'Containers' => [ 'base' => NULL, 'refs' => [ 'Task$containers' => 'The containers associated with the task.
', ], ], 'CreateClusterRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateClusterResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateServiceRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateServiceResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAccountSettingRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAccountSettingResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAttributesRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAttributesResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteClusterRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteClusterResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteServiceRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteServiceResponse' => [ 'base' => NULL, 'refs' => [], ], 'Deployment' => [ 'base' => 'The details of an Amazon ECS service deployment. This is used when a service uses the CODE_DEPLOY
deployment controller type.
Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
', 'refs' => [ 'CreateServiceRequest$deploymentConfiguration' => 'Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
', 'Service$deploymentConfiguration' => 'Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
', 'UpdateServiceRequest$deploymentConfiguration' => 'Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
', ], ], 'DeploymentController' => [ 'base' => 'The deployment controller to use for the service. For more information, see Amazon ECS Deployment Types in the Amazon Elastic Container Service Developer Guide.
', 'refs' => [ 'CreateServiceRequest$deploymentController' => 'The deployment controller to use for the service.
', 'Service$deploymentController' => 'The deployment controller type the service is using.
', ], ], 'DeploymentControllerType' => [ 'base' => NULL, 'refs' => [ 'DeploymentController$type' => 'The deployment controller type to use.
There are two deployment controller types available:
The rolling update (ECS
) deployment type involves replacing the current running version of the container with the latest version. The number of containers Amazon ECS adds or removes from the service during a rolling update is controlled by adjusting the minimum and maximum number of healthy tasks allowed during a service deployment, as specified in the DeploymentConfiguration.
The blue/green (CODE_DEPLOY
) deployment type uses the blue/green deployment model powered by AWS CodeDeploy, which allows you to verify a new deployment of a service before sending production traffic to it. For more information, see Amazon ECS Deployment Types in the Amazon Elastic Container Service Developer Guide.
The current state of deployments for the service.
', ], ], 'DeregisterContainerInstanceRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeregisterContainerInstanceResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeregisterTaskDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeregisterTaskDefinitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeClustersRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeClustersResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeContainerInstancesRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeContainerInstancesResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeServicesRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeServicesResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTaskDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTaskDefinitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTasksRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTasksResponse' => [ 'base' => NULL, 'refs' => [], ], 'DesiredStatus' => [ 'base' => NULL, 'refs' => [ 'ListTasksRequest$desiredStatus' => 'The task desired status with which to filter the ListTasks
results. Specifying a desiredStatus
of STOPPED
limits the results to tasks that Amazon ECS has set the desired status to STOPPED
. This can be useful for debugging tasks that are not starting properly or have died or finished. The default status filter is RUNNING
, which shows tasks that Amazon ECS has set the desired status to RUNNING
.
Although you can filter results based on a desired status of PENDING
, this does not return any results. Amazon ECS never sets the desired status of a task to that value (only a task\'s lastStatus
may have a value of PENDING
).
An object representing a container instance host device.
', 'refs' => [ 'DevicesList$member' => NULL, ], ], 'DeviceCgroupPermission' => [ 'base' => NULL, 'refs' => [ 'DeviceCgroupPermissions$member' => NULL, ], ], 'DeviceCgroupPermissions' => [ 'base' => NULL, 'refs' => [ 'Device$permissions' => 'The explicit permissions to provide to the container for the device. By default, the container has permissions for read
, write
, and mknod
for the device.
Any host devices to expose to the container. This parameter maps to Devices
in the Create a container section of the Docker Remote API and the --device
option to docker run.
If you are using tasks that use the Fargate launch type, the devices
parameter is not supported.
A key/value map of labels to add to the container. This parameter maps to Labels
in the Create a container section of the Docker Remote API and the --label
option to docker run. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format \'{{.Server.APIVersion}}\'
This parameter is specified when you are using Docker volumes. Docker volumes are only supported when you are using the EC2 launch type. Windows containers only support the use of the local
driver. To use bind mounts, specify a host
instead.
This parameter is specified when you are using Docker volumes. Docker volumes are only supported when you are using the EC2 launch type. Windows containers only support the use of the local
driver. To use bind mounts, specify a host
instead.
When the doubleValue
type is set, the value of the resource must be a double precision floating-point type.
The value, specified as a percent total of a service\'s desiredCount
, to scale the task set.
The environment variables to pass to a container. This parameter maps to Env
in the Create a container section of the Docker Remote API and the --env
option to docker run.
We do not recommend using plaintext environment variables for sensitive information, such as credential data.
The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the task definition. You must also specify a container name.
', ], ], 'Failure' => [ 'base' => 'A failed resource.
', 'refs' => [ 'Failures$member' => NULL, ], ], 'Failures' => [ 'base' => NULL, 'refs' => [ 'DescribeClustersResponse$failures' => 'Any failures associated with the call.
', 'DescribeContainerInstancesResponse$failures' => 'Any failures associated with the call.
', 'DescribeServicesResponse$failures' => 'Any failures associated with the call.
', 'DescribeTasksResponse$failures' => 'Any failures associated with the call.
', 'RunTaskResponse$failures' => 'Any failures associated with the call.
', 'StartTaskResponse$failures' => 'Any failures associated with the call.
', 'UpdateContainerInstancesStateResponse$failures' => 'Any failures associated with the call.
', ], ], 'HealthCheck' => [ 'base' => 'An object representing a container health check. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image (such as those specified in a parent image or from the image\'s Dockerfile).
The following are notes about container health check support:
Container health checks require version 1.17.0 or greater of the Amazon ECS container agent. For more information, see Updating the Amazon ECS Container Agent.
Container health checks are supported for Fargate tasks if you are using platform version 1.1.0 or greater. For more information, see AWS Fargate Platform Versions.
Container health checks are not supported for tasks that are part of a service that is configured to use a Classic Load Balancer.
The health check command and associated configuration parameters for the container. This parameter maps to HealthCheck
in the Create a container section of the Docker Remote API and the HEALTHCHECK
parameter of docker run.
The health status of the container. If health checks are not configured for this container in its task definition, then it reports the health status as UNKNOWN
.
The health status for the task, which is determined by the health of the essential containers in the task. If all essential containers in the task are reporting as HEALTHY
, then the task status also reports as HEALTHY
. If any essential containers in the task are reporting as UNHEALTHY
or UNKNOWN
, then the task status also reports as UNHEALTHY
or UNKNOWN
, accordingly.
The Amazon ECS container agent does not monitor or report on Docker health checks that are embedded in a container image (such as those specified in a parent image or from the image\'s Dockerfile) and not specified in the container definition. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image.
Hostnames and IP address entries that are added to the /etc/hosts
file of a container via the extraHosts
parameter of its ContainerDefinition.
A list of hostnames and IP address mappings to append to the /etc/hosts
file on the container. This parameter maps to ExtraHosts
in the Create a container section of the Docker Remote API and the --add-host
option to docker run.
This parameter is not supported for Windows containers or tasks that use the awsvpc
network mode.
Details on a container instance bind mount host volume.
', 'refs' => [ 'Volume$host' => 'This parameter is specified when you are using bind mount host volumes. Bind mount host volumes are supported when you are using either the EC2 or Fargate launch types. The contents of the host
parameter determine whether your bind mount host volume persists on the host container instance and where it is stored. If the host
parameter is empty, then the Docker daemon assigns a host path for your data volume. However, the data is not guaranteed to persist after the containers associated with it stop running.
Windows containers can mount whole directories on the same drive as $env:ProgramData
. Windows containers cannot mount directories on a different drive, and mount point cannot be across drives. For example, you can mount C:\\my\\path:C:\\my\\path
and D:\\:D:\\
, but not D:\\my\\path:C:\\my\\path
or D:\\:C:\\my\\path
.
The number of container instances registered into the cluster. This includes container instances in both ACTIVE
and DRAINING
status.
The number of tasks in the cluster that are in the RUNNING
state.
The number of tasks in the cluster that are in the PENDING
state.
The number of services that are running on the cluster in an ACTIVE
state. You can view these services with ListServices.
The number of cpu
units reserved for the container. This parameter maps to CpuShares
in the Create a container section of the Docker Remote API and the --cpu-shares
option to docker run.
This field is optional for tasks using the Fargate launch type, and the only requirement is that the total amount of CPU reserved for all containers within a task be lower than the task-level cpu
value.
You can determine the number of CPU units that are available per EC2 instance type by multiplying the vCPUs listed for that instance type on the Amazon EC2 Instances detail page by 1,024.
For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that is the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task would be guaranteed a minimum of 512 CPU units when needed, and each container could float to higher CPU usage if the other container was not using it, but if both tasks were 100% active all of the time, they would be limited to 512 CPU units.
Linux containers share unallocated CPU units with other containers on the container instance with the same ratio as their allocated amount. For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that is the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task would be guaranteed a minimum of 512 CPU units when needed, and each container could float to higher CPU usage if the other container was not using it, but if both tasks were 100% active all of the time, they would be limited to 512 CPU units.
On Linux container instances, the Docker daemon on the container instance uses the CPU value to calculate the relative CPU share ratios for running containers. For more information, see CPU share constraint in the Docker documentation. The minimum valid CPU share value that the Linux kernel allows is 2. However, the CPU parameter is not required, and you can use CPU values below 2 in your container definitions. For CPU values below 2 (including null), the behavior varies based on your Amazon ECS container agent version:
Agent versions less than or equal to 1.1.0: Null and zero CPU values are passed to Docker as 0, which Docker then converts to 1,024 CPU shares. CPU values of 1 are passed to Docker as 1, which the Linux kernel converts to two CPU shares.
Agent versions greater than or equal to 1.2.0: Null, zero, and CPU values of 1 are passed to Docker as 2.
On Windows container instances, the CPU limit is enforced as an absolute limit, or a quota. Windows containers only have access to the specified amount of CPU that is described in the task definition.
', 'ContainerInstance$runningTasksCount' => 'The number of tasks on the container instance that are in the RUNNING
status.
The number of tasks on the container instance that are in the PENDING
status.
The most recent desired count of tasks that was specified for the service to deploy or maintain.
', 'Deployment$pendingCount' => 'The number of tasks in the deployment that are in the PENDING
status.
The number of tasks in the deployment that are in the RUNNING
status.
The maximum number of account setting results returned by ListAccountSettings
in paginated output. When this parameter is used, ListAccountSettings
only returns maxResults
results in a single page along with a nextToken
response element. The remaining results of the initial request can be seen by sending another ListAccountSettings
request with the returned nextToken
value. This value can be between 1 and 10. If this parameter is not used, then ListAccountSettings
returns up to 10 results and a nextToken
value if applicable.
When the integerValue
type is set, the value of the resource must be an integer.
The desired number of instantiations of the task definition to keep running on the service. This value is specified when the service is created with CreateService, and it can be modified with UpdateService.
', 'Service$runningCount' => 'The number of tasks in the cluster that are in the RUNNING
state.
The number of tasks in the cluster that are in the PENDING
state.
The revision of the task in a particular family. The revision is a version number of a task definition in a family. When you register a task definition for the first time, the revision is 1
. Each time that you register a new revision of a task definition in the same family, the revision value always increases by one, even if you have deregistered previous revisions in this family.
The computed desired count for the task set. This is calculated by multiplying the service\'s desiredCount
by the task set\'s scale
percentage.
The number of tasks in the task set that are in the PENDING
status during a deployment. A task in the PENDING
state is preparing to enter the RUNNING
state. A task set enters the PENDING
status when it launches for the first time, or when it is restarted after being in the STOPPED
state.
The number of tasks in the task set that are in the RUNNING
status during a deployment. A task in the RUNNING
state is running and ready for use.
The size (in MiB) of the tmpfs volume.
', 'Ulimit$softLimit' => 'The soft limit for the ulimit type.
', 'Ulimit$hardLimit' => 'The hard limit for the ulimit type.
', ], ], 'InvalidParameterException' => [ 'base' => 'The specified parameter is invalid. Review the available parameters for the API request.
', 'refs' => [], ], 'IpcMode' => [ 'base' => NULL, 'refs' => [ 'RegisterTaskDefinitionRequest$ipcMode' => 'The IPC resource namespace to use for the containers in the task. The valid values are host
, task
, or none
. If host
is specified, then all containers within the tasks that specified the host
IPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. If task
is specified, all containers within the specified task share the same IPC resources. If none
is specified, then IPC resources within the containers of a task are private and not shared with other containers in a task or on the container instance. If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance. For more information, see IPC settings in the Docker run reference.
If the host
IPC mode is used, be aware that there is a heightened risk of undesired IPC namespace expose. For more information, see Docker security.
If you are setting namespaced kernel parameters using systemControls
for the containers in the task, the following will apply to your IPC resource namespace. For more information, see System Controls in the Amazon Elastic Container Service Developer Guide.
For tasks that use the host
IPC mode, IPC namespace related systemControls
are not supported.
For tasks that use the task
IPC mode, IPC namespace related systemControls
will apply to all containers within a task.
This parameter is not supported for Windows containers or tasks using the Fargate launch type.
The IPC resource namespace to use for the containers in the task. The valid values are host
, task
, or none
. If host
is specified, then all containers within the tasks that specified the host
IPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. If task
is specified, all containers within the specified task share the same IPC resources. If none
is specified, then IPC resources within the containers of a task are private and not shared with other containers in a task or on the container instance. If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance. For more information, see IPC settings in the Docker run reference.
If the host
IPC mode is used, be aware that there is a heightened risk of undesired IPC namespace expose. For more information, see Docker security.
If you are setting namespaced kernel parameters using systemControls
for the containers in the task, the following will apply to your IPC resource namespace. For more information, see System Controls in the Amazon Elastic Container Service Developer Guide.
For tasks that use the host
IPC mode, IPC namespace related systemControls
are not supported.
For tasks that use the task
IPC mode, IPC namespace related systemControls
will apply to all containers within a task.
This parameter is not supported for Windows containers or tasks using the Fargate launch type.
The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker. For more information on the default capabilities and the non-default available capabilities, see Runtime privilege and Linux capabilities in the Docker run reference. For more detailed information on these Linux capabilities, see the capabilities(7) Linux manual page.
', 'refs' => [ 'LinuxParameters$capabilities' => 'The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker.
If you are using tasks that use the Fargate launch type, capabilities
is supported but the add
parameter is not supported.
A key-value pair object.
', 'refs' => [ 'AttachmentDetails$member' => NULL, 'EnvironmentVariables$member' => NULL, 'Statistics$member' => NULL, ], ], 'LaunchType' => [ 'base' => NULL, 'refs' => [ 'CreateServiceRequest$launchType' => 'The launch type on which to run your service. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.
', 'Deployment$launchType' => 'The launch type the tasks in the service are using. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.
', 'ListServicesRequest$launchType' => 'The launch type for the services to list.
', 'ListTasksRequest$launchType' => 'The launch type for services to list.
', 'RunTaskRequest$launchType' => 'The launch type on which to run your task. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.
', 'Service$launchType' => 'The launch type on which your service is running. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.
', 'Task$launchType' => 'The launch type on which your task is running. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.
', 'TaskSet$launchType' => 'The launch type the tasks in the task set are using. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.
', ], ], 'LinuxParameters' => [ 'base' => 'Linux-specific options that are applied to the container, such as Linux KernelCapabilities.
', 'refs' => [ 'ContainerDefinition$linuxParameters' => 'Linux-specific modifications that are applied to the container, such as Linux KernelCapabilities.
This parameter is not supported for Windows containers.
Details on a load balancer that is used with a service.
If the service is using the ECS
deployment controller, you are limited to one load balancer or target group.
If the service is using the CODE_DEPLOY
deployment controller, the service is required to use either an Application Load Balancer or Network Load Balancer. When you are creating an AWS CodeDeploy deployment group, you specify two target groups (referred to as a targetGroupPair
). Each target group binds to a separate task set in the deployment. The load balancer can also have up to two listeners, a required listener for production traffic and an optional listener that allows you to test new revisions of the service before routing production traffic to it.
Services with tasks that use the awsvpc
network mode (for example, those with the Fargate launch type) only support Application Load Balancers and Network Load Balancers. Classic Load Balancers are not supported. Also, when you create any target groups for these services, you must choose ip
as the target type, not instance
. Tasks that use the awsvpc
network mode are associated with an elastic network interface, not an Amazon EC2 instance.
A load balancer object representing the load balancer to use with your service.
If the service is using the ECS
deployment controller, you are limited to one load balancer or target group.
If the service is using the CODE_DEPLOY
deployment controller, the service is required to use either an Application Load Balancer or Network Load Balancer. When creating an AWS CodeDeploy deployment group, you specify two target groups (referred to as a targetGroupPair
). During a deployment, AWS CodeDeploy determines which task set in your service has the status PRIMARY
and associates one target group with it, and then associates the other target group with the replacement task set. The load balancer can also have up to two listeners: a required listener for production traffic and an optional listener that allows you perform validation tests with Lambda functions before routing production traffic to it.
After you create a service using the ECS
deployment controller, the load balancer name or target group ARN, container name, and container port specified in the service definition are immutable. If you are using the CODE_DEPLOY
deployment controller, these values can be changed when updating the service.
For Classic Load Balancers, this object must contain the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer. When a task from this service is placed on a container instance, the container instance is registered with the load balancer specified here.
For Application Load Balancers and Network Load Balancers, this object must contain the load balancer target group ARN, the container name (as it appears in a container definition), and the container port to access from the load balancer. When a task from this service is placed on a container instance, the container instance and port combination is registered as a target in the target group specified here.
Services with tasks that use the awsvpc
network mode (for example, those with the Fargate launch type) only support Application Load Balancers and Network Load Balancers. Classic Load Balancers are not supported. Also, when you create any target groups for these services, you must choose ip
as the target type, not instance
, because tasks that use the awsvpc
network mode are associated with an elastic network interface, not an Amazon EC2 instance.
A list of Elastic Load Balancing load balancer objects, containing the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer.
Services with tasks that use the awsvpc
network mode (for example, those with the Fargate launch type) only support Application Load Balancers and Network Load Balancers. Classic Load Balancers are not supported. Also, when you create any target groups for these services, you must choose ip
as the target type, not instance
. Tasks that use the awsvpc
network mode are associated with an elastic network interface, not an Amazon EC2 instance.
Details on a load balancer that is used with a task set.
', ], ], 'LogConfiguration' => [ 'base' => 'Log configuration options to send to a custom log driver for the container.
', 'refs' => [ 'ContainerDefinition$logConfiguration' => 'The log configuration specification for the container.
If you are using the Fargate launch type, the only supported value is awslogs
.
This parameter maps to LogConfig
in the Create a container section of the Docker Remote API and the --log-driver
option to docker run. By default, containers use the same logging driver that the Docker daemon uses. However the container may use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance (or on a different log server for remote logging options). For more information on the options for different supported log drivers, see Configure logging drivers in the Docker documentation.
Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type). Additional log drivers may be available in future releases of the Amazon ECS container agent.
This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format \'{{.Server.APIVersion}}\'
The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the ECS_AVAILABLE_LOGGING_DRIVERS
environment variable before containers placed on that instance can use these log configuration options. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide.
The configuration options to send to the log driver. This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format \'{{.Server.APIVersion}}\'
The log driver to use for the container. The valid values listed for this parameter are log drivers that the Amazon ECS container agent can communicate with by default. If you are using the Fargate launch type, the only supported value is awslogs
. For more information about using the awslogs
driver, see Using the awslogs Log Driver in the Amazon Elastic Container Service Developer Guide.
If you have a custom driver that is not listed above that you would like to work with the Amazon ECS container agent, you can fork the Amazon ECS container agent project that is available on GitHub and customize it to work with that driver. We encourage you to submit pull requests for changes that you would like to have included. However, Amazon Web Services does not currently support running modified copies of this software.
This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format \'{{.Server.APIVersion}}\'
The version counter for the container instance. Every time a container instance experiences a change that triggers a CloudWatch event, the version counter is incremented. If you are replicating your Amazon ECS container instance state with CloudWatch Events, you can compare the version of a container instance reported by the Amazon ECS APIs with the version reported in CloudWatch Events for the container instance (inside the detail
object) to verify that the version in your event stream is current.
When the longValue
type is set, the value of the resource must be an extended precision floating-point type.
The version counter for the task. Every time a task experiences a change that triggers a CloudWatch event, the version counter is incremented. If you are replicating your Amazon ECS task state with CloudWatch Events, you can compare the version of a task reported by the Amazon ECS API actionss with the version reported in CloudWatch Events for the task (inside the detail
object) to verify that the version in your event stream is current.
Amazon ECS is unable to determine the current version of the Amazon ECS container agent on the container instance and does not have enough information to proceed with an update. This could be because the agent running on the container instance is an older or custom version that does not use our version information.
', 'refs' => [], ], 'MountPoint' => [ 'base' => 'Details on a volume mount point that is used in a container definition.
', 'refs' => [ 'MountPointList$member' => NULL, ], ], 'MountPointList' => [ 'base' => NULL, 'refs' => [ 'ContainerDefinition$mountPoints' => 'The mount points for data volumes in your container.
This parameter maps to Volumes
in the Create a container section of the Docker Remote API and the --volume
option to docker run.
Windows containers can mount whole directories on the same drive as $env:ProgramData
. Windows containers cannot mount directories on a different drive, and mount point cannot be across drives.
Details on the network bindings between a container and its host container instance. After a task reaches the RUNNING
status, manual and automatic host and container port assignments are visible in the networkBindings
section of DescribeTasks API responses.
The network bindings associated with the container.
', 'ContainerStateChange$networkBindings' => 'Any network bindings associated with the container.
', 'SubmitContainerStateChangeRequest$networkBindings' => 'The network bindings of the container.
', ], ], 'NetworkConfiguration' => [ 'base' => 'An object representing the network configuration for a task or service.
', 'refs' => [ 'CreateServiceRequest$networkConfiguration' => 'The network configuration for the service. This parameter is required for task definitions that use the awsvpc
network mode to receive their own elastic network interface, and it is not supported for other network modes. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide.
The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the awsvpc
networking mode.
The network configuration for the task. This parameter is required for task definitions that use the awsvpc
network mode to receive their own elastic network interface, and it is not supported for other network modes. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide.
The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the awsvpc
networking mode.
The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the awsvpc
networking mode.
The network configuration for the task set.
', 'UpdateServiceRequest$networkConfiguration' => 'The network configuration for the service. This parameter is required for task definitions that use the awsvpc
network mode to receive their own elastic network interface, and it is not supported for other network modes. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide.
Updating a service to add a subnet to a list of existing subnets does not trigger a service deployment. For example, if your network configuration change is to keep the existing subnets and simply add another subnet to the network configuration, this does not trigger a new service deployment.
An object representing the elastic network interface for tasks that use the awsvpc
network mode.
The network interfaces associated with the container.
', ], ], 'NetworkMode' => [ 'base' => NULL, 'refs' => [ 'RegisterTaskDefinitionRequest$networkMode' => 'The Docker networking mode to use for the containers in the task. The valid values are none
, bridge
, awsvpc
, and host
. The default Docker network mode is bridge
. If you are using the Fargate launch type, the awsvpc
network mode is required. If you are using the EC2 launch type, any network mode can be used. If the network mode is set to none
, you cannot specify port mappings in your container definitions, and the tasks containers do not have external connectivity. The host
and awsvpc
network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by the bridge
mode.
With the host
and awsvpc
network modes, exposed container ports are mapped directly to the corresponding host port (for the host
network mode) or the attached elastic network interface port (for the awsvpc
network mode), so you cannot take advantage of dynamic host port mappings.
If the network mode is awsvpc
, the task is allocated an elastic network interface, and you must specify a NetworkConfiguration value when you create a service or run a task with the task definition. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide.
Currently, only Amazon ECS-optimized AMIs, other Amazon Linux variants with the ecs-init
package, or AWS Fargate infrastructure support the awsvpc
network mode.
If the network mode is host
, you cannot run multiple instantiations of the same task on a single container instance when port mappings are used.
Docker for Windows uses different network modes than Docker for Linux. When you register a task definition with Windows containers, you must not specify a network mode. If you use the console to register a task definition with Windows containers, you must choose the <default>
network mode object.
For more information, see Network settings in the Docker run reference.
', 'TaskDefinition$networkMode' => 'The Docker networking mode to use for the containers in the task. The valid values are none
, bridge
, awsvpc
, and host
. The default Docker network mode is bridge
. If you are using the Fargate launch type, the awsvpc
network mode is required. If you are using the EC2 launch type, any network mode can be used. If the network mode is set to none
, you cannot specify port mappings in your container definitions, and the tasks containers do not have external connectivity. The host
and awsvpc
network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by the bridge
mode.
With the host
and awsvpc
network modes, exposed container ports are mapped directly to the corresponding host port (for the host
network mode) or the attached elastic network interface port (for the awsvpc
network mode), so you cannot take advantage of dynamic host port mappings.
If the network mode is awsvpc
, the task is allocated an elastic network interface, and you must specify a NetworkConfiguration value when you create a service or run a task with the task definition. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide.
Currently, only Amazon ECS-optimized AMIs, other Amazon Linux variants with the ecs-init
package, or AWS Fargate infrastructure support the awsvpc
network mode.
If the network mode is host
, you cannot run multiple instantiations of the same task on a single container instance when port mappings are used.
Docker for Windows uses different network modes than Docker for Linux. When you register a task definition with Windows containers, you must not specify a network mode. If you use the console to register a task definition with Windows containers, you must choose the <default>
network mode object.
For more information, see Network settings in the Docker run reference.
', ], ], 'NoUpdateAvailableException' => [ 'base' => 'There is no update available for this Amazon ECS container agent. This could be because the agent is already running the latest version, or it is so old that there is no update path to the current version.
', 'refs' => [], ], 'PidMode' => [ 'base' => NULL, 'refs' => [ 'RegisterTaskDefinitionRequest$pidMode' => 'The process namespace to use for the containers in the task. The valid values are host
or task
. If host
is specified, then all containers within the tasks that specified the host
PID mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. If task
is specified, all containers within the specified task share the same process namespace. If no value is specified, the default is a private namespace. For more information, see PID settings in the Docker run reference.
If the host
PID mode is used, be aware that there is a heightened risk of undesired process namespace expose. For more information, see Docker security.
This parameter is not supported for Windows containers or tasks using the Fargate launch type.
The process namespace to use for the containers in the task. The valid values are host
or task
. If host
is specified, then all containers within the tasks that specified the host
PID mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. If task
is specified, all containers within the specified task share the same process namespace. If no value is specified, the default is a private namespace. For more information, see PID settings in the Docker run reference.
If the host
PID mode is used, be aware that there is a heightened risk of undesired process namespace expose. For more information, see Docker security.
This parameter is not supported for Windows containers or tasks using the Fargate launch type.
An object representing a constraint on task placement. For more information, see Task Placement Constraints in the Amazon Elastic Container Service Developer Guide.
', 'refs' => [ 'PlacementConstraints$member' => NULL, ], ], 'PlacementConstraintType' => [ 'base' => NULL, 'refs' => [ 'PlacementConstraint$type' => 'The type of constraint. Use distinctInstance
to ensure that each task in a particular group is running on a different container instance. Use memberOf
to restrict the selection to a group of valid candidates. The value distinctInstance
is not supported in task definitions.
An array of placement constraint objects to use for tasks in your service. You can specify a maximum of 10 constraints per task (this limit includes constraints in the task definition and those specified at runtime).
', 'RunTaskRequest$placementConstraints' => 'An array of placement constraint objects to use for the task. You can specify up to 10 constraints per task (including constraints in the task definition and those specified at runtime).
', 'Service$placementConstraints' => 'The placement constraints for the tasks in the service.
', ], ], 'PlacementStrategies' => [ 'base' => NULL, 'refs' => [ 'CreateServiceRequest$placementStrategy' => 'The placement strategy objects to use for tasks in your service. You can specify a maximum of five strategy rules per service.
', 'RunTaskRequest$placementStrategy' => 'The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task.
', 'Service$placementStrategy' => 'The placement strategy that determines how tasks for the service are placed.
', ], ], 'PlacementStrategy' => [ 'base' => 'The task placement strategy for a task or service. For more information, see Task Placement Strategies in the Amazon Elastic Container Service Developer Guide.
', 'refs' => [ 'PlacementStrategies$member' => NULL, ], ], 'PlacementStrategyType' => [ 'base' => NULL, 'refs' => [ 'PlacementStrategy$type' => 'The type of placement strategy. The random
placement strategy randomly places tasks on available candidates. The spread
placement strategy spreads placement across available candidates evenly based on the field
parameter. The binpack
strategy places tasks on available candidates that have the least available amount of the resource that is specified with the field
parameter. For example, if you binpack on memory, a task is placed on the instance with the least amount of remaining memory (but still enough to run the task).
The specified platform version does not satisfy the task definition\'s required capabilities.
', 'refs' => [], ], 'PlatformUnknownException' => [ 'base' => 'The specified platform version does not exist.
', 'refs' => [], ], 'PortMapping' => [ 'base' => 'Port mappings allow containers to access ports on the host container instance to send or receive traffic. Port mappings are specified as part of the container definition.
If you are using containers in a task with the awsvpc
or host
network mode, exposed ports should be specified using containerPort
. The hostPort
can be left blank or it must be the same value as the containerPort
.
After a task reaches the RUNNING
status, manual and automatic host and container port assignments are visible in the networkBindings
section of DescribeTasks API responses.
The list of port mappings for the container. Port mappings allow containers to access ports on the host container instance to send or receive traffic.
For task definitions that use the awsvpc
network mode, you should only specify the containerPort
. The hostPort
can be left blank or it must be the same value as the containerPort
.
Port mappings on Windows use the NetNAT
gateway address rather than localhost
. There is no loopback for port mappings on Windows, so you cannot access a container\'s mapped port from the host itself.
This parameter maps to PortBindings
in the Create a container section of the Docker Remote API and the --publish
option to docker run. If the network mode of a task definition is set to none
, then you can\'t specify port mappings. If the network mode of a task definition is set to host
, then host ports must either be undefined or they must match the container port in the port mapping.
After a task reaches the RUNNING
status, manual and automatic host and container port assignments are visible in the Network Bindings section of a container description for a selected task in the Amazon ECS console. The assignments are also visible in the networkBindings
section DescribeTasks responses.
Specifies whether to propagate the tags from the task definition or the service to the tasks. If no value is specified, the tags are not propagated. Tags can only be propagated to the tasks within the service during service creation. To add tags to a task after service creation, use the TagResource API action.
', 'RunTaskRequest$propagateTags' => 'Specifies whether to propagate the tags from the task definition or the service to the task. If no value is specified, the tags are not propagated.
', 'Service$propagateTags' => 'Specifies whether to propagate the tags from the task definition or the service to the task. If no value is specified, the tags are not propagated.
', 'StartTaskRequest$propagateTags' => 'Specifies whether to propagate the tags from the task definition or the service to the task. If no value is specified, the tags are not propagated.
', ], ], 'PutAccountSettingRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutAccountSettingResponse' => [ 'base' => NULL, 'refs' => [], ], 'PutAttributesRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutAttributesResponse' => [ 'base' => NULL, 'refs' => [], ], 'RegisterContainerInstanceRequest' => [ 'base' => NULL, 'refs' => [], ], 'RegisterContainerInstanceResponse' => [ 'base' => NULL, 'refs' => [], ], 'RegisterTaskDefinitionRequest' => [ 'base' => NULL, 'refs' => [], ], 'RegisterTaskDefinitionResponse' => [ 'base' => NULL, 'refs' => [], ], 'RepositoryCredentials' => [ 'base' => 'The repository credentials for private registry authentication.
', 'refs' => [ 'ContainerDefinition$repositoryCredentials' => 'The private repository authentication credentials to use.
', ], ], 'RequiresAttributes' => [ 'base' => NULL, 'refs' => [ 'TaskDefinition$requiresAttributes' => 'The container instance attributes required by your task. This field is not valid if you are using the Fargate launch type for your task.
', ], ], 'Resource' => [ 'base' => 'Describes the resources available for a container instance.
', 'refs' => [ 'Resources$member' => NULL, ], ], 'ResourceNotFoundException' => [ 'base' => 'The specified resource could not be found.
', 'refs' => [], ], 'Resources' => [ 'base' => NULL, 'refs' => [ 'ContainerInstance$remainingResources' => 'For CPU and memory resource types, this parameter describes the remaining CPU and memory that has not already been allocated to tasks and is therefore available for new tasks. For port resource types, this parameter describes the ports that were reserved by the Amazon ECS container agent (at instance registration time) and any task containers that have reserved port mappings on the host (with the host
or bridge
network mode). Any port that is not specified here is available for new tasks.
For CPU and memory resource types, this parameter describes the amount of each resource that was available on the container instance when the container agent registered it with Amazon ECS. This value represents the total amount of CPU and memory that can be allocated on this container instance to tasks. For port resource types, this parameter describes the ports that were reserved by the Amazon ECS container agent when it registered the container instance with Amazon ECS.
', 'RegisterContainerInstanceRequest$totalResources' => 'The resources available on the instance.
', ], ], 'RunTaskRequest' => [ 'base' => NULL, 'refs' => [], ], 'RunTaskResponse' => [ 'base' => NULL, 'refs' => [], ], 'Scale' => [ 'base' => 'A floating-point percentage of the desired number of tasks to place and keep running in the service. This is used when a service uses the CODE_DEPLOY
deployment controller type.
A floating-point percentage of the desired number of tasks to place and keep running in the service.
', ], ], 'ScaleUnit' => [ 'base' => NULL, 'refs' => [ 'Scale$unit' => 'The unit of measure for the scale value.
', ], ], 'SchedulingStrategy' => [ 'base' => NULL, 'refs' => [ 'CreateServiceRequest$schedulingStrategy' => 'The scheduling strategy to use for the service. For more information, see Services.
There are two service scheduler strategies available:
REPLICA
-The replica scheduling strategy places and maintains the desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions. This scheduler strategy is required if using the CODE_DEPLOY
deployment controller.
DAEMON
-The daemon scheduling strategy deploys exactly one task on each active container instance that meets all of the task placement constraints that you specify in your cluster. When you are using this strategy, there is no need to specify a desired number of tasks, a task placement strategy, or use Service Auto Scaling policies.
Tasks using the Fargate launch type or the CODE_DEPLOY
deploymenet controller do not support the DAEMON
scheduling strategy.
The scheduling strategy for services to list.
', 'Service$schedulingStrategy' => 'The scheduling strategy to use for the service. For more information, see Services.
There are two service scheduler strategies available:
REPLICA
-The replica scheduling strategy places and maintains the desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions.
DAEMON
-The daemon scheduling strategy deploys exactly one task on each container instance in your cluster. When you are using this strategy, do not specify a desired number of tasks or any task placement strategies.
Fargate tasks do not support the DAEMON
scheduling strategy.
The scope for the Docker volume that determines its lifecycle. Docker volumes that are scoped to a task
are automatically provisioned when the task starts and destroyed when the task stops. Docker volumes that are scoped as shared
persist after the task stops.
An object representing the secret to expose to your container.
', 'refs' => [ 'SecretList$member' => NULL, ], ], 'SecretList' => [ 'base' => NULL, 'refs' => [ 'ContainerDefinition$secrets' => 'The secrets to pass to the container.
', ], ], 'ServerException' => [ 'base' => 'These errors are usually caused by a server issue.
', 'refs' => [], ], 'Service' => [ 'base' => 'Details on a service within a cluster
', 'refs' => [ 'CreateServiceResponse$service' => 'The full description of your service following the create call.
If a service is using the ECS
deployment controller, the deploymentController
and taskSets
parameters will not be returned.
If the service is using the CODE_DEPLOY
deployment controller, the deploymentController
, taskSets
and deployments
parameters will be returned, however the deployments
parameter will be an empty list.
The full description of the deleted service.
', 'Services$member' => NULL, 'UpdateServiceResponse$service' => 'The full description of your service following the update call.
', ], ], 'ServiceEvent' => [ 'base' => 'Details on an event associated with a service.
', 'refs' => [ 'ServiceEvents$member' => NULL, ], ], 'ServiceEvents' => [ 'base' => NULL, 'refs' => [ 'Service$events' => 'The event stream for your service. A maximum of 100 of the latest events are displayed.
', ], ], 'ServiceField' => [ 'base' => NULL, 'refs' => [ 'ServiceFieldList$member' => NULL, ], ], 'ServiceFieldList' => [ 'base' => NULL, 'refs' => [ 'DescribeServicesRequest$include' => 'Specifies whether you want to see the resource tags for the service. If TAGS
is specified, the tags are included in the response. If this field is omitted, tags are not included in the response.
The specified service is not active. You can\'t update a service that is inactive. If you have previously deleted a service, you can re-create it with CreateService.
', 'refs' => [], ], 'ServiceNotFoundException' => [ 'base' => 'The specified service could not be found. You can view your available services with ListServices. Amazon ECS services are cluster-specific and Region-specific.
', 'refs' => [], ], 'ServiceRegistries' => [ 'base' => NULL, 'refs' => [ 'CreateServiceRequest$serviceRegistries' => 'The details of the service discovery registries to assign to this service. For more information, see Service Discovery.
Service discovery is supported for Fargate tasks if you are using platform version v1.1.0 or later. For more information, see AWS Fargate Platform Versions.
Details of the service registry.
', 'refs' => [ 'ServiceRegistries$member' => NULL, ], ], 'Services' => [ 'base' => NULL, 'refs' => [ 'DescribeServicesResponse$services' => 'The list of services described.
', ], ], 'Setting' => [ 'base' => 'The current account setting for a resource.
', 'refs' => [ 'DeleteAccountSettingResponse$setting' => 'The account setting for the specified principal ARN.
', 'PutAccountSettingResponse$setting' => 'The current account setting for a resource.
', 'Settings$member' => NULL, ], ], 'SettingName' => [ 'base' => NULL, 'refs' => [ 'DeleteAccountSettingRequest$name' => 'The resource name for which to disable the new format. If serviceLongArnFormat
is specified, the ARN for your Amazon ECS services is affected. If taskLongArnFormat
is specified, the ARN and resource ID for your Amazon ECS tasks is affected. If containerInstanceLongArnFormat
is specified, the ARN and resource ID for your Amazon ECS container instances is affected.
The resource name you want to list the account settings for.
', 'PutAccountSettingRequest$name' => 'The resource name for which to enable the new format. If serviceLongArnFormat
is specified, the ARN for your Amazon ECS services is affected. If taskLongArnFormat
is specified, the ARN and resource ID for your Amazon ECS tasks is affected. If containerInstanceLongArnFormat
is specified, the ARN and resource ID for your Amazon ECS container instances is affected.
The account resource name.
', ], ], 'Settings' => [ 'base' => NULL, 'refs' => [ 'ListAccountSettingsResponse$settings' => 'The account settings for the resource.
', ], ], 'SortOrder' => [ 'base' => NULL, 'refs' => [ 'ListTaskDefinitionsRequest$sort' => 'The order in which to sort the results. Valid values are ASC
and DESC
. By default (ASC
), task definitions are listed lexicographically by family name and in ascending numerical order by revision so that the newest task definitions in a family are listed last. Setting this parameter to DESC
reverses the sort order on family name and revision so that the newest task definitions in a family are listed first.
The stability status, which indicates whether the task set has reached a steady state. If the following conditions are met, the task set will be in STEADY_STATE
:
The task runningCount
is equal to the computedDesiredCount
.
The pendingCount
is 0
.
There are no tasks running on container instances in the DRAINING
status.
All tasks are reporting a healthy status from the load balancers, service discovery, and container health checks.
If any of those conditions are not met, the stability status returns STABILIZING
.
Additional information about your clusters that are separated by launch type, including:
runningEC2TasksCount
RunningFargateTasksCount
pendingEC2TasksCount
pendingFargateTasksCount
activeEC2ServiceCount
activeFargateServiceCount
drainingEC2ServiceCount
drainingFargateServiceCount
The unique identifier for the attachment.
', 'Attachment$type' => 'The type of the attachment, such as ElasticNetworkInterface
.
The status of the attachment. Valid values are PRECREATED
, CREATED
, ATTACHING
, ATTACHED
, DETACHING
, DETACHED
, and DELETED
.
The Amazon Resource Name (ARN) of the attachment.
', 'AttachmentStateChange$status' => 'The status of the attachment.
', 'Attribute$name' => 'The name of the attribute. Up to 128 letters (uppercase and lowercase), numbers, hyphens, underscores, and periods are allowed.
', 'Attribute$value' => 'The value of the attribute. Up to 128 letters (uppercase and lowercase), numbers, hyphens, underscores, periods, at signs (@), forward slashes, colons, and spaces are allowed.
', 'Attribute$targetId' => 'The ID of the target. You can specify the short form ID for a resource or the full Amazon Resource Name (ARN).
', 'ClientException$message' => NULL, 'Cluster$clusterArn' => 'The Amazon Resource Name (ARN) that identifies the cluster. The ARN contains the arn:aws:ecs
namespace, followed by the Region of the cluster, the AWS account ID of the cluster owner, the cluster
namespace, and then the cluster name. For example, arn:aws:ecs:region:012345678910:cluster/test
..
A user-generated string that you use to identify your cluster.
', 'Cluster$status' => 'The status of the cluster. The valid values are ACTIVE
or INACTIVE
. ACTIVE
indicates that you can register container instances with the cluster and the associated instances can accept tasks.
The Amazon Resource Name (ARN) of the container.
', 'Container$taskArn' => 'The ARN of the task.
', 'Container$name' => 'The name of the container.
', 'Container$lastStatus' => 'The last known status of the container.
', 'Container$reason' => 'A short (255 max characters) human-readable string to provide additional details about a running or stopped container.
', 'ContainerDefinition$name' => 'The name of a container. If you are linking multiple containers together in a task definition, the name
of one container can be entered in the links
of another container to connect the containers. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. This parameter maps to name
in the Create a container section of the Docker Remote API and the --name
option to docker run.
The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with either repository-url/image:tag
or repository-url/image@digest
. Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to Image
in the Create a container section of the Docker Remote API and the IMAGE
parameter of docker run.
When a new task starts, the Amazon ECS container agent pulls the latest version of the specified image and tag for the container to use. However, subsequent updates to a repository image are not propagated to already running tasks.
Images in Amazon ECR repositories can be specified by either using the full registry/repository:tag
or registry/repository@digest
. For example, 012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>:latest
or 012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>@sha256:94afd1f2e64d908bc90dbca0035a5b567EXAMPLE
.
Images in official repositories on Docker Hub use a single name (for example, ubuntu
or mongo
).
Images in other repositories on Docker Hub are qualified with an organization name (for example, amazon/amazon-ecs-agent
).
Images in other online repositories are qualified further by a domain name (for example, quay.io/assemblyline/ubuntu
).
The hostname to use for your container. This parameter maps to Hostname
in the Create a container section of the Docker Remote API and the --hostname
option to docker run.
The hostname
parameter is not supported if you are using the awsvpc
network mode.
The user name to use inside the container. This parameter maps to User
in the Create a container section of the Docker Remote API and the --user
option to docker run.
This parameter is not supported for Windows containers.
The working directory in which to run commands inside the container. This parameter maps to WorkingDir
in the Create a container section of the Docker Remote API and the --workdir
option to docker run.
The Amazon Resource Name (ARN) of the container instance. The ARN contains the arn:aws:ecs
namespace, followed by the Region of the container instance, the AWS account ID of the container instance owner, the container-instance
namespace, and then the container instance ID. For example, arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID
.
The EC2 instance ID of the container instance.
', 'ContainerInstance$status' => 'The status of the container instance. The valid values are ACTIVE
, INACTIVE
, or DRAINING
. ACTIVE
indicates that the container instance can accept tasks. DRAINING
indicates that new tasks are not placed on the container instance and any service tasks running on the container instance are removed if possible. For more information, see Container Instance Draining in the Amazon Elastic Container Service Developer Guide.
The name of the container that receives the override. This parameter is required if any override is specified.
', 'ContainerStateChange$containerName' => 'The name of the container.
', 'ContainerStateChange$reason' => 'The reason for the state change.
', 'ContainerStateChange$status' => 'The status of the container.
', 'CreateClusterRequest$clusterName' => 'The name of your cluster. If you do not specify a name for your cluster, you create a cluster named default
. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.
The short name or full Amazon Resource Name (ARN) of the cluster on which to run your service. If you do not specify a cluster, the default cluster is assumed.
', 'CreateServiceRequest$serviceName' => 'The name of your service. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. Service names must be unique within a cluster, but you can have similarly named services in multiple clusters within a Region or across multiple Regions.
', 'CreateServiceRequest$taskDefinition' => 'The family
and revision
(family:revision
) or full ARN of the task definition to run in your service. If a revision
is not specified, the latest ACTIVE
revision is used.
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 32 ASCII characters are allowed.
', 'CreateServiceRequest$platformVersion' => 'The platform version on which your tasks in the service are running. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the LATEST
platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.
The name or full Amazon Resource Name (ARN) of the IAM role that allows Amazon ECS to make calls to your load balancer on your behalf. This parameter is only permitted if you are using a load balancer with your service and your task definition does not use the awsvpc
network mode. If you specify the role
parameter, you must also specify a load balancer object with the loadBalancers
parameter.
If your account has already created the Amazon ECS service-linked role, that role is used by default for your service unless you specify a role here. The service-linked role is required if your task definition uses the awsvpc
network mode, in which case you should not specify a role here. For more information, see Using Service-Linked Roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.
If your specified role has a path other than /
, then you must either specify the full role ARN (this is recommended) or prefix the role name with the path. For example, if a role with the name bar
has a path of /foo/
then you would specify /foo/bar
as the role name. For more information, see Friendly Names and Paths in the IAM User Guide.
The ARN of the principal, which can be an IAM user, IAM role, or the root user. If you specify the root user, it modifies the ARN and resource ID format for all IAM users, IAM roles, and the root user of the account unless an IAM user or role explicitly overrides these settings for themselves. If this field is omitted, the setting are changed only for the authenticated user.
', 'DeleteAttributesRequest$cluster' => 'The short name or full Amazon Resource Name (ARN) of the cluster that contains the resource to delete attributes. If you do not specify a cluster, the default cluster is assumed.
', 'DeleteClusterRequest$cluster' => 'The short name or full Amazon Resource Name (ARN) of the cluster to delete.
', 'DeleteServiceRequest$cluster' => 'The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to delete. If you do not specify a cluster, the default cluster is assumed.
', 'DeleteServiceRequest$service' => 'The name of the service to delete.
', 'Deployment$id' => 'The ID of the deployment.
', 'Deployment$status' => 'The status of the deployment. The following describes each state:
The most recent deployment of a service.
A service deployment that still has running tasks, but are in the process of being replaced with a new PRIMARY
deployment.
A deployment that has been completely replaced.
The most recent task definition that was specified for the tasks in the service to use.
', 'Deployment$platformVersion' => 'The platform version on which your tasks in the service are running. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the LATEST
platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instance to deregister. If you do not specify a cluster, the default cluster is assumed.
', 'DeregisterContainerInstanceRequest$containerInstance' => 'The container instance ID or full ARN of the container instance to deregister. The ARN contains the arn:aws:ecs
namespace, followed by the Region of the container instance, the AWS account ID of the container instance owner, the container-instance
namespace, and then the container instance ID. For example, arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID
.
The family
and revision
(family:revision
) or full Amazon Resource Name (ARN) of the task definition to deregister. You must specify a revision
.
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to describe. If you do not specify a cluster, the default cluster is assumed.
', 'DescribeServicesRequest$cluster' => 'The short name or full Amazon Resource Name (ARN)the cluster that hosts the service to describe. If you do not specify a cluster, the default cluster is assumed.
', 'DescribeTaskDefinitionRequest$taskDefinition' => 'The family
for the latest ACTIVE
revision, family
and revision
(family:revision
) for a specific revision in the family, or full Amazon Resource Name (ARN) of the task definition to describe.
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task to describe. If you do not specify a cluster, the default cluster is assumed.
', 'Device$hostPath' => 'The path for the device on the host container instance.
', 'Device$containerPath' => 'The path inside the container at which to expose the host device.
', 'DiscoverPollEndpointRequest$containerInstance' => 'The container instance ID or full ARN of the container instance. The ARN contains the arn:aws:ecs
namespace, followed by the Region of the container instance, the AWS account ID of the container instance owner, the container-instance
namespace, and then the container instance ID. For example, arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID
.
The short name or full Amazon Resource Name (ARN) of the cluster to which the container instance belongs.
', 'DiscoverPollEndpointResponse$endpoint' => 'The endpoint for the Amazon ECS agent to poll.
', 'DiscoverPollEndpointResponse$telemetryEndpoint' => 'The telemetry endpoint for the Amazon ECS agent.
', 'DockerLabelsMap$key' => NULL, 'DockerLabelsMap$value' => NULL, 'DockerVolumeConfiguration$driver' => 'The Docker volume driver to use. The driver value must match the driver name provided by Docker because it is used for task placement. If the driver was installed using the Docker plugin CLI, use docker plugin ls
to retrieve the driver name from your container instance. If the driver was installed using another method, use Docker plugin discovery to retrieve the driver name. For more information, see Docker plugin discovery. This parameter maps to Driver
in the Create a volume section of the Docker Remote API and the xxdriver
option to docker volume create
.
The Amazon Resource Name (ARN) of the failed resource.
', 'Failure$reason' => 'The reason for the failure.
', 'HostEntry$hostname' => 'The hostname to use in the /etc/hosts
entry.
The IP address to use in the /etc/hosts
entry.
When the host
parameter is used, specify a sourcePath
to declare the path on the host container instance that is presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you. If the host
parameter contains a sourcePath
file location, then the data volume persists at the specified location on the host container instance until you delete it manually. If the sourcePath
value does not exist on the host container instance, the Docker daemon creates it. If the location does exist, the contents of the source path folder are exported.
If you are using the Fargate launch type, the sourcePath
parameter is not supported.
The name of the key-value pair. For environment variables, this is the name of the environment variable.
', 'KeyValuePair$value' => 'The value of the key-value pair. For environment variables, this is the value of the environment variable.
', 'ListAccountSettingsRequest$value' => 'The value of the account settings with which to filter results. You must also specify an account setting name to use this parameter.
', 'ListAccountSettingsRequest$principalArn' => 'The ARN of the principal, which can be an IAM user, IAM role, or the root user. If this field is omitted, the account settings are listed only for the authenticated user.
', 'ListAccountSettingsRequest$nextToken' => 'The nextToken
value returned from a previous paginated ListAccountSettings
request where maxResults
was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken
value.
This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
The nextToken
value to include in a future ListAccountSettings
request. When the results of a ListAccountSettings
request exceed maxResults
, this value can be used to retrieve the next page of results. This value is null
when there are no more results to return.
The short name or full Amazon Resource Name (ARN) of the cluster to list attributes. If you do not specify a cluster, the default cluster is assumed.
', 'ListAttributesRequest$attributeName' => 'The name of the attribute with which to filter the results.
', 'ListAttributesRequest$attributeValue' => 'The value of the attribute with which to filter results. You must also specify an attribute name to use this parameter.
', 'ListAttributesRequest$nextToken' => 'The nextToken
value returned from a previous paginated ListAttributes
request where maxResults
was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken
value.
This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
The nextToken
value to include in a future ListAttributes
request. When the results of a ListAttributes
request exceed maxResults
, this value can be used to retrieve the next page of results. This value is null
when there are no more results to return.
The nextToken
value returned from a previous paginated ListClusters
request where maxResults
was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken
value.
This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
The nextToken
value to include in a future ListClusters
request. When the results of a ListClusters
request exceed maxResults
, this value can be used to retrieve the next page of results. This value is null
when there are no more results to return.
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to list. If you do not specify a cluster, the default cluster is assumed.
', 'ListContainerInstancesRequest$filter' => 'You can filter the results of a ListContainerInstances
operation with cluster query language statements. For more information, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide.
The nextToken
value returned from a previous paginated ListContainerInstances
request where maxResults
was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken
value.
This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
The nextToken
value to include in a future ListContainerInstances
request. When the results of a ListContainerInstances
request exceed maxResults
, this value can be used to retrieve the next page of results. This value is null
when there are no more results to return.
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the services to list. If you do not specify a cluster, the default cluster is assumed.
', 'ListServicesRequest$nextToken' => 'The nextToken
value returned from a previous paginated ListServices
request where maxResults
was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken
value.
This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
The nextToken
value to include in a future ListServices
request. When the results of a ListServices
request exceed maxResults
, this value can be used to retrieve the next page of results. This value is null
when there are no more results to return.
The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, the supported resources are Amazon ECS tasks, services, task definitions, clusters, and container instances.
', 'ListTaskDefinitionFamiliesRequest$familyPrefix' => 'The familyPrefix
is a string that is used to filter the results of ListTaskDefinitionFamilies
. If you specify a familyPrefix
, only task definition family names that begin with the familyPrefix
string are returned.
The nextToken
value returned from a previous paginated ListTaskDefinitionFamilies
request where maxResults
was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken
value.
This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
The nextToken
value to include in a future ListTaskDefinitionFamilies
request. When the results of a ListTaskDefinitionFamilies
request exceed maxResults
, this value can be used to retrieve the next page of results. This value is null
when there are no more results to return.
The full family name with which to filter the ListTaskDefinitions
results. Specifying a familyPrefix
limits the listed task definitions to task definition revisions that belong to that family.
The nextToken
value returned from a previous paginated ListTaskDefinitions
request where maxResults
was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken
value.
This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
The nextToken
value to include in a future ListTaskDefinitions
request. When the results of a ListTaskDefinitions
request exceed maxResults
, this value can be used to retrieve the next page of results. This value is null
when there are no more results to return.
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the tasks to list. If you do not specify a cluster, the default cluster is assumed.
', 'ListTasksRequest$containerInstance' => 'The container instance ID or full ARN of the container instance with which to filter the ListTasks
results. Specifying a containerInstance
limits the results to tasks that belong to that container instance.
The name of the family with which to filter the ListTasks
results. Specifying a family
limits the results to tasks that belong to that family.
The nextToken
value returned from a previous paginated ListTasks
request where maxResults
was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken
value.
This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
The startedBy
value with which to filter the task results. Specifying a startedBy
value limits the results to tasks that were started with that value.
The name of the service with which to filter the ListTasks
results. Specifying a serviceName
limits the results to tasks that belong to that service.
The nextToken
value to include in a future ListTasks
request. When the results of a ListTasks
request exceed maxResults
, this value can be used to retrieve the next page of results. This value is null
when there are no more results to return.
The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service. For services using the ECS
deployment controller, you are limited to one target group. For services using the CODE_DEPLOY
deployment controller, you are required to define two target groups for the load balancer.
If your service\'s task definition uses the awsvpc
network mode (which is required for the Fargate launch type), you must choose ip
as the target type, not instance
, because tasks that use the awsvpc
network mode are associated with an elastic network interface, not an Amazon EC2 instance.
The name of a load balancer.
', 'LoadBalancer$containerName' => 'The name of the container (as it appears in a container definition) to associate with the load balancer.
', 'LogConfigurationOptionsMap$key' => NULL, 'LogConfigurationOptionsMap$value' => NULL, 'MountPoint$sourceVolume' => 'The name of the volume to mount. Must be a volume name referenced in the name
parameter of task definition volume
.
The path on the container to mount the host volume at.
', 'NetworkBinding$bindIP' => 'The IP address that the container is bound to on the container instance.
', 'NetworkInterface$attachmentId' => 'The attachment ID for the network interface.
', 'NetworkInterface$privateIpv4Address' => 'The private IPv4 address for the network interface.
', 'NetworkInterface$ipv6Address' => 'The private IPv6 address for the network interface.
', 'PlacementConstraint$expression' => 'A cluster query language expression to apply to the constraint. You cannot specify an expression if the constraint type is distinctInstance
. For more information, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide.
The field to apply the placement strategy against. For the spread
placement strategy, valid values are instanceId
(or host
, which has the same effect), or any platform or custom attribute that is applied to a container instance, such as attribute:ecs.availability-zone
. For the binpack
placement strategy, valid values are cpu
and memory
. For the random
placement strategy, this field is not used.
The account setting value for the specified principal ARN. Accepted values are enabled
and disabled
.
The ARN of the principal, which can be an IAM user, IAM role, or the root user. If you specify the root user, it modifies the ARN and resource ID format for all IAM users, IAM roles, and the root user of the account unless an IAM user or role explicitly overrides these settings for themselves. If this field is omitted, the setting are changed only for the authenticated user.
', 'PutAttributesRequest$cluster' => 'The short name or full Amazon Resource Name (ARN) of the cluster that contains the resource to apply attributes. If you do not specify a cluster, the default cluster is assumed.
', 'RegisterContainerInstanceRequest$cluster' => 'The short name or full Amazon Resource Name (ARN) of the cluster with which to register your container instance. If you do not specify a cluster, the default cluster is assumed.
', 'RegisterContainerInstanceRequest$instanceIdentityDocument' => 'The instance identity document for the EC2 instance to register. This document can be found by running the following command from the instance: curl http://169.254.169.254/latest/dynamic/instance-identity/document/
The instance identity document signature for the EC2 instance to register. This signature can be found by running the following command from the instance: curl http://169.254.169.254/latest/dynamic/instance-identity/signature/
The ARN of the container instance (if it was previously registered).
', 'RegisterTaskDefinitionRequest$family' => 'You must specify a family
for a task definition, which allows you to track multiple versions of the same task definition. The family
is used as a name for your task definition. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.
The short name or full Amazon Resource Name (ARN) of the IAM role that containers in this task can assume. All containers in this task are granted the permissions that are specified in this role. For more information, see IAM Roles for Tasks in the Amazon Elastic Container Service Developer Guide.
', 'RegisterTaskDefinitionRequest$executionRoleArn' => 'The Amazon Resource Name (ARN) of the task execution role that the Amazon ECS container agent and the Docker daemon can assume.
', 'RegisterTaskDefinitionRequest$cpu' => 'The number of CPU units used by the task. It can be expressed as an integer using CPU units, for example 1024
, or as a string using vCPUs, for example 1 vCPU
or 1 vcpu
, in a task definition. String values are converted to an integer indicating the CPU units when the task definition is registered.
Task-level CPU and memory parameters are ignored for Windows containers. We recommend specifying container-level resources for Windows containers.
If you are using the EC2 launch type, this field is optional. Supported values are between 128
CPU units (0.125
vCPUs) and 10240
CPU units (10
vCPUs).
If you are using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of supported values for the memory
parameter:
256 (.25 vCPU) - Available memory
values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)
512 (.5 vCPU) - Available memory
values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)
1024 (1 vCPU) - Available memory
values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)
2048 (2 vCPU) - Available memory
values: Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)
4096 (4 vCPU) - Available memory
values: Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)
The amount of memory (in MiB) used by the task. It can be expressed as an integer using MiB, for example 1024
, or as a string using GB, for example 1GB
or 1 GB
, in a task definition. String values are converted to an integer indicating the MiB when the task definition is registered.
Task-level CPU and memory parameters are ignored for Windows containers. We recommend specifying container-level resources for Windows containers.
If using the EC2 launch type, this field is optional.
If using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of supported values for the cpu
parameter:
512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu
values: 256 (.25 vCPU)
1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu
values: 512 (.5 vCPU)
2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available cpu
values: 1024 (1 vCPU)
Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu
values: 2048 (2 vCPU)
Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu
values: 4096 (4 vCPU)
The Amazon Resource Name (ARN) of the secret containing the private repository credentials.
When you are using the Amazon ECS API, AWS CLI, or AWS SDK, if the secret exists in the same Region as the task that you are launching then you can use either the full ARN or the name of the secret. When you are using the AWS Management Console, you must specify the full ARN of the secret.
The name of the resource, such as CPU
, MEMORY
, PORTS
, PORTS_UDP
, or a user-defined resource.
The type of the resource, such as INTEGER
, DOUBLE
, LONG
, or STRINGSET
.
The short name or full Amazon Resource Name (ARN) of the cluster on which to run your task. If you do not specify a cluster, the default cluster is assumed.
', 'RunTaskRequest$taskDefinition' => 'The family
and revision
(family:revision
) or full ARN of the task definition to run. If a revision
is not specified, the latest ACTIVE
revision is used.
An optional tag specified when a task is started. For example, if you automatically trigger a task to run a batch process job, you could apply a unique identifier for that job to your task with the startedBy
parameter. You can then identify which tasks belong to that job by filtering the results of a ListTasks call with the startedBy
value. Up to 36 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.
If a task is started by an Amazon ECS service, then the startedBy
parameter contains the deployment ID of the service that starts it.
The name of the task group to associate with the task. The default value is the family name of the task definition (for example, family:my-family-name).
', 'RunTaskRequest$platformVersion' => 'The platform version the task should run. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the LATEST
platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.
The value to set as the environment variable on the container.
', 'Secret$valueFrom' => 'The secret to expose to the container. Supported values are either the full ARN or the name of the parameter in the AWS Systems Manager Parameter Store.
', 'ServerException$message' => NULL, 'Service$serviceArn' => 'The ARN that identifies the service. The ARN contains the arn:aws:ecs
namespace, followed by the Region of the service, the AWS account ID of the service owner, the service
namespace, and then the service name. For example, arn:aws:ecs:region:012345678910:service/my-service
.
The name of your service. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. Service names must be unique within a cluster, but you can have similarly named services in multiple clusters within a Region or across multiple Regions.
', 'Service$clusterArn' => 'The Amazon Resource Name (ARN) of the cluster that hosts the service.
', 'Service$status' => 'The status of the service. The valid values are ACTIVE
, DRAINING
, or INACTIVE
.
The platform version on which your tasks in the service are running. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the LATEST
platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.
The task definition to use for tasks in the service. This value is specified when the service is created with CreateService, and it can be modified with UpdateService.
', 'Service$roleArn' => 'The ARN of the IAM role associated with the service that allows the Amazon ECS container agent to register container instances with an Elastic Load Balancing load balancer.
', 'Service$createdBy' => 'The principal that created the service.
', 'ServiceEvent$id' => 'The ID string of the event.
', 'ServiceEvent$message' => 'The event message.
', 'ServiceRegistry$registryArn' => 'The Amazon Resource Name (ARN) of the service registry. The currently supported service registry is Amazon Route 53 Auto Naming. For more information, see Service.
', 'ServiceRegistry$containerName' => 'The container name value, already specified in the task definition, to be used for your service discovery service. If the task definition that your service task specifies uses the bridge
or host
network mode, you must specify a containerName
and containerPort
combination from the task definition. If the task definition that your service task specifies uses the awsvpc
network mode and a type SRV DNS record is used, you must specify either a containerName
and containerPort
combination or a port
value, but not both.
The current account setting for the resource name. If enabled
, then the resource will receive the new Amazon Resource Name (ARN) and resource identifier (ID) format. If disabled
, then the resource will receive the old Amazon Resource Name (ARN) and resource identifier (ID) format.
The ARN of the principal, which can be an IAM user, IAM role, or the root user. If this field is omitted, the authenticated user is assumed.
', 'StartTaskRequest$cluster' => 'The short name or full Amazon Resource Name (ARN) of the cluster on which to start your task. If you do not specify a cluster, the default cluster is assumed.
', 'StartTaskRequest$taskDefinition' => 'The family
and revision
(family:revision
) or full ARN of the task definition to start. If a revision
is not specified, the latest ACTIVE
revision is used.
An optional tag specified when a task is started. For example, if you automatically trigger a task to run a batch process job, you could apply a unique identifier for that job to your task with the startedBy
parameter. You can then identify which tasks belong to that job by filtering the results of a ListTasks call with the startedBy
value. Up to 36 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.
If a task is started by an Amazon ECS service, then the startedBy
parameter contains the deployment ID of the service that starts it.
The name of the task group to associate with the task. The default value is the family name of the task definition (for example, family:my-family-name).
', 'StopTaskRequest$cluster' => 'The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task to stop. If you do not specify a cluster, the default cluster is assumed.
', 'StopTaskRequest$task' => 'The task ID or full ARN entry of the task to stop.
', 'StopTaskRequest$reason' => 'An optional message specified when a task is stopped. For example, if you are using a custom scheduler, you can use this parameter to specify the reason for stopping the task here, and the message appears in subsequent DescribeTasks API operations on this task. Up to 255 characters are allowed in this message.
', 'StringList$member' => NULL, 'StringMap$key' => NULL, 'StringMap$value' => NULL, 'SubmitContainerStateChangeRequest$cluster' => 'The short name or full ARN of the cluster that hosts the container.
', 'SubmitContainerStateChangeRequest$task' => 'The task ID or full Amazon Resource Name (ARN) of the task that hosts the container.
', 'SubmitContainerStateChangeRequest$containerName' => 'The name of the container.
', 'SubmitContainerStateChangeRequest$status' => 'The status of the state change request.
', 'SubmitContainerStateChangeRequest$reason' => 'The reason for the state change request.
', 'SubmitContainerStateChangeResponse$acknowledgment' => 'Acknowledgement of the state change.
', 'SubmitTaskStateChangeRequest$cluster' => 'The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task.
', 'SubmitTaskStateChangeRequest$task' => 'The task ID or full ARN of the task in the state change request.
', 'SubmitTaskStateChangeRequest$status' => 'The status of the state change request.
', 'SubmitTaskStateChangeRequest$reason' => 'The reason for the state change request.
', 'SubmitTaskStateChangeResponse$acknowledgment' => 'Acknowledgement of the state change.
', 'SystemControl$namespace' => 'The namespaced kernel parameter for which to set a value
.
The value for the namespaced kernel parameter specified in namespace
.
The Amazon Resource Name (ARN) of the resource to which to add tags. Currently, the supported resources are Amazon ECS tasks, services, task definitions, clusters, and container instances.
', 'Task$taskArn' => 'The Amazon Resource Name (ARN) of the task.
', 'Task$clusterArn' => 'The ARN of the cluster that hosts the task.
', 'Task$taskDefinitionArn' => 'The ARN of the task definition that creates the task.
', 'Task$containerInstanceArn' => 'The ARN of the container instances that host the task.
', 'Task$lastStatus' => 'The last known status of the task. For more information, see Task Lifecycle.
', 'Task$desiredStatus' => 'The desired status of the task. For more information, see Task Lifecycle.
', 'Task$cpu' => 'The number of CPU units used by the task as expressed in a task definition. It can be expressed as an integer using CPU units, for example 1024
. It can also be expressed as a string using vCPUs, for example 1 vCPU
or 1 vcpu
. String values are converted to an integer indicating the CPU units when the task definition is registered.
If you are using the EC2 launch type, this field is optional. Supported values are between 128
CPU units (0.125
vCPUs) and 10240
CPU units (10
vCPUs).
If you are using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of supported values for the memory
parameter:
256 (.25 vCPU) - Available memory
values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)
512 (.5 vCPU) - Available memory
values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)
1024 (1 vCPU) - Available memory
values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)
2048 (2 vCPU) - Available memory
values: Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)
4096 (4 vCPU) - Available memory
values: Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)
The amount of memory (in MiB) used by the task as expressed in a task definition. It can be expressed as an integer using MiB, for example 1024
. It can also be expressed as a string using GB, for example 1GB
or 1 GB
. String values are converted to an integer indicating the MiB when the task definition is registered.
If you are using the EC2 launch type, this field is optional.
If you are using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of supported values for the cpu
parameter:
512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu
values: 256 (.25 vCPU)
1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu
values: 512 (.5 vCPU)
2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available cpu
values: 1024 (1 vCPU)
Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu
values: 2048 (2 vCPU)
Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu
values: 4096 (4 vCPU)
The tag specified when a task is started. If the task is started by an Amazon ECS service, then the startedBy
parameter contains the deployment ID of the service that starts it.
The reason that the task was stopped.
', 'Task$group' => 'The name of the task group associated with the task.
', 'Task$platformVersion' => 'The platform version on which your task is running. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the LATEST
platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.
The full Amazon Resource Name (ARN) of the task definition.
', 'TaskDefinition$family' => 'The family of your task definition, used as the definition name.
', 'TaskDefinition$taskRoleArn' => 'The ARN of the IAM role that containers in this task can assume. All containers in this task are granted the permissions that are specified in this role.
IAM roles for tasks on Windows require that the -EnableTaskIAMRole
option is set when you launch the Amazon ECS-optimized Windows AMI. Your containers must also run some configuration code in order to take advantage of the feature. For more information, see Windows IAM Roles for Tasks in the Amazon Elastic Container Service Developer Guide.
The Amazon Resource Name (ARN) of the task execution role that the Amazon ECS container agent and the Docker daemon can assume.
', 'TaskDefinition$cpu' => 'The number of cpu
units used by the task. If you are using the EC2 launch type, this field is optional and any value can be used. If you are using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of valid values for the memory
parameter:
256 (.25 vCPU) - Available memory
values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)
512 (.5 vCPU) - Available memory
values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)
1024 (1 vCPU) - Available memory
values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)
2048 (2 vCPU) - Available memory
values: Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)
4096 (4 vCPU) - Available memory
values: Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)
The amount (in MiB) of memory used by the task. If using the EC2 launch type, this field is optional and any value can be used. If using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of valid values for the cpu
parameter:
512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu
values: 256 (.25 vCPU)
1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu
values: 512 (.5 vCPU)
2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available cpu
values: 1024 (1 vCPU)
Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu
values: 2048 (2 vCPU)
Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu
values: 4096 (4 vCPU)
A cluster query language expression to apply to the constraint. For more information, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide.
', 'TaskOverride$taskRoleArn' => 'The Amazon Resource Name (ARN) of the IAM role that containers in this task can assume. All containers in this task are granted the permissions that are specified in this role.
', 'TaskOverride$executionRoleArn' => 'The Amazon Resource Name (ARN) of the task execution role that the Amazon ECS container agent and the Docker daemon can assume.
', 'TaskSet$id' => 'The ID of the task set.
', 'TaskSet$taskSetArn' => 'The Amazon Resource Name (ARN) of the task set.
', 'TaskSet$startedBy' => 'The tag specified when a task set is started. If the task is started by an AWS CodeDeploy deployment, then the startedBy
parameter is CODE_DEPLOY
.
The deployment ID of the AWS CodeDeploy deployment.
', 'TaskSet$status' => 'The status of the task set. The following describes each state:
The task set is serving production traffic.
The task set is not serving production traffic.
The tasks in the task set are being stopped and their corresponding targets are being deregistered from their target group.
The task definition the task set is using.
', 'TaskSet$platformVersion' => 'The platform version on which the tasks in the task set are running. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the LATEST
platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.
The absolute file path where the tmpfs volume is to be mounted.
', 'UntagResourceRequest$resourceArn' => 'The Amazon Resource Name (ARN) of the resource from which to delete tags. Currently, the supported resources are Amazon ECS tasks, services, task definitions, clusters, and container instances.
', 'UpdateContainerAgentRequest$cluster' => 'The short name or full Amazon Resource Name (ARN) of the cluster that your container instance is running on. If you do not specify a cluster, the default cluster is assumed.
', 'UpdateContainerAgentRequest$containerInstance' => 'The container instance ID or full ARN entries for the container instance on which you would like to update the Amazon ECS container agent.
', 'UpdateContainerInstancesStateRequest$cluster' => 'The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instance to update. If you do not specify a cluster, the default cluster is assumed.
', 'UpdateServiceRequest$cluster' => 'The short name or full Amazon Resource Name (ARN) of the cluster that your service is running on. If you do not specify a cluster, the default cluster is assumed.
', 'UpdateServiceRequest$service' => 'The name of the service to update.
', 'UpdateServiceRequest$taskDefinition' => 'The family
and revision
(family:revision
) or full ARN of the task definition to run in your service. If a revision
is not specified, the latest ACTIVE
revision is used. If you modify the task definition with UpdateService
, Amazon ECS spawns a task with the new version of the task definition and then stops an old task after the new version is running.
The platform version on which your tasks in the service are running. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the LATEST
platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.
The version number of the Amazon ECS container agent.
', 'VersionInfo$agentHash' => 'The Git commit hash for the Amazon ECS container agent build on the amazon-ecs-agent GitHub repository.
', 'VersionInfo$dockerVersion' => 'The Docker version running on the container instance.
', 'Volume$name' => 'The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. This name is referenced in the sourceVolume
parameter of container definition mountPoints
.
The name of another container within the same task definition from which to mount volumes.
', ], ], 'StringList' => [ 'base' => NULL, 'refs' => [ 'AwsVpcConfiguration$subnets' => 'The subnets associated with the task or service. There is a limit of 16 subnets able to be specified per AwsVpcConfiguration
.
All specified subnets must be from the same VPC.
The security groups associated with the task or service. If you do not specify a security group, the default security group for the VPC is used. There is a limit of five security groups able to be specified per AwsVpcConfiguration
.
All specified security groups must be from the same VPC.
The link
parameter allows containers to communicate with each other without the need for port mappings. Only supported if the network mode of a task definition is set to bridge
. The name:internalName
construct is analogous to name:alias
in Docker links. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. For more information about linking Docker containers, go to https://docs.docker.com/engine/userguide/networking/default_network/dockerlinks/. This parameter maps to Links
in the Create a container section of the Docker Remote API and the --link
option to docker run
.
This parameter is not supported for Windows containers.
Containers that are collocated on a single container instance may be able to communicate with each other without requiring links or host port mappings. Network isolation is achieved on the container instance using security groups and VPC settings.
Early versions of the Amazon ECS container agent do not properly handle entryPoint
parameters. If you have problems using entryPoint
, update your container agent or enter your commands and arguments as command
array items instead.
The entry point that is passed to the container. This parameter maps to Entrypoint
in the Create a container section of the Docker Remote API and the --entrypoint
option to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#entrypoint.
The command that is passed to the container. This parameter maps to Cmd
in the Create a container section of the Docker Remote API and the COMMAND
parameter to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#cmd.
A list of DNS servers that are presented to the container. This parameter maps to Dns
in the Create a container section of the Docker Remote API and the --dns
option to docker run.
This parameter is not supported for Windows containers.
A list of DNS search domains that are presented to the container. This parameter maps to DnsSearch
in the Create a container section of the Docker Remote API and the --dns-search
option to docker run.
This parameter is not supported for Windows containers.
A list of strings to provide custom labels for SELinux and AppArmor multi-level security systems. This field is not valid for containers in tasks using the Fargate launch type.
This parameter maps to SecurityOpt
in the Create a container section of the Docker Remote API and the --security-opt
option to docker run.
The Amazon ECS container agent running on a container instance must register with the ECS_SELINUX_CAPABLE=true
or ECS_APPARMOR_CAPABLE=true
environment variables before containers placed on that instance can use these security options. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide.
This parameter is not supported for Windows containers.
The command to send to the container that overrides the default command from the Docker image or the task definition. You must also specify a container name.
', 'DescribeClustersRequest$clusters' => 'A list of up to 100 cluster names or full cluster Amazon Resource Name (ARN) entries. If you do not specify a cluster, the default cluster is assumed.
', 'DescribeContainerInstancesRequest$containerInstances' => 'A list of up to 100 container instance IDs or full Amazon Resource Name (ARN) entries.
', 'DescribeServicesRequest$services' => 'A list of services to describe. You may specify up to 10 services to describe in a single operation.
', 'DescribeTasksRequest$tasks' => 'A list of up to 100 task IDs or full ARN entries.
', 'HealthCheck$command' => 'A string array representing the command that the container runs to determine if it is healthy. The string array must start with CMD
to execute the command arguments directly, or CMD-SHELL
to run the command with the container\'s default shell. For example:
[ "CMD-SHELL", "curl -f http://localhost/ || exit 1" ]
An exit code of 0 indicates success, and non-zero exit code indicates failure. For more information, see HealthCheck
in the Create a container section of the Docker Remote API.
The Linux capabilities for the container that have been added to the default configuration provided by Docker. This parameter maps to CapAdd
in the Create a container section of the Docker Remote API and the --cap-add
option to docker run.
If you are using tasks that use the Fargate launch type, the add
parameter is not supported.
Valid values: "ALL" | "AUDIT_CONTROL" | "AUDIT_WRITE" | "BLOCK_SUSPEND" | "CHOWN" | "DAC_OVERRIDE" | "DAC_READ_SEARCH" | "FOWNER" | "FSETID" | "IPC_LOCK" | "IPC_OWNER" | "KILL" | "LEASE" | "LINUX_IMMUTABLE" | "MAC_ADMIN" | "MAC_OVERRIDE" | "MKNOD" | "NET_ADMIN" | "NET_BIND_SERVICE" | "NET_BROADCAST" | "NET_RAW" | "SETFCAP" | "SETGID" | "SETPCAP" | "SETUID" | "SYS_ADMIN" | "SYS_BOOT" | "SYS_CHROOT" | "SYS_MODULE" | "SYS_NICE" | "SYS_PACCT" | "SYS_PTRACE" | "SYS_RAWIO" | "SYS_RESOURCE" | "SYS_TIME" | "SYS_TTY_CONFIG" | "SYSLOG" | "WAKE_ALARM"
The Linux capabilities for the container that have been removed from the default configuration provided by Docker. This parameter maps to CapDrop
in the Create a container section of the Docker Remote API and the --cap-drop
option to docker run.
Valid values: "ALL" | "AUDIT_CONTROL" | "AUDIT_WRITE" | "BLOCK_SUSPEND" | "CHOWN" | "DAC_OVERRIDE" | "DAC_READ_SEARCH" | "FOWNER" | "FSETID" | "IPC_LOCK" | "IPC_OWNER" | "KILL" | "LEASE" | "LINUX_IMMUTABLE" | "MAC_ADMIN" | "MAC_OVERRIDE" | "MKNOD" | "NET_ADMIN" | "NET_BIND_SERVICE" | "NET_BROADCAST" | "NET_RAW" | "SETFCAP" | "SETGID" | "SETPCAP" | "SETUID" | "SYS_ADMIN" | "SYS_BOOT" | "SYS_CHROOT" | "SYS_MODULE" | "SYS_NICE" | "SYS_PACCT" | "SYS_PTRACE" | "SYS_RAWIO" | "SYS_RESOURCE" | "SYS_TIME" | "SYS_TTY_CONFIG" | "SYSLOG" | "WAKE_ALARM"
The list of full Amazon Resource Name (ARN) entries for each cluster associated with your account.
', 'ListContainerInstancesResponse$containerInstanceArns' => 'The list of container instances with full ARN entries for each container instance associated with the specified cluster.
', 'ListServicesResponse$serviceArns' => 'The list of full ARN entries for each service associated with the specified cluster.
', 'ListTaskDefinitionFamiliesResponse$families' => 'The list of task definition family names that match the ListTaskDefinitionFamilies
request.
The list of task definition Amazon Resource Name (ARN) entries for the ListTaskDefinitions
request.
The list of task ARN entries for the ListTasks
request.
When the stringSetValue
type is set, the value of the resource must be a string type.
The container instance IDs or full ARN entries for the container instances on which you would like to place your task. You can specify up to 10 container instances.
', 'Tmpfs$mountOptions' => 'The list of tmpfs volume mount options.
Valid values: "defaults" | "ro" | "rw" | "suid" | "nosuid" | "dev" | "nodev" | "exec" | "noexec" | "sync" | "async" | "dirsync" | "remount" | "mand" | "nomand" | "atime" | "noatime" | "diratime" | "nodiratime" | "bind" | "rbind" | "unbindable" | "runbindable" | "private" | "rprivate" | "shared" | "rshared" | "slave" | "rslave" | "relatime" | "norelatime" | "strictatime" | "nostrictatime" | "mode" | "uid" | "gid" | "nr_inodes" | "nr_blocks" | "mpol"
A list of container instance IDs or full ARN entries.
', ], ], 'StringMap' => [ 'base' => NULL, 'refs' => [ 'DockerVolumeConfiguration$driverOpts' => 'A map of Docker driver-specific options passed through. This parameter maps to DriverOpts
in the Create a volume section of the Docker Remote API and the xxopt
option to docker volume create
.
Custom metadata to add to your Docker volume. This parameter maps to Labels
in the Create a volume section of the Docker Remote API and the xxlabel
option to docker volume create
.
A list of namespaced kernel parameters to set in the container. This parameter maps to Sysctls
in the Create a container section of the Docker Remote API and the --sysctl
option to docker run.
It is not recommended that you specify network-related systemControls
parameters for multiple containers in a single task that also uses either the awsvpc
or host
network mode for the following reasons:
For tasks that use the awsvpc
network mode, if you set systemControls
for any container, it applies to all containers in the task. If you set different systemControls
for multiple containers in a single task, the container that is started last determines which systemControls
take effect.
For tasks that use the host
network mode, the systemControls
parameter applies to the container instance\'s kernel parameter as well as that of all containers of any tasks running on that container instance.
A list of namespaced kernel parameters to set in the container. This parameter maps to Sysctls
in the Create a container section of the Docker Remote API and the --sysctl
option to docker run.
It is not recommended that you specify network-related systemControls
parameters for multiple containers in a single task that also uses either the awsvpc
or host
network modes. For tasks that use the awsvpc
network mode, the container that is started last determines which systemControls
parameters take effect. For tasks that use the host
network mode, it changes the container instance\'s namespaced kernel parameters as well as the containers.
The metadata that you apply to a resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
', 'refs' => [ 'Tags$member' => NULL, ], ], 'TagKey' => [ 'base' => NULL, 'refs' => [ 'Tag$key' => 'One part of a key-value pair that make up a tag. A key
is a general label that acts like a category for more specific tag values.
The keys of the tags to be removed.
', ], ], 'TagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'TagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'TagValue' => [ 'base' => NULL, 'refs' => [ 'Tag$value' => 'The optional part of a key-value pair that make up a tag. A value
acts as a descriptor within a tag category (key).
The metadata that you apply to the cluster to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
', 'ContainerInstance$tags' => 'The metadata that you apply to the container instance to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
', 'CreateClusterRequest$tags' => 'The metadata that you apply to the cluster to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
', 'CreateServiceRequest$tags' => 'The metadata that you apply to the service to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. When a service is deleted, the tags are deleted as well. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
', 'DescribeTaskDefinitionResponse$tags' => 'The metadata that is applied to the task definition to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
', 'ListTagsForResourceResponse$tags' => 'The tags for the resource.
', 'RegisterContainerInstanceRequest$tags' => 'The metadata that you apply to the container instance to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
', 'RegisterTaskDefinitionRequest$tags' => 'The metadata that you apply to the task definition to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
', 'RegisterTaskDefinitionResponse$tags' => 'The list of tags associated with the task definition.
', 'RunTaskRequest$tags' => 'The metadata that you apply to the task to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
', 'Service$tags' => 'The metadata that you apply to the service to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
', 'StartTaskRequest$tags' => 'The metadata that you apply to the task to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
', 'TagResourceRequest$tags' => 'The tags to add to the resource. A tag is an array of key-value pairs. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
', 'Task$tags' => 'The metadata that you apply to the task to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
', ], ], 'TargetNotFoundException' => [ 'base' => 'The specified target could not be found. You can view your available container instances with ListContainerInstances. Amazon ECS container instances are cluster-specific and Region-specific.
', 'refs' => [], ], 'TargetType' => [ 'base' => NULL, 'refs' => [ 'Attribute$targetType' => 'The type of the target with which to attach the attribute. This parameter is required if you use the short form ID for a resource instead of the full ARN.
', 'ListAttributesRequest$targetType' => 'The type of the target with which to list attributes.
', ], ], 'Task' => [ 'base' => 'Details on a task in a cluster.
', 'refs' => [ 'StopTaskResponse$task' => 'The task that was stopped.
', 'Tasks$member' => NULL, ], ], 'TaskDefinition' => [ 'base' => 'Details of a task definition.
', 'refs' => [ 'DeregisterTaskDefinitionResponse$taskDefinition' => 'The full description of the deregistered task.
', 'DescribeTaskDefinitionResponse$taskDefinition' => 'The full task definition description.
', 'RegisterTaskDefinitionResponse$taskDefinition' => 'The full description of the registered task definition.
', ], ], 'TaskDefinitionFamilyStatus' => [ 'base' => NULL, 'refs' => [ 'ListTaskDefinitionFamiliesRequest$status' => 'The task definition family status with which to filter the ListTaskDefinitionFamilies
results. By default, both ACTIVE
and INACTIVE
task definition families are listed. If this parameter is set to ACTIVE
, only task definition families that have an ACTIVE
task definition revision are returned. If this parameter is set to INACTIVE
, only task definition families that do not have any ACTIVE
task definition revisions are returned. If you paginate the resulting output, be sure to keep the status
value constant in each subsequent request.
Specifies whether to see the resource tags for the task definition. If TAGS
is specified, the tags are included in the response. If this field is omitted, tags are not included in the response.
An object representing a constraint on task placement in the task definition.
If you are using the Fargate launch type, task placement constraints are not supported.
For more information, see Task Placement Constraints in the Amazon Elastic Container Service Developer Guide.
', 'refs' => [ 'TaskDefinitionPlacementConstraints$member' => NULL, ], ], 'TaskDefinitionPlacementConstraintType' => [ 'base' => NULL, 'refs' => [ 'TaskDefinitionPlacementConstraint$type' => 'The type of constraint. The DistinctInstance
constraint ensures that each task in a particular group is running on a different container instance. The MemberOf
constraint restricts selection to be from a group of valid candidates.
An array of placement constraint objects to use for the task. You can specify a maximum of 10 constraints per task (this limit includes constraints in the task definition and those specified at runtime).
', 'TaskDefinition$placementConstraints' => 'An array of placement constraint objects to use for tasks. This field is not valid if you are using the Fargate launch type for your task.
', ], ], 'TaskDefinitionStatus' => [ 'base' => NULL, 'refs' => [ 'ListTaskDefinitionsRequest$status' => 'The task definition status with which to filter the ListTaskDefinitions
results. By default, only ACTIVE
task definitions are listed. By setting this parameter to INACTIVE
, you can view task definitions that are INACTIVE
as long as an active task or service still references them. If you paginate the resulting output, be sure to keep the status
value constant in each subsequent request.
The status of the task definition.
', ], ], 'TaskField' => [ 'base' => NULL, 'refs' => [ 'TaskFieldList$member' => NULL, ], ], 'TaskFieldList' => [ 'base' => NULL, 'refs' => [ 'DescribeTasksRequest$include' => 'Specifies whether you want to see the resource tags for the task. If TAGS
is specified, the tags are included in the response. If this field is omitted, tags are not included in the response.
The overrides associated with a task.
', 'refs' => [ 'RunTaskRequest$overrides' => 'A list of container overrides in JSON format that specify the name of a container in the specified task definition and the overrides it should receive. You can override the default command for a container (that is specified in the task definition or Docker image) with a command
override. You can also override existing environment variables (that are specified in the task definition or Docker image) on a container or add new environment variables to it with an environment
override.
A total of 8192 characters are allowed for overrides. This limit includes the JSON formatting characters of the override structure.
A list of container overrides in JSON format that specify the name of a container in the specified task definition and the overrides it should receive. You can override the default command for a container (that is specified in the task definition or Docker image) with a command
override. You can also override existing environment variables (that are specified in the task definition or Docker image) on a container or add new environment variables to it with an environment
override.
A total of 8192 characters are allowed for overrides. This limit includes the JSON formatting characters of the override structure.
One or more container overrides.
', ], ], 'TaskSet' => [ 'base' => 'Information about a set of Amazon ECS tasks in an AWS CodeDeploy deployment. An Amazon ECS task set includes details such as the desired number of tasks, how many tasks are running, and whether the task set serves production traffic.
', 'refs' => [ 'TaskSets$member' => NULL, ], ], 'TaskSets' => [ 'base' => NULL, 'refs' => [ 'Service$taskSets' => 'Information about a set of Amazon ECS tasks in an AWS CodeDeploy deployment. An Amazon ECS task set includes details such as the desired number of tasks, how many tasks are running, and whether the task set serves production traffic.
', ], ], 'TaskStopCode' => [ 'base' => NULL, 'refs' => [ 'Task$stopCode' => 'The stop code indicating why a task was stopped. The stoppedReason
may contain additional details.
The list of tasks.
', 'RunTaskResponse$tasks' => 'A full description of the tasks that were run. The tasks that were successfully placed on your cluster are described here.
', 'StartTaskResponse$tasks' => 'A full description of the tasks that were started. Each task that was successfully placed on your container instances is described.
', ], ], 'Timestamp' => [ 'base' => NULL, 'refs' => [ 'ContainerInstance$registeredAt' => 'The Unix timestamp for when the container instance was registered.
', 'Deployment$createdAt' => 'The Unix timestamp for when the service deployment was created.
', 'Deployment$updatedAt' => 'The Unix timestamp for when the service deployment was last updated.
', 'Service$createdAt' => 'The Unix timestamp for when the service was created.
', 'ServiceEvent$createdAt' => 'The Unix timestamp for when the event was triggered.
', 'SubmitTaskStateChangeRequest$pullStartedAt' => 'The Unix timestamp for when the container image pull began.
', 'SubmitTaskStateChangeRequest$pullStoppedAt' => 'The Unix timestamp for when the container image pull completed.
', 'SubmitTaskStateChangeRequest$executionStoppedAt' => 'The Unix timestamp for when the task execution stopped.
', 'Task$connectivityAt' => 'The Unix timestamp for when the task last went into CONNECTED
status.
The Unix timestamp for when the container image pull began.
', 'Task$pullStoppedAt' => 'The Unix timestamp for when the container image pull completed.
', 'Task$executionStoppedAt' => 'The Unix timestamp for when the task execution stopped.
', 'Task$createdAt' => 'The Unix timestamp for when the task was created (the task entered the PENDING
state).
The Unix timestamp for when the task started (the task transitioned from the PENDING
state to the RUNNING
state).
The Unix timestamp for when the task stops (transitions from the RUNNING
state to STOPPED
).
The Unix timestamp for when the task was stopped (the task transitioned from the RUNNING
state to the STOPPED
state).
The Unix timestamp for when the task set was created.
', 'TaskSet$updatedAt' => 'The Unix timestamp for when the task set was last updated.
', 'TaskSet$stabilityStatusAt' => 'The Unix timestamp for when the task set stability status was retrieved.
', ], ], 'Tmpfs' => [ 'base' => 'The container path, mount options, and size of the tmpfs mount.
', 'refs' => [ 'TmpfsList$member' => NULL, ], ], 'TmpfsList' => [ 'base' => NULL, 'refs' => [ 'LinuxParameters$tmpfs' => 'The container path, mount options, and size (in MiB) of the tmpfs mount. This parameter maps to the --tmpfs
option to docker run.
If you are using tasks that use the Fargate launch type, the tmpfs
parameter is not supported.
The protocol used for the network binding.
', 'PortMapping$protocol' => 'The protocol used for the port mapping. Valid values are tcp
and udp
. The default is tcp
.
The ulimit
settings to pass to the container.
A list of ulimits
to set in the container. This parameter maps to Ulimits
in the Create a container section of the Docker Remote API and the --ulimit
option to docker run. Valid naming values are displayed in the Ulimit data type. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format \'{{.Server.APIVersion}}\'
This parameter is not supported for Windows containers.
The type
of the ulimit
.
The specified task is not supported in this Region.
', 'refs' => [], ], 'UntagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UntagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateContainerAgentRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateContainerAgentResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateContainerInstancesStateRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateContainerInstancesStateResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateInProgressException' => [ 'base' => 'There is already a current Amazon ECS container agent update in progress on the specified container instance. If the container agent becomes disconnected while it is in a transitional stage, such as PENDING
or STAGING
, the update process can get stuck in that state. However, when the agent reconnects, it resumes where it stopped previously.
The Docker and Amazon ECS container agent version information about a container instance.
', 'refs' => [ 'ContainerInstance$versionInfo' => 'The version information for the Amazon ECS container agent and Docker daemon running on the container instance.
', 'RegisterContainerInstanceRequest$versionInfo' => 'The version information for the Amazon ECS container agent and Docker daemon running on the container instance.
', ], ], 'Volume' => [ 'base' => 'A data volume used in a task definition. For tasks that use a Docker volume, specify a DockerVolumeConfiguration
. For tasks that use a bind mount host volume, specify a host
and optional sourcePath
. For more information, see Using Data Volumes in Tasks.
Details on a data volume from another container in the same task definition.
', 'refs' => [ 'VolumeFromList$member' => NULL, ], ], 'VolumeFromList' => [ 'base' => NULL, 'refs' => [ 'ContainerDefinition$volumesFrom' => 'Data volumes to mount from another container. This parameter maps to VolumesFrom
in the Create a container section of the Docker Remote API and the --volumes-from
option to docker run.
A list of volume definitions in JSON format that containers in your task may use.
', 'TaskDefinition$volumes' => 'The list of volumes in a task.
If you are using the Fargate launch type, the host
and sourcePath
parameters are not supported.
For more information about volume definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon Elastic Container Service Developer Guide.
', ], ], ],];