Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet...

297
Amazon Elastic MapReduce API Reference API Version 2009-03-31

Transcript of Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet...

Page 1: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduceAPI Reference

API Version 2009-03-31

Page 2: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API Reference

Amazon Elastic MapReduce: API ReferenceCopyright © Amazon Web Services, Inc. and/or its affiliates. All rights reserved.

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

Page 3: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API Reference

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

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

AddInstanceGroups .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9Examples .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

AddJobFlowSteps .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12Examples .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

AddTags .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15Examples .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

CancelSteps .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19Examples .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

CreateSecurityConfiguration .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

CreateStudio .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

API Version 2009-03-31iii

Page 4: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API Reference

CreateStudioSessionMapping .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

DeleteSecurityConfiguration .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

DeleteStudio .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

DeleteStudioSessionMapping .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

DescribeCluster ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39

DescribeJobFlows .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43Examples .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44

DescribeNotebookExecution .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47

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

DescribeStep .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50

API Version 2009-03-31iv

Page 5: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API Reference

Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51

DescribeStudio .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53

GetBlockPublicAccessConfiguration .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55

GetManagedScalingPolicy .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

GetStudioSessionMapping .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59

ListBootstrapActions .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62

ListClusters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65

ListInstanceFleets ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68

ListInstanceGroups .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72

API Version 2009-03-31v

Page 6: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API Reference

ListInstances .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75

ListNotebookExecutions .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78

ListSecurityConfigurations .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80

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

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

ListStudioSessionMappings .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87

ModifyCluster ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90

ModifyInstanceFleet ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92

ModifyInstanceGroups .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93

API Version 2009-03-31vi

Page 7: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API Reference

Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94Examples .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94

PutAutoScalingPolicy .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98

PutBlockPublicAccessConfiguration .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101

PutManagedScalingPolicy .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102

RemoveAutoScalingPolicy .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104

RemoveManagedScalingPolicy .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106

RemoveTags .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107Examples .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110

RunJobFlow .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121Examples .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122

SetTerminationProtection .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124Examples .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124

API Version 2009-03-31vii

Page 8: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API Reference

See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124SetVisibleToAllUsers ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126

Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126Examples .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127

StartNotebookExecution .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131

StopNotebookExecution .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133

TerminateJobFlows .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135Examples .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136

UpdateStudio .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138

UpdateStudioSessionMapping .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140

Data Types .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142Application .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145

Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145

AutoScalingPolicy .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146

AutoScalingPolicyDescription .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147

AutoScalingPolicyStateChangeReason .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148

AutoScalingPolicyStatus .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149

BlockPublicAccessConfiguration .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150

API Version 2009-03-31viii

Page 9: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API Reference

Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150

BlockPublicAccessConfigurationMetadata .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151

BootstrapActionConfig .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152

BootstrapActionDetail .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153

CancelStepsInfo .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154

CloudWatchAlarmDefinition .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156

Cluster ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161

ClusterStateChangeReason .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163

ClusterStatus .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164

ClusterSummary .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166

ClusterTimeline .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167

Command .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168

ComputeLimits ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170

Configuration .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171

EbsBlockDevice .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172

EbsBlockDeviceConfig .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173

EbsConfiguration .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174

EbsVolume .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175

Ec2InstanceAttributes .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177

ExecutionEngineConfig .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179

API Version 2009-03-31ix

Page 10: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API Reference

Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179

FailureDetails ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180

HadoopJarStepConfig .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181

HadoopStepConfig .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183

Instance .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185

InstanceFleet ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188

InstanceFleetConfig .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190

InstanceFleetModifyConfig .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191

InstanceFleetProvisioningSpecifications .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192

InstanceFleetStateChangeReason .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193

InstanceFleetStatus .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194

InstanceFleetTimeline .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196

InstanceGroup .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199

InstanceGroupConfig .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201

InstanceGroupDetail .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204

InstanceGroupModifyConfig .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205

InstanceGroupStateChangeReason .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207

InstanceGroupStatus .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208

InstanceGroupTimeline .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209

InstanceResizePolicy .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210

API Version 2009-03-31x

Page 11: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API Reference

Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210

InstanceStateChangeReason .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211

InstanceStatus .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212

InstanceTimeline .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213

InstanceTypeConfig .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215

InstanceTypeSpecification .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217

JobFlowDetail .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220

JobFlowExecutionStatusDetail .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223

JobFlowInstancesConfig .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227

JobFlowInstancesDetail .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230

KerberosAttributes .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232

KeyValue .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233

ManagedScalingPolicy .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234

MetricDimension .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235

NotebookExecution .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238

NotebookExecutionSummary .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240

OnDemandCapacityReservationOptions .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241

OnDemandProvisioningSpecification .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243

PlacementGroupConfig .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244

PlacementType .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245

API Version 2009-03-31xi

Page 12: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API Reference

Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245

PortRange .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246

ScalingAction .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247

ScalingConstraints ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248

ScalingRule .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249

ScalingTrigger .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250

ScriptBootstrapActionConfig .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251

SecurityConfigurationSummary .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252

SessionMappingDetail .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254

SessionMappingSummary .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256

ShrinkPolicy .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257

SimpleScalingPolicyConfiguration .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258

SpotProvisioningSpecification .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261

Step .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 263

StepConfig .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264

StepDetail .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266

StepExecutionStatusDetail .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267

StepStateChangeReason .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269

StepStatus .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 270Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 270See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 270

StepSummary .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 271

API Version 2009-03-31xii

Page 13: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API Reference

Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 271See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 271

StepTimeline .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 272Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 272See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 272

Studio .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 273Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 273See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275

StudioSummary .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 276Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 276See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 277

SupportedProductConfig .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278

Tag .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 279Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 279See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 279

VolumeSpecification .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280

Common Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281Common Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283

API Version 2009-03-31xiii

Page 14: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API Reference

WelcomeAmazon EMR is a web service that makes it easier to process large amounts of data efficiently. AmazonEMR uses Hadoop processing combined with several AWS services to do tasks such as web indexing, datamining, log file analysis, machine learning, scientific simulation, and data warehouse management.

This document was last published on May 12, 2021.

API Version 2009-03-311

Page 15: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API Reference

ActionsThe following actions are supported:

• AddInstanceFleet (p. 4)• AddInstanceGroups (p. 7)• AddJobFlowSteps (p. 11)• AddTags (p. 15)• CancelSteps (p. 18)• CreateSecurityConfiguration (p. 22)• CreateStudio (p. 24)• CreateStudioSessionMapping (p. 28)• DeleteSecurityConfiguration (p. 31)• DeleteStudio (p. 33)• DeleteStudioSessionMapping (p. 35)• DescribeCluster (p. 37)• DescribeJobFlows (p. 40)• DescribeNotebookExecution (p. 46)• DescribeSecurityConfiguration (p. 48)• DescribeStep (p. 50)• DescribeStudio (p. 52)• GetBlockPublicAccessConfiguration (p. 54)• GetManagedScalingPolicy (p. 56)• GetStudioSessionMapping (p. 58)• ListBootstrapActions (p. 61)• ListClusters (p. 63)• ListInstanceFleets (p. 66)• ListInstanceGroups (p. 69)• ListInstances (p. 73)• ListNotebookExecutions (p. 76)• ListSecurityConfigurations (p. 79)• ListSteps (p. 81)• ListStudios (p. 84)• ListStudioSessionMappings (p. 86)• ModifyCluster (p. 89)• ModifyInstanceFleet (p. 91)• ModifyInstanceGroups (p. 93)• PutAutoScalingPolicy (p. 96)• PutBlockPublicAccessConfiguration (p. 100)• PutManagedScalingPolicy (p. 102)• RemoveAutoScalingPolicy (p. 104)• RemoveManagedScalingPolicy (p. 106)• RemoveTags (p. 107)• RunJobFlow (p. 111)

API Version 2009-03-312

Page 16: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API Reference

• SetTerminationProtection (p. 123)• SetVisibleToAllUsers (p. 126)• StartNotebookExecution (p. 129)• StopNotebookExecution (p. 133)• TerminateJobFlows (p. 135)• UpdateStudio (p. 137)• UpdateStudioSessionMapping (p. 139)

API Version 2009-03-313

Page 17: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceAddInstanceFleet

AddInstanceFleetAdds an instance fleet to a running cluster.

NoteThe instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later,excluding 5.0.x.

Request Syntax{ "ClusterId": "string", "InstanceFleet": { "InstanceFleetType": "string", "InstanceTypeConfigs": [ { "BidPrice": "string", "BidPriceAsPercentageOfOnDemandPrice": number, "Configurations": [ { "Classification": "string", "Configurations": [ "Configuration" ], "Properties": { "string" : "string" } } ], "EbsConfiguration": { "EbsBlockDeviceConfigs": [ { "VolumeSpecification": { "Iops": number, "SizeInGB": number, "VolumeType": "string" }, "VolumesPerInstance": number } ], "EbsOptimized": boolean }, "InstanceType": "string", "WeightedCapacity": number } ], "LaunchSpecifications": { "OnDemandSpecification": { "AllocationStrategy": "string", "CapacityReservationOptions": { "CapacityReservationPreference": "string", "CapacityReservationResourceGroupArn": "string", "UsageStrategy": "string" } }, "SpotSpecification": { "AllocationStrategy": "string", "BlockDurationMinutes": number, "TimeoutAction": "string", "TimeoutDurationMinutes": number } }, "Name": "string",

API Version 2009-03-314

Page 18: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceRequest Parameters

"TargetOnDemandCapacity": number, "TargetSpotCapacity": number }}

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

The request accepts the following data in JSON format.

ClusterId (p. 4)

The unique identifier of the cluster.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: YesInstanceFleet (p. 4)

Specifies the configuration of the instance fleet.

Type: InstanceFleetConfig (p. 189) object

Required: Yes

Response Syntax{ "ClusterArn": "string", "ClusterId": "string", "InstanceFleetId": "string"}

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

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

ClusterArn (p. 5)

The Amazon Resource Name of the cluster.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.ClusterId (p. 5)

The unique identifier of the cluster.

Type: String

API Version 2009-03-315

Page 19: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceErrors

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*InstanceFleetId (p. 5)

The unique identifier of the instance fleet.

Type: String

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

InternalServerException

This exception occurs when there is an internal failure in the Amazon EMR service.

HTTP Status Code: 500InvalidRequestException

This exception occurs when there is something wrong with user input.

HTTP Status Code: 400

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

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

API Version 2009-03-316

Page 20: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceAddInstanceGroups

AddInstanceGroupsAdds one or more instance groups to a running cluster.

Request Syntax{ "InstanceGroups": [ { "AutoScalingPolicy": { "Constraints": { "MaxCapacity": number, "MinCapacity": number }, "Rules": [ { "Action": { "Market": "string", "SimpleScalingPolicyConfiguration": { "AdjustmentType": "string", "CoolDown": number, "ScalingAdjustment": number } }, "Description": "string", "Name": "string", "Trigger": { "CloudWatchAlarmDefinition": { "ComparisonOperator": "string", "Dimensions": [ { "Key": "string", "Value": "string" } ], "EvaluationPeriods": number, "MetricName": "string", "Namespace": "string", "Period": number, "Statistic": "string", "Threshold": number, "Unit": "string" } } } ] }, "BidPrice": "string", "Configurations": [ { "Classification": "string", "Configurations": [ "Configuration" ], "Properties": { "string" : "string" } } ], "EbsConfiguration": { "EbsBlockDeviceConfigs": [ { "VolumeSpecification": {

API Version 2009-03-317

Page 21: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceRequest Parameters

"Iops": number, "SizeInGB": number, "VolumeType": "string" }, "VolumesPerInstance": number } ], "EbsOptimized": boolean }, "InstanceCount": number, "InstanceRole": "string", "InstanceType": "string", "Market": "string", "Name": "string" } ], "JobFlowId": "string"}

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

The request accepts the following data in JSON format.

InstanceGroups (p. 7)

Instance groups to add.

Type: Array of InstanceGroupConfig (p. 200) objects

Required: YesJobFlowId (p. 7)

Job flow in which to add the instance groups.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: Yes

Response Syntax{ "ClusterArn": "string", "InstanceGroupIds": [ "string" ], "JobFlowId": "string"}

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

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

API Version 2009-03-318

Page 22: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceErrors

ClusterArn (p. 8)

The Amazon Resource Name of the cluster.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.InstanceGroupIds (p. 8)

Instance group IDs of the newly created instance groups.

Type: Array of strings

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*JobFlowId (p. 8)

The job flow ID in which the instance groups are added.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

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

InternalServerError

Indicates that an error occurred while processing the request and that the request was notcompleted.

HTTP Status Code: 400

ExamplesExampleThis example illustrates one usage of AddInstanceGroups.

Sample Request

POST / HTTP/1.1Content-Type: application/x-amz-json-1.1X-Amz-Target: ElasticMapReduce.AddInstanceGroupsContent-Length: 168User-Agent: aws-sdk-ruby/1.9.2 ruby/1.9.3 i386-mingw32Host: us-east-1.elasticmapreduce.amazonaws.comX-Amz-Date: 20130715T223346ZX-Amz-Content-Sha256: ac5a7193b1283898dd822a4b16ca36963879bb010d2dbe57198439973ab2a7d3Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20130715/us-east-1/elasticmapreduce/aws4_request, SignedHeaders=content-length;content-type;host;user-agent;x-amz-content-sha256;x-amz-date;x-amz-target, Signature=4c5e7eb762ea45f292a5cd1a1cc56ed60009e19a9dba3d6e5e4e67e96d43af11

API Version 2009-03-319

Page 23: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceSee Also

Accept: */*

{ "JobFlowId": "j-3U7TSX5GZFD8Y", "InstanceGroups": [{ "Name": "Task Instance Group", "InstanceRole": "TASK", "InstanceCount": 2, "InstanceType": "m1.small", "Market": "ON_DEMAND" }]}

Sample Response

HTTP/1.1 200 OKx-amzn-RequestId: 9da5a349-ed9e-11e2-90db-69a5154aeb8dContent-Type: application/x-amz-json-1.1Content-Length: 71Date: Mon, 15 Jul 2013 22:33:47 GMT

{ "InstanceGroupIds": ["ig-294A6A2KWT4WB"], "JobFlowId": "j-3U7TSX5GZFD8Y"}

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

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

API Version 2009-03-3110

Page 24: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceAddJobFlowSteps

AddJobFlowStepsAddJobFlowSteps adds new steps to a running cluster. A maximum of 256 steps are allowed in each jobflow.

If your cluster is long-running (such as a Hive data warehouse) or complex, you may require more than256 steps to process your data. You can bypass the 256-step limitation in various ways, including usingSSH to connect to the master node and submitting queries directly to the software running on themaster node, such as Hive and Hadoop. For more information on how to do this, see Add More than 256Steps to a Cluster in the Amazon EMR Management Guide.

A step specifies the location of a JAR file stored either on the master node of the cluster or in AmazonS3. Each step is performed by the main function of the main class of the JAR file. The main class can bespecified either in the manifest of the JAR or by using the MainFunction parameter of the step.

Amazon EMR executes each step in the order listed. For a step to be considered complete, the mainfunction must exit with a zero exit code and all Hadoop jobs started while the step was running musthave completed and run successfully.

You can only add steps to a cluster that is in one of the following states: STARTING, BOOTSTRAPPING,RUNNING, or WAITING.

Request Syntax{ "JobFlowId": "string", "Steps": [ { "ActionOnFailure": "string", "HadoopJarStep": { "Args": [ "string" ], "Jar": "string", "MainClass": "string", "Properties": [ { "Key": "string", "Value": "string" } ] }, "Name": "string" } ]}

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

The request accepts the following data in JSON format.

JobFlowId (p. 11)

A string that uniquely identifies the job flow. This identifier is returned by RunJobFlow (p. 111) andcan also be obtained from ListClusters (p. 63).

Type: String

API Version 2009-03-3111

Page 25: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceResponse Syntax

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: YesSteps (p. 11)

A list of StepConfig (p. 264) to be executed by the job flow.

Type: Array of StepConfig (p. 264) objects

Required: Yes

Response Syntax{ "StepIds": [ "string" ]}

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

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

StepIds (p. 12)

The identifiers of the list of steps added to the job flow.

Type: Array of strings

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

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

InternalServerError

Indicates that an error occurred while processing the request and that the request was notcompleted.

HTTP Status Code: 400

ExamplesExampleThis example illustrates one usage of AddJobFlowSteps.

Sample Request

POST / HTTP/1.1

API Version 2009-03-3112

Page 26: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceSee Also

Content-Type: application/x-amz-json-1.1X-Amz-Target: ElasticMapReduce.AddJobFlowStepsContent-Length: 426User-Agent: aws-sdk-ruby/1.9.2 ruby/1.9.3 i386-mingw32Host: us-east-1.elasticmapreduce.amazonaws.comX-Amz-Date: 20130716T210948ZX-Amz-Content-Sha256: 9e5ad0a93c22224947ce98eea94f766103d91b28fa82eb60d0cb8b6f9555a6b2Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20130716/us-east-1/elasticmapreduce/aws4_request, SignedHeaders=content-length;content-type;host;user-agent;x-amz-content-sha256;x-amz-date;x-amz-target, Signature=2a2393390760ae85eb74ee3a539e1d758bfdd8815a1a6d6f14d4a2fbcfdcd5b7Accept: */*

{ "JobFlowId": "j-3TS0OIYO4NFN", "Steps": [{ "Name": "Example Jar Step", "ActionOnFailure": "CANCEL_AND_WAIT", "HadoopJarStep": { "Jar": "s3n:\\/\\/elasticmapreduce\\/samples\\/cloudburst\\/cloudburst.jar", "Args": [ "s3n:\\/\\/elasticmapreduce\\/samples\\/cloudburst\\/input\\/s_suis.br", "s3n:\\/\\/elasticmapreduce\\/samples\\/cloudburst\\/input\\/100k.br", "s3n:\\/\\/examples-bucket\\/cloudburst\\/output", "36", "3", "0", "1", "240", "48", "24", "24", "128", "16" ] } }]}

Sample Response

HTTP/1.1 200 OKx-amzn-RequestId: 6514261f-ee5b-11e2-9345-5332e9ab2e6dContent-Type: application/x-amz-json-1.1Content-Length: 0Date: Tue, 16 Jul 2013 21:05:07 GMT

{ "StepIds": [ "s-1XXXXXXXXXXA" ]}

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

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

API Version 2009-03-3113

Page 28: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceAddTags

AddTagsAdds tags to an Amazon EMR resource. Tags make it easier to associate clusters in various ways, such asgrouping clusters to track your Amazon EMR resource allocation costs. For more information, see TagClusters.

Request Syntax{ "ResourceId": "string", "Tags": [ { "Key": "string", "Value": "string" } ]}

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

The request accepts the following data in JSON format.

ResourceId (p. 15)

The Amazon EMR resource identifier to which tags will be added. This value must be a clusteridentifier.

Type: String

Required: YesTags (p. 15)

A list of tags to associate with a cluster and propagate to EC2 instances. Tags are user-defined key-value pairs that consist of a required key string with a maximum of 128 characters, and an optionalvalue string with a maximum of 256 characters.

Type: Array of Tag (p. 279) objects

Required: Yes

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

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

InternalServerException

This exception occurs when there is an internal failure in the Amazon EMR service.

API Version 2009-03-3115

Page 29: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceExamples

HTTP Status Code: 500InvalidRequestException

This exception occurs when there is something wrong with user input.

HTTP Status Code: 400

Examples

ExampleThis example illustrates one usage of AddTags.

Sample Request

POST / HTTP/1.1 Content-Type: application/x-amz-json-1.1 X-Amz-Target: ElasticMapReduce.AddTags AUTHPARAMS { "ResourceId": "j-3U7TSX5GZFD8Y", "Tags": [{ "Key": "stack", "Value": "Production" }, { "Key": "hbase" }] }

Sample Response

HTTP/1.1 200 OK

API Version 2009-03-3116

Page 30: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceSee Also

x-amzn-RequestId: 9da5a349-ed9e-11e2-90db-69a5154aeb8d Content-Type: application/x-amz-json-1.1 Content-Length: 71 Date: Mon, 15 Jul 2013 22:33:47 GMT { }

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

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

API Version 2009-03-3117

Page 31: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceCancelSteps

CancelStepsCancels a pending step or steps in a running cluster. Available only in Amazon EMR versions 4.8.0and later, excluding version 5.0.0. A maximum of 256 steps are allowed in each CancelSteps request.CancelSteps is idempotent but asynchronous; it does not guarantee that a step will be canceled, even ifthe request is successfully submitted. You can only cancel steps that are in a PENDING state.

Request Syntax{ "ClusterId": "string", "StepCancellationOption": "string", "StepIds": [ "string" ]}

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

The request accepts the following data in JSON format.

ClusterId (p. 18)

The ClusterID for the specified steps that will be canceled. Use RunJobFlow (p. 111) andListClusters (p. 63) to get ClusterIDs.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: Yes

StepCancellationOption (p. 18)

The option to choose to cancel RUNNING steps. By default, the value is SEND_INTERRUPT.

Type: String

Valid Values: SEND_INTERRUPT | TERMINATE_PROCESS

Required: No

StepIds (p. 18)

The list of StepIDs to cancel. Use ListSteps (p. 81) to get steps and their states for the specifiedcluster.

Type: Array of strings

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: Yes

API Version 2009-03-3118

Page 32: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceResponse Syntax

Response Syntax{ "CancelStepsInfoList": [ { "Reason": "string", "Status": "string", "StepId": "string" } ]}

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

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

CancelStepsInfoList (p. 19)

A list of CancelStepsInfo (p. 154), which shows the status of specified cancel requests for eachStepID specified.

Type: Array of CancelStepsInfo (p. 154) objects

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

InternalServerError

Indicates that an error occurred while processing the request and that the request was notcompleted.

HTTP Status Code: 400InvalidRequestException

This exception occurs when there is something wrong with user input.

HTTP Status Code: 400

Examples

ExampleThis example illustrates one usage of CancelSteps.

Sample Request

POST / HTTP/1.1Content-Type: application/x-amz-json-1.1X-Amz-Target: ElasticMapReduce.CancelStepsUser-Agent: aws-sdk-ruby/1.9.2 ruby/1.9.3 i386-mingw32Host: us-east-1.elasticmapreduce.amazonaws.com

API Version 2009-03-3119

Page 33: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceSee Also

X-Amz-Date: 20160719T224800ZX-Amz-Content-Sha256: 9e5ad0a93c22224947ce98eea94f766103d91b28fa82eb60d0cb8b6f9555a6b2Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20160719/us-east-1/elasticmapreduce/aws4_request, SignedHeaders=content-length;content-type;host;user-agent;x-amz-content-sha256;x-amz-date;x-amz-target, Signature=2a2393390760ae85eb74ee3a539e1d758bfdd8815a1a6d6f14d4a2fbcfdcd5b7Accept: */*

{ "ClusterId": "j-2G7RS6DJZE39D", "StepIds": [ "s-11B5G7VIKHCZQ", "s-23PUT0NR3XF6O", "s-2NUYMUZ3ADACC", "s-10O5XO5JUY9OE", "s-CS88G2XK4N7X", "s-2M366D3KU4OTZ" ]}

Sample Response

HTTP/1.1 200 OKx-amzn-RequestId: 84931a23-4e03-11e6-b2bd-0db72d19890aContent-Type: application/x-amz-json-1.1Date: Tue, 19 Jul 2016 15:31:01 GMT

{ "CancelStepsInfoList": [ {"Reason": "This step cannot be cancelled.", "Status": "FAILED", "StepId": "s-11B5G7VIKHCZQ"}, {"Reason": "Cannot cancel the step. It is already COMPLETED.", "Status": "FAILED", "StepId": "s-23PUT0NR3XF6O"}, {"Reason": "Cannot cancel the step. It is already CANCELLED.", "Status": "FAILED", "StepId": "s-2NUYMUZ3ADACC"}, {"Reason": "Cannot cancel the step. It is already RUNNING.", "Status": "FAILED", "StepId": "s-10O5XO5JUY9OE"}, {"Reason": "Cannot cancel the step. It is already FAILED.", "Status": "FAILED", "StepId": "s-CS88G2XK4N7X"}, {"Reason": "", "Status": "SUBMITTED", "StepId": "s-2M366D3KU4OTZ"} ]}

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

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

API Version 2009-03-3120

Page 35: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceCreateSecurityConfiguration

CreateSecurityConfigurationCreates a security configuration, which is stored in the service and can be specified when a cluster iscreated.

Request Syntax{ "Name": "string", "SecurityConfiguration": "string"}

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

The request accepts the following data in JSON format.

Name (p. 22)

The name of the security configuration.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: YesSecurityConfiguration (p. 22)

The security configuration details in JSON format. For JSON parameters and examples, see UseSecurity Configurations to Set Up Cluster Security in the Amazon EMR Management Guide.

Type: String

Required: Yes

Response Syntax{ "CreationDateTime": number, "Name": "string"}

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

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

CreationDateTime (p. 22)

The date and time the security configuration was created.

API Version 2009-03-3122

Page 36: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceErrors

Type: TimestampName (p. 22)

The name of the security configuration.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

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

InternalServerException

This exception occurs when there is an internal failure in the Amazon EMR service.

HTTP Status Code: 500InvalidRequestException

This exception occurs when there is something wrong with user input.

HTTP Status Code: 400

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

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

API Version 2009-03-3123

Page 37: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceCreateStudio

CreateStudioCreates a new Amazon EMR Studio.

Request Syntax{ "AuthMode": "string", "DefaultS3Location": "string", "Description": "string", "EngineSecurityGroupId": "string", "Name": "string", "ServiceRole": "string", "SubnetIds": [ "string" ], "Tags": [ { "Key": "string", "Value": "string" } ], "UserRole": "string", "VpcId": "string", "WorkspaceSecurityGroupId": "string"}

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

The request accepts the following data in JSON format.

AuthMode (p. 24)

Specifies whether the Studio authenticates users using single sign-on (SSO) or IAM. Amazon EMRStudio currently only supports SSO authentication.

Type: String

Valid Values: SSO | IAM

Required: YesDefaultS3Location (p. 24)

The Amazon S3 location to back up Amazon EMR Studio Workspaces and notebook files.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: YesDescription (p. 24)

A detailed description of the Amazon EMR Studio.

Type: String

API Version 2009-03-3124

Page 38: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceRequest Parameters

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: NoEngineSecurityGroupId (p. 24)

The ID of the Amazon EMR Studio Engine security group. The Engine security group allows inboundnetwork traffic from the Workspace security group, and it must be in the same VPC specified byVpcId.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: YesName (p. 24)

A descriptive name for the Amazon EMR Studio.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: YesServiceRole (p. 24)

The IAM role that will be assumed by the Amazon EMR Studio. The service role provides a way forAmazon EMR Studio to interoperate with other AWS services.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: YesSubnetIds (p. 24)

A list of subnet IDs to associate with the Amazon EMR Studio. A Studio can have a maximum of5 subnets. The subnets must belong to the VPC specified by VpcId. Studio users can create aWorkspace in any of the specified subnets.

Type: Array of strings

Required: YesTags (p. 24)

A list of tags to associate with the Amazon EMR Studio. Tags are user-defined key-value pairs thatconsist of a required key string with a maximum of 128 characters, and an optional value string witha maximum of 256 characters.

Type: Array of Tag (p. 279) objects

Required: No

API Version 2009-03-3125

Page 39: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceResponse Syntax

UserRole (p. 24)

The IAM user role that will be assumed by users and groups logged in to an Amazon EMR Studio.The permissions attached to this IAM role can be scoped down for each user or group using sessionpolicies.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: YesVpcId (p. 24)

The ID of the Amazon Virtual Private Cloud (Amazon VPC) to associate with the Studio.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: YesWorkspaceSecurityGroupId (p. 24)

The ID of the Amazon EMR Studio Workspace security group. The Workspace security group allowsoutbound network traffic to resources in the Engine security group, and it must be in the same VPCspecified by VpcId.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: Yes

Response Syntax{ "StudioId": "string", "Url": "string"}

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

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

StudioId (p. 26)

The ID of the Amazon EMR Studio.

Type: String

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

API Version 2009-03-3126

Page 40: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceErrors

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*Url (p. 26)

The unique Studio access URL.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

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

InternalServerException

This exception occurs when there is an internal failure in the Amazon EMR service.

HTTP Status Code: 500InvalidRequestException

This exception occurs when there is something wrong with user input.

HTTP Status Code: 400

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

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

API Version 2009-03-3127

Page 41: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceCreateStudioSessionMapping

CreateStudioSessionMappingMaps a user or group to the Amazon EMR Studio specified by StudioId, and applies a session policy torefine Studio permissions for that user or group.

Request Syntax{ "IdentityId": "string", "IdentityName": "string", "IdentityType": "string", "SessionPolicyArn": "string", "StudioId": "string"}

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

The request accepts the following data in JSON format.

IdentityId (p. 28)

The globally unique identifier (GUID) of the user or group from the AWS SSO Identity Store. Formore information, see UserId and GroupId in the AWS SSO Identity Store API Reference. EitherIdentityName or IdentityId must be specified.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: NoIdentityName (p. 28)

The name of the user or group. For more information, see UserName and DisplayName in the AWSSSO Identity Store API Reference. Either IdentityName or IdentityId must be specified.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: NoIdentityType (p. 28)

Specifies whether the identity to map to the Amazon EMR Studio is a user or a group.

Type: String

Valid Values: USER | GROUP

Required: Yes

API Version 2009-03-3128

Page 42: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceResponse Elements

SessionPolicyArn (p. 28)

The Amazon Resource Name (ARN) for the session policy that will be applied to the user or group.Session policies refine Studio user permissions without the need to use multiple IAM user roles.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: YesStudioId (p. 28)

The ID of the Amazon EMR Studio to which the user or group will be mapped.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: Yes

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

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

InternalServerError

Indicates that an error occurred while processing the request and that the request was notcompleted.

HTTP Status Code: 400InvalidRequestException

This exception occurs when there is something wrong with user input.

HTTP Status Code: 400

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

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

API Version 2009-03-3129

Page 44: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceDeleteSecurityConfiguration

DeleteSecurityConfigurationDeletes a security configuration.

Request Syntax{ "Name": "string"}

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

The request accepts the following data in JSON format.

Name (p. 31)

The name of the security configuration.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: Yes

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

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

InternalServerException

This exception occurs when there is an internal failure in the Amazon EMR service.

HTTP Status Code: 500InvalidRequestException

This exception occurs when there is something wrong with user input.

HTTP Status Code: 400

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

• AWS Command Line Interface

API Version 2009-03-3131

Page 46: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceDeleteStudio

DeleteStudioRemoves an Amazon EMR Studio from the Studio metadata store.

Request Syntax{ "StudioId": "string"}

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

The request accepts the following data in JSON format.

StudioId (p. 33)

The ID of the Amazon EMR Studio.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: Yes

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

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

InternalServerException

This exception occurs when there is an internal failure in the Amazon EMR service.

HTTP Status Code: 500InvalidRequestException

This exception occurs when there is something wrong with user input.

HTTP Status Code: 400

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

• AWS Command Line Interface

API Version 2009-03-3133

Page 48: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceDeleteStudioSessionMapping

DeleteStudioSessionMappingRemoves a user or group from an Amazon EMR Studio.

Request Syntax{ "IdentityId": "string", "IdentityName": "string", "IdentityType": "string", "StudioId": "string"}

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

The request accepts the following data in JSON format.

IdentityId (p. 35)

The globally unique identifier (GUID) of the user or group to remove from the Amazon EMR Studio.For more information, see UserId and GroupId in the AWS SSO Identity Store API Reference. EitherIdentityName or IdentityId must be specified.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: NoIdentityName (p. 35)

The name of the user name or group to remove from the Amazon EMR Studio. For moreinformation, see UserName and DisplayName in the AWS SSO Identity Store API Reference. EitherIdentityName or IdentityId must be specified.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: NoIdentityType (p. 35)

Specifies whether the identity to delete from the Amazon EMR Studio is a user or a group.

Type: String

Valid Values: USER | GROUP

Required: YesStudioId (p. 35)

The ID of the Amazon EMR Studio.

API Version 2009-03-3135

Page 49: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceResponse Elements

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: Yes

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

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

InternalServerError

Indicates that an error occurred while processing the request and that the request was notcompleted.

HTTP Status Code: 400InvalidRequestException

This exception occurs when there is something wrong with user input.

HTTP Status Code: 400

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

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

API Version 2009-03-3136

Page 50: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceDescribeCluster

DescribeClusterProvides cluster-level details including status, hardware and software configuration, VPC settings, and soon.

For information about the cluster steps, see ListSteps (p. 81).

Request Syntax

{ "ClusterId": "string"}

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

The request accepts the following data in JSON format.

ClusterId (p. 37)

The identifier of the cluster to describe.

Type: String

Required: Yes

Response Syntax

{ "Cluster": { "Applications": [ { "AdditionalInfo": { "string" : "string" }, "Args": [ "string" ], "Name": "string", "Version": "string" } ], "AutoScalingRole": "string", "AutoTerminate": boolean, "ClusterArn": "string", "Configurations": [ { "Classification": "string", "Configurations": [ "Configuration" ], "Properties": { "string" : "string" } }

API Version 2009-03-3137

Page 51: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceResponse Syntax

], "CustomAmiId": "string", "EbsRootVolumeSize": number, "Ec2InstanceAttributes": { "AdditionalMasterSecurityGroups": [ "string" ], "AdditionalSlaveSecurityGroups": [ "string" ], "Ec2AvailabilityZone": "string", "Ec2KeyName": "string", "Ec2SubnetId": "string", "EmrManagedMasterSecurityGroup": "string", "EmrManagedSlaveSecurityGroup": "string", "IamInstanceProfile": "string", "RequestedEc2AvailabilityZones": [ "string" ], "RequestedEc2SubnetIds": [ "string" ], "ServiceAccessSecurityGroup": "string" }, "Id": "string", "InstanceCollectionType": "string", "KerberosAttributes": { "ADDomainJoinPassword": "string", "ADDomainJoinUser": "string", "CrossRealmTrustPrincipalPassword": "string", "KdcAdminPassword": "string", "Realm": "string" }, "LogEncryptionKmsKeyId": "string", "LogUri": "string", "MasterPublicDnsName": "string", "Name": "string", "NormalizedInstanceHours": number, "OutpostArn": "string", "PlacementGroups": [ { "InstanceRole": "string", "PlacementStrategy": "string" } ], "ReleaseLabel": "string", "RepoUpgradeOnBoot": "string", "RequestedAmiVersion": "string", "RunningAmiVersion": "string", "ScaleDownBehavior": "string", "SecurityConfiguration": "string", "ServiceRole": "string", "Status": { "State": "string", "StateChangeReason": { "Code": "string", "Message": "string" }, "Timeline": { "CreationDateTime": number, "EndDateTime": number, "ReadyDateTime": number } }, "StepConcurrencyLevel": number, "Tags": [ { "Key": "string", "Value": "string" } ], "TerminationProtected": boolean, "VisibleToAllUsers": boolean }

API Version 2009-03-3138

Page 52: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceResponse Elements

}

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

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

Cluster (p. 37)

This output contains the details for the requested cluster.

Type: Cluster (p. 157) object

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

InternalServerException

This exception occurs when there is an internal failure in the Amazon EMR service.

HTTP Status Code: 500InvalidRequestException

This exception occurs when there is something wrong with user input.

HTTP Status Code: 400

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

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

API Version 2009-03-3139

Page 53: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceDescribeJobFlows

DescribeJobFlowsThis API is no longer supported and will eventually be removed. We recommend you useListClusters (p. 63), DescribeCluster (p. 37), ListSteps (p. 81), ListInstanceGroups (p. 69) andListBootstrapActions (p. 61) instead.

DescribeJobFlows returns a list of job flows that match all of the supplied parameters. The parameterscan include a list of job flow IDs, job flow states, and restrictions on job flow creation date and time.

Regardless of supplied parameters, only job flows created within the last two months are returned.

If no parameters are supplied, then job flows matching either of the following criteria are returned:

• Job flows created and completed in the last two weeks• Job flows created within the last two months that are in one of the following states: RUNNING,WAITING, SHUTTING_DOWN, STARTING

Amazon EMR can return a maximum of 512 job flow descriptions.

Request Syntax{ "CreatedAfter": number, "CreatedBefore": number, "JobFlowIds": [ "string" ], "JobFlowStates": [ "string" ]}

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

The request accepts the following data in JSON format.

CreatedAfter (p. 40)

Return only job flows created after this date and time.

Type: Timestamp

Required: NoCreatedBefore (p. 40)

Return only job flows created before this date and time.

Type: Timestamp

Required: NoJobFlowIds (p. 40)

Return only job flows whose job flow ID is contained in this list.

Type: Array of strings

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

API Version 2009-03-3140

Page 54: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceResponse Syntax

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: NoJobFlowStates (p. 40)

Return only job flows whose state is contained in this list.

Type: Array of strings

Valid Values: STARTING | BOOTSTRAPPING | RUNNING | WAITING | SHUTTING_DOWN |TERMINATED | COMPLETED | FAILED

Required: No

Response Syntax{ "JobFlows": [ { "AmiVersion": "string", "AutoScalingRole": "string", "BootstrapActions": [ { "BootstrapActionConfig": { "Name": "string", "ScriptBootstrapAction": { "Args": [ "string" ], "Path": "string" } } } ], "ExecutionStatusDetail": { "CreationDateTime": number, "EndDateTime": number, "LastStateChangeReason": "string", "ReadyDateTime": number, "StartDateTime": number, "State": "string" }, "Instances": { "Ec2KeyName": "string", "Ec2SubnetId": "string", "HadoopVersion": "string", "InstanceCount": number, "InstanceGroups": [ { "BidPrice": "string", "CreationDateTime": number, "EndDateTime": number, "InstanceGroupId": "string", "InstanceRequestCount": number, "InstanceRole": "string", "InstanceRunningCount": number, "InstanceType": "string", "LastStateChangeReason": "string", "Market": "string", "Name": "string", "ReadyDateTime": number, "StartDateTime": number, "State": "string" }

API Version 2009-03-3141

Page 55: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceResponse Elements

], "KeepJobFlowAliveWhenNoSteps": boolean, "MasterInstanceId": "string", "MasterInstanceType": "string", "MasterPublicDnsName": "string", "NormalizedInstanceHours": number, "Placement": { "AvailabilityZone": "string", "AvailabilityZones": [ "string" ] }, "SlaveInstanceType": "string", "TerminationProtected": boolean }, "JobFlowId": "string", "JobFlowRole": "string", "LogEncryptionKmsKeyId": "string", "LogUri": "string", "Name": "string", "ScaleDownBehavior": "string", "ServiceRole": "string", "Steps": [ { "ExecutionStatusDetail": { "CreationDateTime": number, "EndDateTime": number, "LastStateChangeReason": "string", "StartDateTime": number, "State": "string" }, "StepConfig": { "ActionOnFailure": "string", "HadoopJarStep": { "Args": [ "string" ], "Jar": "string", "MainClass": "string", "Properties": [ { "Key": "string", "Value": "string" } ] }, "Name": "string" } } ], "SupportedProducts": [ "string" ], "VisibleToAllUsers": boolean } ]}

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

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

JobFlows (p. 41)

A list of job flows matching the parameters supplied.

Type: Array of JobFlowDetail (p. 218) objects

API Version 2009-03-3142

Page 56: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceErrors

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

InternalServerError

Indicates that an error occurred while processing the request and that the request was notcompleted.

HTTP Status Code: 400

Examples

ExampleThis example illustrates one usage of DescribeJobFlows.

Sample Request

POST / HTTP/1.1Content-Type: application/x-amz-json-1.1X-Amz-Target: ElasticMapReduce.DescribeJobFlowsContent-Length: 62User-Agent: aws-sdk-ruby/1.9.2 ruby/1.9.3 i386-mingw32Host: us-east-1.elasticmapreduce.amazonaws.comX-Amz-Date: 20130715T220330ZX-Amz-Content-Sha256: fce83af973f96f173512aca2845c56862b946feb1de0600326f1365b658a0e39Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20130715/us-east-1/elasticmapreduce/aws4_request, SignedHeaders=content-length;content-type;host;user-agent;x-amz-content-sha256;x-amz-date;x-amz-target, Signature=29F98a6f44e05ad54fe1e8b3d1a7101ab08dc3ad348995f89c533693cee2bb3bAccept: */*

{ "JobFlowIds": ["j-ZKIY4CKQRX72"], "DescriptionType": "EXTENDED"}

Sample Response

HTTP/1.1 200 OKx-amzn-RequestId: 634d4142-ed9a-11e2-bbba-b56d7d016ec4Content-Type: application/x-amz-json-1.1Content-Length: 1624Date: Mon, 15 Jul 2013 22:03:31 GMT

{"JobFlows": [{ "AmiVersion": "2.3.6", "BootstrapActions": [], "ExecutionStatusDetail": { "CreationDateTime": 1.373923429E9, "EndDateTime": 1.373923995E9, "LastStateChangeReason": "Steps completed", "ReadyDateTime": 1.373923754E9, "StartDateTime": 1.373923754E9, "State": "COMPLETED" }, "Instances": {

API Version 2009-03-3143

Page 57: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceSee Also

"HadoopVersion": "1.0.3", "InstanceCount": 1, "InstanceGroups": [{ "CreationDateTime": 1.373923429E9, "EndDateTime": 1.373923995E9, "InstanceGroupId": "ig-3SRUWV3E0NB7K", "InstanceRequestCount": 1, "InstanceRole": "MASTER", "InstanceRunningCount": 0, "InstanceType": "m1.small", "LastStateChangeReason": "Job flow terminated", "Market": "ON_DEMAND", "Name": "Master InstanceGroup", "ReadyDateTime": 1.37392375E9, "StartDateTime": 1.373923646E9, "State": "ENDED" }], "KeepJobFlowAliveWhenNoSteps": false, "MasterInstanceId": "i-8c4fbbef", "MasterInstanceType": "m1.small", "MasterPublicDnsName": "ec2-107-20-46-140.compute-1.amazonaws.com", "NormalizedInstanceHours": 1, "Placement": {"AvailabilityZone": "us-east-1a"}, "TerminationProtected": false }, "JobFlowId": "j-ZKIY4CKQRX72", "Name": "Development Job Flow", "Steps": [{ "ExecutionStatusDetail": { "CreationDateTime": 1.373923429E9, "EndDateTime": 1.373923914E9, "StartDateTime": 1.373923754E9, "State": "COMPLETED" }, "StepConfig": { "ActionOnFailure": "CANCEL_AND_WAIT", "HadoopJarStep": { "Args": [ "-input", "s3://elasticmapreduce/samples/wordcount/input", "-output", "s3://examples-bucket/example-output", "-mapper", "s3://elasticmapreduce/samples/wordcount/wordSplitter.py", "-reducer", "aggregate" ], "Jar": "/home/hadoop/contrib/streaming/hadoop-streaming.jar", "Properties": [] }, "Name": "Example Streaming Step" } }], "SupportedProducts": []}]}

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

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

API Version 2009-03-3144

Page 59: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceDescribeNotebookExecution

DescribeNotebookExecutionProvides details of a notebook execution.

Request Syntax{ "NotebookExecutionId": "string"}

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

The request accepts the following data in JSON format.

NotebookExecutionId (p. 46)

The unique identifier of the notebook execution.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: Yes

Response Syntax{ "NotebookExecution": { "Arn": "string", "EditorId": "string", "EndTime": number, "ExecutionEngine": { "Id": "string", "MasterInstanceSecurityGroupId": "string", "Type": "string" }, "LastStateChangeReason": "string", "NotebookExecutionId": "string", "NotebookExecutionName": "string", "NotebookInstanceSecurityGroupId": "string", "NotebookParams": "string", "OutputNotebookURI": "string", "StartTime": number, "Status": "string", "Tags": [ { "Key": "string", "Value": "string" } ] }}

API Version 2009-03-3146

Page 60: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceResponse Elements

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

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

NotebookExecution (p. 46)

Properties of the notebook execution.

Type: NotebookExecution (p. 236) object

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

InternalServerError

Indicates that an error occurred while processing the request and that the request was notcompleted.

HTTP Status Code: 400InvalidRequestException

This exception occurs when there is something wrong with user input.

HTTP Status Code: 400

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

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

API Version 2009-03-3147

Page 61: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceDescribeSecurityConfiguration

DescribeSecurityConfigurationProvides the details of a security configuration by returning the configuration JSON.

Request Syntax{ "Name": "string"}

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

The request accepts the following data in JSON format.

Name (p. 48)

The name of the security configuration.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: Yes

Response Syntax{ "CreationDateTime": number, "Name": "string", "SecurityConfiguration": "string"}

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

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

CreationDateTime (p. 48)

The date and time the security configuration was created

Type: TimestampName (p. 48)

The name of the security configuration.

Type: String

API Version 2009-03-3148

Page 62: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceErrors

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*SecurityConfiguration (p. 48)

The security configuration details in JSON format.

Type: String

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

InternalServerException

This exception occurs when there is an internal failure in the Amazon EMR service.

HTTP Status Code: 500InvalidRequestException

This exception occurs when there is something wrong with user input.

HTTP Status Code: 400

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

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

API Version 2009-03-3149

Page 63: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceDescribeStep

DescribeStepProvides more detail about the cluster step.

Request Syntax{ "ClusterId": "string", "StepId": "string"}

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

The request accepts the following data in JSON format.

ClusterId (p. 50)

The identifier of the cluster with steps to describe.

Type: String

Required: YesStepId (p. 50)

The identifier of the step to describe.

Type: String

Required: Yes

Response Syntax{ "Step": { "ActionOnFailure": "string", "Config": { "Args": [ "string" ], "Jar": "string", "MainClass": "string", "Properties": { "string" : "string" } }, "Id": "string", "Name": "string", "Status": { "FailureDetails": { "LogFile": "string", "Message": "string", "Reason": "string" }, "State": "string", "StateChangeReason": {

API Version 2009-03-3150

Page 64: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceResponse Elements

"Code": "string", "Message": "string" }, "Timeline": { "CreationDateTime": number, "EndDateTime": number, "StartDateTime": number } } }}

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

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

Step (p. 50)

The step details for the requested step identifier.

Type: Step (p. 262) object

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

InternalServerException

This exception occurs when there is an internal failure in the Amazon EMR service.

HTTP Status Code: 500InvalidRequestException

This exception occurs when there is something wrong with user input.

HTTP Status Code: 400

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

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

API Version 2009-03-3151

Page 65: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceDescribeStudio

DescribeStudioReturns details for the specified Amazon EMR Studio including ID, Name, VPC, Studio access URL, and soon.

Request Syntax{ "StudioId": "string"}

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

The request accepts the following data in JSON format.

StudioId (p. 52)

The Amazon EMR Studio ID.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: Yes

Response Syntax{ "Studio": { "AuthMode": "string", "CreationTime": number, "DefaultS3Location": "string", "Description": "string", "EngineSecurityGroupId": "string", "Name": "string", "ServiceRole": "string", "StudioArn": "string", "StudioId": "string", "SubnetIds": [ "string" ], "Tags": [ { "Key": "string", "Value": "string" } ], "Url": "string", "UserRole": "string", "VpcId": "string", "WorkspaceSecurityGroupId": "string" }}

API Version 2009-03-3152

Page 66: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceResponse Elements

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

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

Studio (p. 52)

The Amazon EMR Studio details.

Type: Studio (p. 273) object

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

InternalServerException

This exception occurs when there is an internal failure in the Amazon EMR service.

HTTP Status Code: 500InvalidRequestException

This exception occurs when there is something wrong with user input.

HTTP Status Code: 400

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

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

API Version 2009-03-3153

Page 67: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceGetBlockPublicAccessConfiguration

GetBlockPublicAccessConfigurationReturns the Amazon EMR block public access configuration for your AWS account in the currentRegion. For more information see Configure Block Public Access for Amazon EMR in the Amazon EMRManagement Guide.

Response Syntax{ "BlockPublicAccessConfiguration": { "BlockPublicSecurityGroupRules": boolean, "PermittedPublicSecurityGroupRuleRanges": [ { "MaxRange": number, "MinRange": number } ] }, "BlockPublicAccessConfigurationMetadata": { "CreatedByArn": "string", "CreationDateTime": number }}

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

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

BlockPublicAccessConfiguration (p. 54)

A configuration for Amazon EMR block public access. The configuration applies to all clusterscreated in your account for the current Region. The configuration specifies whether block publicaccess is enabled. If block public access is enabled, security groups associated with the clustercannot have rules that allow inbound traffic from 0.0.0.0/0 or ::/0 on a port, unless the portis specified as an exception using PermittedPublicSecurityGroupRuleRanges in theBlockPublicAccessConfiguration. By default, Port 22 (SSH) is an exception, and public accessis allowed on this port. You can change this by updating the block public access configuration toremove the exception.

NoteFor accounts that created clusters in a Region before November 25, 2019, block publicaccess is disabled by default in that Region. To use this feature, you must manually enableand configure it. For accounts that did not create an EMR cluster in a Region before thisdate, block public access is enabled by default in that Region.

Type: BlockPublicAccessConfiguration (p. 150) object

BlockPublicAccessConfigurationMetadata (p. 54)

Properties that describe the AWS principal that created the BlockPublicAccessConfigurationusing the PutBlockPublicAccessConfiguration action as well as the date and time that theconfiguration was created. Each time a configuration for block public access is updated, AmazonEMR updates this metadata.

Type: BlockPublicAccessConfigurationMetadata (p. 151) object

API Version 2009-03-3154

Page 68: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceErrors

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

InternalServerException

This exception occurs when there is an internal failure in the Amazon EMR service.

HTTP Status Code: 500InvalidRequestException

This exception occurs when there is something wrong with user input.

HTTP Status Code: 400

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

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

API Version 2009-03-3155

Page 69: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceGetManagedScalingPolicy

GetManagedScalingPolicyFetches the attached managed scaling policy for an Amazon EMR cluster.

Request Syntax{ "ClusterId": "string"}

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

The request accepts the following data in JSON format.

ClusterId (p. 56)

Specifies the ID of the cluster for which the managed scaling policy will be fetched.

Type: String

Required: Yes

Response Syntax{ "ManagedScalingPolicy": { "ComputeLimits": { "MaximumCapacityUnits": number, "MaximumCoreCapacityUnits": number, "MaximumOnDemandCapacityUnits": number, "MinimumCapacityUnits": number, "UnitType": "string" } }}

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

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

ManagedScalingPolicy (p. 56)

Specifies the managed scaling policy that is attached to an Amazon EMR cluster.

Type: ManagedScalingPolicy (p. 234) object

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

API Version 2009-03-3156

Page 71: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceGetStudioSessionMapping

GetStudioSessionMappingFetches mapping details for the specified Amazon EMR Studio and identity (user or group).

Request Syntax{ "IdentityId": "string", "IdentityName": "string", "IdentityType": "string", "StudioId": "string"}

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

The request accepts the following data in JSON format.

IdentityId (p. 58)

The globally unique identifier (GUID) of the user or group. For more information, see UserId andGroupId in the AWS SSO Identity Store API Reference. Either IdentityName or IdentityId must bespecified.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: NoIdentityName (p. 58)

The name of the user or group to fetch. For more information, see UserName and DisplayName inthe AWS SSO Identity Store API Reference. Either IdentityName or IdentityId must be specified.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: NoIdentityType (p. 58)

Specifies whether the identity to fetch is a user or a group.

Type: String

Valid Values: USER | GROUP

Required: YesStudioId (p. 58)

The ID of the Amazon EMR Studio.

API Version 2009-03-3158

Page 72: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceResponse Syntax

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: Yes

Response Syntax{ "SessionMapping": { "CreationTime": number, "IdentityId": "string", "IdentityName": "string", "IdentityType": "string", "LastModifiedTime": number, "SessionPolicyArn": "string", "StudioId": "string" }}

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

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

SessionMapping (p. 59)

The session mapping details for the specified Amazon EMR Studio and identity, including sessionpolicy ARN and creation time.

Type: SessionMappingDetail (p. 253) object

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

InternalServerError

Indicates that an error occurred while processing the request and that the request was notcompleted.

HTTP Status Code: 400InvalidRequestException

This exception occurs when there is something wrong with user input.

HTTP Status Code: 400

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

API Version 2009-03-3159

Page 74: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceListBootstrapActions

ListBootstrapActionsProvides information about the bootstrap actions associated with a cluster.

Request Syntax{ "ClusterId": "string", "Marker": "string"}

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

The request accepts the following data in JSON format.

ClusterId (p. 61)

The cluster identifier for the bootstrap actions to list.

Type: String

Required: YesMarker (p. 61)

The pagination token that indicates the next set of results to retrieve.

Type: String

Required: No

Response Syntax{ "BootstrapActions": [ { "Args": [ "string" ], "Name": "string", "ScriptPath": "string" } ], "Marker": "string"}

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

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

BootstrapActions (p. 61)

The bootstrap actions associated with the cluster.

API Version 2009-03-3161

Page 75: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceErrors

Type: Array of Command (p. 168) objectsMarker (p. 61)

The pagination token that indicates the next set of results to retrieve.

Type: String

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

InternalServerException

This exception occurs when there is an internal failure in the Amazon EMR service.

HTTP Status Code: 500InvalidRequestException

This exception occurs when there is something wrong with user input.

HTTP Status Code: 400

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

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

API Version 2009-03-3162

Page 76: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceListClusters

ListClustersProvides the status of all clusters visible to this AWS account. Allows you to filter the list of clustersbased on certain criteria; for example, filtering by cluster creation date and time or by status. This callreturns a maximum of 50 clusters in unsorted order per call, but returns a marker to track the paging ofthe cluster list across multiple ListClusters calls.

Request Syntax{ "ClusterStates": [ "string" ], "CreatedAfter": number, "CreatedBefore": number, "Marker": "string"}

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

The request accepts the following data in JSON format.

ClusterStates (p. 63)

The cluster state filters to apply when listing clusters. Clusters that change state while this actionruns may be not be returned as expected in the list of clusters.

Type: Array of strings

Valid Values: STARTING | BOOTSTRAPPING | RUNNING | WAITING | TERMINATING |TERMINATED | TERMINATED_WITH_ERRORS

Required: No

CreatedAfter (p. 63)

The creation date and time beginning value filter for listing clusters.

Type: Timestamp

Required: No

CreatedBefore (p. 63)

The creation date and time end value filter for listing clusters.

Type: Timestamp

Required: No

Marker (p. 63)

The pagination token that indicates the next set of results to retrieve.

Type: String

Required: No

API Version 2009-03-3163

Page 77: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceResponse Syntax

Response Syntax{ "Clusters": [ { "ClusterArn": "string", "Id": "string", "Name": "string", "NormalizedInstanceHours": number, "OutpostArn": "string", "Status": { "State": "string", "StateChangeReason": { "Code": "string", "Message": "string" }, "Timeline": { "CreationDateTime": number, "EndDateTime": number, "ReadyDateTime": number } } } ], "Marker": "string"}

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

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

Clusters (p. 64)

The list of clusters for the account based on the given filters.

Type: Array of ClusterSummary (p. 165) objectsMarker (p. 64)

The pagination token that indicates the next set of results to retrieve.

Type: String

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

InternalServerException

This exception occurs when there is an internal failure in the Amazon EMR service.

HTTP Status Code: 500InvalidRequestException

This exception occurs when there is something wrong with user input.

HTTP Status Code: 400

API Version 2009-03-3164

Page 79: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceListInstanceFleets

ListInstanceFleetsLists all available details about the instance fleets in a cluster.

NoteThe instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later,excluding 5.0.x versions.

Request Syntax{ "ClusterId": "string", "Marker": "string"}

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

The request accepts the following data in JSON format.

ClusterId (p. 66)

The unique identifier of the cluster.

Type: String

Required: YesMarker (p. 66)

The pagination token that indicates the next set of results to retrieve.

Type: String

Required: No

Response Syntax{ "InstanceFleets": [ { "Id": "string", "InstanceFleetType": "string", "InstanceTypeSpecifications": [ { "BidPrice": "string", "BidPriceAsPercentageOfOnDemandPrice": number, "Configurations": [ { "Classification": "string", "Configurations": [ "Configuration" ], "Properties": { "string" : "string" }

API Version 2009-03-3166

Page 80: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceResponse Elements

} ], "EbsBlockDevices": [ { "Device": "string", "VolumeSpecification": { "Iops": number, "SizeInGB": number, "VolumeType": "string" } } ], "EbsOptimized": boolean, "InstanceType": "string", "WeightedCapacity": number } ], "LaunchSpecifications": { "OnDemandSpecification": { "AllocationStrategy": "string", "CapacityReservationOptions": { "CapacityReservationPreference": "string", "CapacityReservationResourceGroupArn": "string", "UsageStrategy": "string" } }, "SpotSpecification": { "AllocationStrategy": "string", "BlockDurationMinutes": number, "TimeoutAction": "string", "TimeoutDurationMinutes": number } }, "Name": "string", "ProvisionedOnDemandCapacity": number, "ProvisionedSpotCapacity": number, "Status": { "State": "string", "StateChangeReason": { "Code": "string", "Message": "string" }, "Timeline": { "CreationDateTime": number, "EndDateTime": number, "ReadyDateTime": number } }, "TargetOnDemandCapacity": number, "TargetSpotCapacity": number } ], "Marker": "string"}

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

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

InstanceFleets (p. 66)

The list of instance fleets for the cluster and given filters.

API Version 2009-03-3167

Page 81: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceErrors

Type: Array of InstanceFleet (p. 186) objectsMarker (p. 66)

The pagination token that indicates the next set of results to retrieve.

Type: String

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

InternalServerException

This exception occurs when there is an internal failure in the Amazon EMR service.

HTTP Status Code: 500InvalidRequestException

This exception occurs when there is something wrong with user input.

HTTP Status Code: 400

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

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

API Version 2009-03-3168

Page 82: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceListInstanceGroups

ListInstanceGroupsProvides all available details about the instance groups in a cluster.

Request Syntax{ "ClusterId": "string", "Marker": "string"}

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

The request accepts the following data in JSON format.

ClusterId (p. 69)

The identifier of the cluster for which to list the instance groups.

Type: String

Required: YesMarker (p. 69)

The pagination token that indicates the next set of results to retrieve.

Type: String

Required: No

Response Syntax{ "InstanceGroups": [ { "AutoScalingPolicy": { "Constraints": { "MaxCapacity": number, "MinCapacity": number }, "Rules": [ { "Action": { "Market": "string", "SimpleScalingPolicyConfiguration": { "AdjustmentType": "string", "CoolDown": number, "ScalingAdjustment": number } }, "Description": "string", "Name": "string", "Trigger": {

API Version 2009-03-3169

Page 83: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceResponse Syntax

"CloudWatchAlarmDefinition": { "ComparisonOperator": "string", "Dimensions": [ { "Key": "string", "Value": "string" } ], "EvaluationPeriods": number, "MetricName": "string", "Namespace": "string", "Period": number, "Statistic": "string", "Threshold": number, "Unit": "string" } } } ], "Status": { "State": "string", "StateChangeReason": { "Code": "string", "Message": "string" } } }, "BidPrice": "string", "Configurations": [ { "Classification": "string", "Configurations": [ "Configuration" ], "Properties": { "string" : "string" } } ], "ConfigurationsVersion": number, "EbsBlockDevices": [ { "Device": "string", "VolumeSpecification": { "Iops": number, "SizeInGB": number, "VolumeType": "string" } } ], "EbsOptimized": boolean, "Id": "string", "InstanceGroupType": "string", "InstanceType": "string", "LastSuccessfullyAppliedConfigurations": [ { "Classification": "string", "Configurations": [ "Configuration" ], "Properties": { "string" : "string" } } ], "LastSuccessfullyAppliedConfigurationsVersion": number,

API Version 2009-03-3170

Page 84: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceResponse Elements

"Market": "string", "Name": "string", "RequestedInstanceCount": number, "RunningInstanceCount": number, "ShrinkPolicy": { "DecommissionTimeout": number, "InstanceResizePolicy": { "InstancesToProtect": [ "string" ], "InstancesToTerminate": [ "string" ], "InstanceTerminationTimeout": number } }, "Status": { "State": "string", "StateChangeReason": { "Code": "string", "Message": "string" }, "Timeline": { "CreationDateTime": number, "EndDateTime": number, "ReadyDateTime": number } } } ], "Marker": "string"}

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

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

InstanceGroups (p. 69)

The list of instance groups for the cluster and given filters.

Type: Array of InstanceGroup (p. 197) objectsMarker (p. 69)

The pagination token that indicates the next set of results to retrieve.

Type: String

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

InternalServerException

This exception occurs when there is an internal failure in the Amazon EMR service.

HTTP Status Code: 500InvalidRequestException

This exception occurs when there is something wrong with user input.

HTTP Status Code: 400

API Version 2009-03-3171

Page 86: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceListInstances

ListInstancesProvides information for all active EC2 instances and EC2 instances terminated in the last 30 days,up to a maximum of 2,000. EC2 instances in any of the following states are considered active:AWAITING_FULFILLMENT, PROVISIONING, BOOTSTRAPPING, RUNNING.

Request Syntax{ "ClusterId": "string", "InstanceFleetId": "string", "InstanceFleetType": "string", "InstanceGroupId": "string", "InstanceGroupTypes": [ "string" ], "InstanceStates": [ "string" ], "Marker": "string"}

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

The request accepts the following data in JSON format.

ClusterId (p. 73)

The identifier of the cluster for which to list the instances.

Type: String

Required: YesInstanceFleetId (p. 73)

The unique identifier of the instance fleet.

Type: String

Required: NoInstanceFleetType (p. 73)

The node type of the instance fleet. For example MASTER, CORE, or TASK.

Type: String

Valid Values: MASTER | CORE | TASK

Required: NoInstanceGroupId (p. 73)

The identifier of the instance group for which to list the instances.

Type: String

Required: NoInstanceGroupTypes (p. 73)

The type of instance group for which to list the instances.

API Version 2009-03-3173

Page 87: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceResponse Syntax

Type: Array of strings

Valid Values: MASTER | CORE | TASK

Required: NoInstanceStates (p. 73)

A list of instance states that will filter the instances returned with this request.

Type: Array of strings

Valid Values: AWAITING_FULFILLMENT | PROVISIONING | BOOTSTRAPPING | RUNNING |TERMINATED

Required: NoMarker (p. 73)

The pagination token that indicates the next set of results to retrieve.

Type: String

Required: No

Response Syntax{ "Instances": [ { "EbsVolumes": [ { "Device": "string", "VolumeId": "string" } ], "Ec2InstanceId": "string", "Id": "string", "InstanceFleetId": "string", "InstanceGroupId": "string", "InstanceType": "string", "Market": "string", "PrivateDnsName": "string", "PrivateIpAddress": "string", "PublicDnsName": "string", "PublicIpAddress": "string", "Status": { "State": "string", "StateChangeReason": { "Code": "string", "Message": "string" }, "Timeline": { "CreationDateTime": number, "EndDateTime": number, "ReadyDateTime": number } } } ], "Marker": "string"}

API Version 2009-03-3174

Page 88: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceResponse Elements

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

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

Instances (p. 74)

The list of instances for the cluster and given filters.

Type: Array of Instance (p. 184) objectsMarker (p. 74)

The pagination token that indicates the next set of results to retrieve.

Type: String

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

InternalServerException

This exception occurs when there is an internal failure in the Amazon EMR service.

HTTP Status Code: 500InvalidRequestException

This exception occurs when there is something wrong with user input.

HTTP Status Code: 400

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

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

API Version 2009-03-3175

Page 89: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceListNotebookExecutions

ListNotebookExecutionsProvides summaries of all notebook executions. You can filter the list based on multiple criteria such asstatus, time range, and editor id. Returns a maximum of 50 notebook executions and a marker to trackthe paging of a longer notebook execution list across multiple ListNotebookExecution calls.

Request Syntax{ "EditorId": "string", "From": number, "Marker": "string", "Status": "string", "To": number}

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

The request accepts the following data in JSON format.

EditorId (p. 76)

The unique ID of the editor associated with the notebook execution.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: NoFrom (p. 76)

The beginning of time range filter for listing notebook executions. The default is the timestamp of30 days ago.

Type: Timestamp

Required: NoMarker (p. 76)

The pagination token, returned by a previous ListNotebookExecutions call, that indicates thestart of the list for this ListNotebookExecutions call.

Type: String

Required: NoStatus (p. 76)

The status filter for listing notebook executions.• START_PENDING indicates that the cluster has received the execution request but execution has

not begun.• STARTING indicates that the execution is starting on the cluster.

API Version 2009-03-3176

Page 90: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceResponse Syntax

• RUNNING indicates that the execution is being processed by the cluster.• FINISHING indicates that execution processing is in the final stages.• FINISHED indicates that the execution has completed without error.• FAILING indicates that the execution is failing and will not finish successfully.• FAILED indicates that the execution failed.• STOP_PENDING indicates that the cluster has received a StopNotebookExecution request and

the stop is pending.• STOPPING indicates that the cluster is in the process of stopping the execution as a result of aStopNotebookExecution request.

• STOPPED indicates that the execution stopped because of a StopNotebookExecution request.

Type: String

Valid Values: START_PENDING | STARTING | RUNNING | FINISHING | FINISHED |FAILING | FAILED | STOP_PENDING | STOPPING | STOPPED

Required: NoTo (p. 76)

The end of time range filter for listing notebook executions. The default is the current timestamp.

Type: Timestamp

Required: No

Response Syntax{ "Marker": "string", "NotebookExecutions": [ { "EditorId": "string", "EndTime": number, "NotebookExecutionId": "string", "NotebookExecutionName": "string", "StartTime": number, "Status": "string" } ]}

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

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

Marker (p. 77)

A pagination token that a subsequent ListNotebookExecutions can use to determine the nextset of results to retrieve.

Type: StringNotebookExecutions (p. 77)

A list of notebook executions.

API Version 2009-03-3177

Page 91: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceErrors

Type: Array of NotebookExecutionSummary (p. 239) objects

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

InternalServerError

Indicates that an error occurred while processing the request and that the request was notcompleted.

HTTP Status Code: 400InvalidRequestException

This exception occurs when there is something wrong with user input.

HTTP Status Code: 400

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

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

API Version 2009-03-3178

Page 92: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceListSecurityConfigurations

ListSecurityConfigurationsLists all the security configurations visible to this account, providing their creation dates and times, andtheir names. This call returns a maximum of 50 clusters per call, but returns a marker to track the pagingof the cluster list across multiple ListSecurityConfigurations calls.

Request Syntax{ "Marker": "string"}

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

The request accepts the following data in JSON format.

Marker (p. 79)

The pagination token that indicates the set of results to retrieve.

Type: String

Required: No

Response Syntax{ "Marker": "string", "SecurityConfigurations": [ { "CreationDateTime": number, "Name": "string" } ]}

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

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

Marker (p. 79)

A pagination token that indicates the next set of results to retrieve. Include the marker in the nextListSecurityConfiguration call to retrieve the next page of results, if required.

Type: StringSecurityConfigurations (p. 79)

The creation date and time, and name, of each security configuration.

API Version 2009-03-3179

Page 93: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceErrors

Type: Array of SecurityConfigurationSummary (p. 252) objects

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

InternalServerException

This exception occurs when there is an internal failure in the Amazon EMR service.

HTTP Status Code: 500InvalidRequestException

This exception occurs when there is something wrong with user input.

HTTP Status Code: 400

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

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

API Version 2009-03-3180

Page 94: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceListSteps

ListStepsProvides a list of steps for the cluster in reverse order unless you specify stepIds with the request orfilter by StepStates. You can specify a maximum of 10 stepIDs. The AWS CLI automatically paginatesresults to return a list greater than 50 steps. To return more than 50 steps using the AWS CLI, specify aMarker, which is a pagination token that indicates the next set of steps to retrieve.

Request Syntax{ "ClusterId": "string", "Marker": "string", "StepIds": [ "string" ], "StepStates": [ "string" ]}

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

The request accepts the following data in JSON format.

ClusterId (p. 81)

The identifier of the cluster for which to list the steps.

Type: String

Required: YesMarker (p. 81)

The maximum number of steps that a single ListSteps action returns is 50. To return a longer listof steps, use multiple ListSteps actions along with the Marker parameter, which is a paginationtoken that indicates the next set of results to retrieve.

Type: String

Required: NoStepIds (p. 81)

The filter to limit the step list based on the identifier of the steps. You can specify a maximum of tenStep IDs. The character constraint applies to the overall length of the array.

Type: Array of strings

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: NoStepStates (p. 81)

The filter to limit the step list based on certain states.

Type: Array of strings

API Version 2009-03-3181

Page 95: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceResponse Syntax

Valid Values: PENDING | CANCEL_PENDING | RUNNING | COMPLETED | CANCELLED |FAILED | INTERRUPTED

Required: No

Response Syntax{ "Marker": "string", "Steps": [ { "ActionOnFailure": "string", "Config": { "Args": [ "string" ], "Jar": "string", "MainClass": "string", "Properties": { "string" : "string" } }, "Id": "string", "Name": "string", "Status": { "FailureDetails": { "LogFile": "string", "Message": "string", "Reason": "string" }, "State": "string", "StateChangeReason": { "Code": "string", "Message": "string" }, "Timeline": { "CreationDateTime": number, "EndDateTime": number, "StartDateTime": number } } } ]}

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

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

Marker (p. 82)

The maximum number of steps that a single ListSteps action returns is 50. To return a longer listof steps, use multiple ListSteps actions along with the Marker parameter, which is a paginationtoken that indicates the next set of results to retrieve.

Type: String

Steps (p. 82)

The filtered list of steps for the cluster.

API Version 2009-03-3182

Page 96: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceErrors

Type: Array of StepSummary (p. 271) objects

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

InternalServerException

This exception occurs when there is an internal failure in the Amazon EMR service.

HTTP Status Code: 500InvalidRequestException

This exception occurs when there is something wrong with user input.

HTTP Status Code: 400

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

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

API Version 2009-03-3183

Page 97: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceListStudios

ListStudiosReturns a list of all Amazon EMR Studios associated with the AWS account. The list includes details suchas ID, Studio Access URL, and creation time for each Studio.

Request Syntax{ "Marker": "string"}

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

The request accepts the following data in JSON format.

Marker (p. 84)

The pagination token that indicates the set of results to retrieve.

Type: String

Required: No

Response Syntax{ "Marker": "string", "Studios": [ { "CreationTime": number, "Description": "string", "Name": "string", "StudioId": "string", "Url": "string", "VpcId": "string" } ]}

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

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

Marker (p. 84)

The pagination token that indicates the next set of results to retrieve.

Type: String

API Version 2009-03-3184

Page 98: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceErrors

Studios (p. 84)

The list of Studio summary objects.

Type: Array of StudioSummary (p. 276) objects

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

InternalServerException

This exception occurs when there is an internal failure in the Amazon EMR service.

HTTP Status Code: 500InvalidRequestException

This exception occurs when there is something wrong with user input.

HTTP Status Code: 400

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

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

API Version 2009-03-3185

Page 99: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceListStudioSessionMappings

ListStudioSessionMappingsReturns a list of all user or group session mappings for the Amazon EMR Studio specified by StudioId.

Request Syntax{ "IdentityType": "string", "Marker": "string", "StudioId": "string"}

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

The request accepts the following data in JSON format.

IdentityType (p. 86)

Specifies whether to return session mappings for users or groups. If not specified, the results includesession mapping details for both users and groups.

Type: String

Valid Values: USER | GROUP

Required: NoMarker (p. 86)

The pagination token that indicates the set of results to retrieve.

Type: String

Required: NoStudioId (p. 86)

The ID of the Amazon EMR Studio.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: No

Response Syntax{ "Marker": "string", "SessionMappings": [ { "CreationTime": number,

API Version 2009-03-3186

Page 100: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceResponse Elements

"IdentityId": "string", "IdentityName": "string", "IdentityType": "string", "SessionPolicyArn": "string", "StudioId": "string" } ]}

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

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

Marker (p. 86)

The pagination token that indicates the next set of results to retrieve.

Type: StringSessionMappings (p. 86)

A list of session mapping summary objects. Each object includes session mapping details such ascreation time, identity type (user or group), and Amazon EMR Studio ID.

Type: Array of SessionMappingSummary (p. 255) objects

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

InternalServerError

Indicates that an error occurred while processing the request and that the request was notcompleted.

HTTP Status Code: 400InvalidRequestException

This exception occurs when there is something wrong with user input.

HTTP Status Code: 400

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

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

API Version 2009-03-3187

Page 101: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceSee Also

• AWS SDK for Python• AWS SDK for Ruby V3

API Version 2009-03-3188

Page 102: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceModifyCluster

ModifyClusterModifies the number of steps that can be executed concurrently for the cluster specified using ClusterID.

Request Syntax{ "ClusterId": "string", "StepConcurrencyLevel": number}

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

The request accepts the following data in JSON format.

ClusterId (p. 89)

The unique identifier of the cluster.

Type: String

Required: YesStepConcurrencyLevel (p. 89)

The number of steps that can be executed concurrently. You can specify a minimum of 1 step anda maximum of 256 steps. We recommend that you do not change this parameter while steps arerunning or the ActionOnFailure setting may not behave as expected. For more information seeStep:ActionOnFailure (p. 262).

Type: Integer

Required: No

Response Syntax{ "StepConcurrencyLevel": number}

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

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

StepConcurrencyLevel (p. 89)

The number of steps that can be executed concurrently.

Type: Integer

API Version 2009-03-3189

Page 103: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceErrors

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

InternalServerError

Indicates that an error occurred while processing the request and that the request was notcompleted.

HTTP Status Code: 400InvalidRequestException

This exception occurs when there is something wrong with user input.

HTTP Status Code: 400

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

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

API Version 2009-03-3190

Page 104: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceModifyInstanceFleet

ModifyInstanceFleetModifies the target On-Demand and target Spot capacities for the instance fleet with the specifiedInstanceFleetID within the cluster specified using ClusterID. The call either succeeds or fails atomically.

NoteThe instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later,excluding 5.0.x versions.

Request Syntax{ "ClusterId": "string", "InstanceFleet": { "InstanceFleetId": "string", "TargetOnDemandCapacity": number, "TargetSpotCapacity": number }}

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

The request accepts the following data in JSON format.

ClusterId (p. 91)

The unique identifier of the cluster.

Type: String

Required: YesInstanceFleet (p. 91)

The configuration parameters of the instance fleet.

Type: InstanceFleetModifyConfig (p. 191) object

Required: Yes

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

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

InternalServerException

This exception occurs when there is an internal failure in the Amazon EMR service.

HTTP Status Code: 500

API Version 2009-03-3191

Page 106: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceModifyInstanceGroups

ModifyInstanceGroupsModifyInstanceGroups modifies the number of nodes and configuration settings of an instance group.The input parameters include the new target instance count for the group and the instance group ID. Thecall will either succeed or fail atomically.

Request Syntax{ "ClusterId": "string", "InstanceGroups": [ { "Configurations": [ { "Classification": "string", "Configurations": [ "Configuration" ], "Properties": { "string" : "string" } } ], "EC2InstanceIdsToTerminate": [ "string" ], "InstanceCount": number, "InstanceGroupId": "string", "ShrinkPolicy": { "DecommissionTimeout": number, "InstanceResizePolicy": { "InstancesToProtect": [ "string" ], "InstancesToTerminate": [ "string" ], "InstanceTerminationTimeout": number } } } ]}

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

The request accepts the following data in JSON format.

ClusterId (p. 93)

The ID of the cluster to which the instance group belongs.

Type: String

Required: NoInstanceGroups (p. 93)

Instance groups to change.

Type: Array of InstanceGroupModifyConfig (p. 205) objects

Required: No

API Version 2009-03-3193

Page 107: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceResponse Elements

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

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

InternalServerError

Indicates that an error occurred while processing the request and that the request was notcompleted.

HTTP Status Code: 400

Examples

ExampleThis example illustrates one usage of ModifyInstanceGroups.

Sample Request

POST / HTTP/1.1Content-Type: application/x-amz-json-1.1X-Amz-Target: ElasticMapReduce.ModifyInstanceGroupsContent-Length: 77User-Agent: aws-sdk-ruby/1.9.2 ruby/1.9.3 i386-mingw32Host: us-east-1.elasticmapreduce.amazonaws.comX-Amz-Date: 20130716T205843ZX-Amz-Content-Sha256: bb1af3d0c6c6a1a09f21ccd7f04a0e2e6c9ce5b5810b0f6777560fe4f81bda8cAuthorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20130716/us-east-1/elasticmapreduce/aws4_request, SignedHeaders=content-length;content-type;host;user-agent;x-amz-content-sha256;x-amz-date;x-amz-target, Signature=17bbbb4448a1f47a14d5657445e9de5cadf16bed58b850585f80865882133b33Accept: */*

{"InstanceGroups": [{ "InstanceGroupId": "ig-1S8NWT31S2OVG", "InstanceCount": 5}]}

Sample Response

HTTP/1.1 200 OKx-amzn-RequestId: 80a74808-ee5a-11e2-90db-69a5154aeb8dContent-Type: application/x-amz-json-1.1Content-Length: 0Date: Tue, 16 Jul 2013 20:58:44 GMT

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

API Version 2009-03-3194

Page 109: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferencePutAutoScalingPolicy

PutAutoScalingPolicyCreates or updates an automatic scaling policy for a core instance group or task instance group in anAmazon EMR cluster. The automatic scaling policy defines how an instance group dynamically adds andterminates EC2 instances in response to the value of a CloudWatch metric.

Request Syntax{ "AutoScalingPolicy": { "Constraints": { "MaxCapacity": number, "MinCapacity": number }, "Rules": [ { "Action": { "Market": "string", "SimpleScalingPolicyConfiguration": { "AdjustmentType": "string", "CoolDown": number, "ScalingAdjustment": number } }, "Description": "string", "Name": "string", "Trigger": { "CloudWatchAlarmDefinition": { "ComparisonOperator": "string", "Dimensions": [ { "Key": "string", "Value": "string" } ], "EvaluationPeriods": number, "MetricName": "string", "Namespace": "string", "Period": number, "Statistic": "string", "Threshold": number, "Unit": "string" } } } ] }, "ClusterId": "string", "InstanceGroupId": "string"}

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

The request accepts the following data in JSON format.

AutoScalingPolicy (p. 96)

Specifies the definition of the automatic scaling policy.

API Version 2009-03-3196

Page 110: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceResponse Syntax

Type: AutoScalingPolicy (p. 146) object

Required: YesClusterId (p. 96)

Specifies the ID of a cluster. The instance group to which the automatic scaling policy is applied iswithin this cluster.

Type: String

Required: YesInstanceGroupId (p. 96)

Specifies the ID of the instance group to which the automatic scaling policy is applied.

Type: String

Required: Yes

Response Syntax{ "AutoScalingPolicy": { "Constraints": { "MaxCapacity": number, "MinCapacity": number }, "Rules": [ { "Action": { "Market": "string", "SimpleScalingPolicyConfiguration": { "AdjustmentType": "string", "CoolDown": number, "ScalingAdjustment": number } }, "Description": "string", "Name": "string", "Trigger": { "CloudWatchAlarmDefinition": { "ComparisonOperator": "string", "Dimensions": [ { "Key": "string", "Value": "string" } ], "EvaluationPeriods": number, "MetricName": "string", "Namespace": "string", "Period": number, "Statistic": "string", "Threshold": number, "Unit": "string" } } } ], "Status": { "State": "string",

API Version 2009-03-3197

Page 111: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceResponse Elements

"StateChangeReason": { "Code": "string", "Message": "string" } } }, "ClusterArn": "string", "ClusterId": "string", "InstanceGroupId": "string"}

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

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

AutoScalingPolicy (p. 97)

The automatic scaling policy definition.

Type: AutoScalingPolicyDescription (p. 147) objectClusterArn (p. 97)

The Amazon Resource Name (ARN) of the cluster.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.ClusterId (p. 97)

Specifies the ID of a cluster. The instance group to which the automatic scaling policy is applied iswithin this cluster.

Type: StringInstanceGroupId (p. 97)

Specifies the ID of the instance group to which the scaling policy is applied.

Type: String

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

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

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

API Version 2009-03-3198

Page 113: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferencePutBlockPublicAccessConfiguration

PutBlockPublicAccessConfigurationCreates or updates an Amazon EMR block public access configuration for your AWS account in thecurrent Region. For more information see Configure Block Public Access for Amazon EMR in the AmazonEMR Management Guide.

Request Syntax{ "BlockPublicAccessConfiguration": { "BlockPublicSecurityGroupRules": boolean, "PermittedPublicSecurityGroupRuleRanges": [ { "MaxRange": number, "MinRange": number } ] }}

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

The request accepts the following data in JSON format.

BlockPublicAccessConfiguration (p. 100)

A configuration for Amazon EMR block public access. The configuration applies to all clusterscreated in your account for the current Region. The configuration specifies whether block publicaccess is enabled. If block public access is enabled, security groups associated with the clustercannot have rules that allow inbound traffic from 0.0.0.0/0 or ::/0 on a port, unless the portis specified as an exception using PermittedPublicSecurityGroupRuleRanges in theBlockPublicAccessConfiguration. By default, Port 22 (SSH) is an exception, and public accessis allowed on this port. You can change this by updating BlockPublicSecurityGroupRules toremove the exception.

NoteFor accounts that created clusters in a Region before November 25, 2019, block publicaccess is disabled by default in that Region. To use this feature, you must manually enableand configure it. For accounts that did not create an EMR cluster in a Region before thisdate, block public access is enabled by default in that Region.

Type: BlockPublicAccessConfiguration (p. 150) object

Required: Yes

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

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

API Version 2009-03-31100

Page 114: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceSee Also

InternalServerException

This exception occurs when there is an internal failure in the Amazon EMR service.

HTTP Status Code: 500InvalidRequestException

This exception occurs when there is something wrong with user input.

HTTP Status Code: 400

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

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

API Version 2009-03-31101

Page 115: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferencePutManagedScalingPolicy

PutManagedScalingPolicyCreates or updates a managed scaling policy for an Amazon EMR cluster. The managed scaling policydefines the limits for resources, such as EC2 instances that can be added or terminated from a cluster.The policy only applies to the core and task nodes. The master node cannot be scaled after initialconfiguration.

Request Syntax{ "ClusterId": "string", "ManagedScalingPolicy": { "ComputeLimits": { "MaximumCapacityUnits": number, "MaximumCoreCapacityUnits": number, "MaximumOnDemandCapacityUnits": number, "MinimumCapacityUnits": number, "UnitType": "string" } }}

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

The request accepts the following data in JSON format.

ClusterId (p. 102)

Specifies the ID of an EMR cluster where the managed scaling policy is attached.

Type: String

Required: YesManagedScalingPolicy (p. 102)

Specifies the constraints for the managed scaling policy.

Type: ManagedScalingPolicy (p. 234) object

Required: Yes

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

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

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

API Version 2009-03-31102

Page 117: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceRemoveAutoScalingPolicy

RemoveAutoScalingPolicyRemoves an automatic scaling policy from a specified instance group within an EMR cluster.

Request Syntax{ "ClusterId": "string", "InstanceGroupId": "string"}

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

The request accepts the following data in JSON format.

ClusterId (p. 104)

Specifies the ID of a cluster. The instance group to which the automatic scaling policy is applied iswithin this cluster.

Type: String

Required: YesInstanceGroupId (p. 104)

Specifies the ID of the instance group to which the scaling policy is applied.

Type: String

Required: Yes

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

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

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

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

API Version 2009-03-31104

Page 119: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceRemoveManagedScalingPolicy

RemoveManagedScalingPolicyRemoves a managed scaling policy from a specified EMR cluster.

Request Syntax{ "ClusterId": "string"}

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

The request accepts the following data in JSON format.

ClusterId (p. 106)

Specifies the ID of the cluster from which the managed scaling policy will be removed.

Type: String

Required: Yes

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

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

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

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

API Version 2009-03-31106

Page 120: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceRemoveTags

RemoveTagsRemoves tags from an Amazon EMR resource. Tags make it easier to associate clusters in various ways,such as grouping clusters to track your Amazon EMR resource allocation costs. For more information, seeTag Clusters.

The following example removes the stack tag with value Prod from a cluster:

Request Syntax{ "ResourceId": "string", "TagKeys": [ "string" ]}

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

The request accepts the following data in JSON format.

ResourceId (p. 107)

The Amazon EMR resource identifier from which tags will be removed. This value must be a clusteridentifier.

Type: String

Required: YesTagKeys (p. 107)

A list of tag keys to remove from a resource.

Type: Array of strings

Required: Yes

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

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

InternalServerException

This exception occurs when there is an internal failure in the Amazon EMR service.

HTTP Status Code: 500InvalidRequestException

This exception occurs when there is something wrong with user input.

API Version 2009-03-31107

Page 121: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceExamples

HTTP Status Code: 400

Examples

Example

This example illustrates one usage of RemoveTags.

Sample Request

POST / HTTP/1.1 Content-Type: application/x-amz-json-1.1 X-Amz-Target: ElasticMapReduce.RemoveTags AUTHPARAMS { "ResourceId": "j-3U7TSX5GZFD8Y", "Tags": [{ "Key": "stack", "Value": "Prod" }] }

Sample Response

HTTP/1.1 200 OK x-amzn-RequestId: 9da5a349-ed9e-11e2-90db-69a5154aeb8d Content-Type: application/x-amz-json-1.1 Content-Length: 71 Date: Mon, 15 Jul 2013 22:33:47 GMT

API Version 2009-03-31108

Page 122: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceExamples

{ }

Example

The following example removes the stack and hbase tags from a cluster:

Sample Request

POST / HTTP/1.1 Content-Type: application/x-amz-json-1.1 X-Amz-Target: ElasticMapReduce.RemoveTags AUTHPARAMS { "ResourceId": "j-3U7TSX5GZFD8Y", "Tags": [{ "Key": "stack" }, { "Key": "hbase" }] }

Sample Response

HTTP/1.1 200 OK x-amzn-RequestId: 9da5a349-ed9e-11e2-90db-69a5154aeb8d

API Version 2009-03-31109

Page 123: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceSee Also

Content-Type: application/x-amz-json-1.1 Content-Length: 71 Date: Mon, 15 Jul 2013 22:33:47 GMT { }

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

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

API Version 2009-03-31110

Page 124: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceRunJobFlow

RunJobFlowRunJobFlow creates and starts running a new cluster (job flow). The cluster runs the stepsspecified. After the steps complete, the cluster stops and the HDFS partition is lost. To preventloss of data, configure the last step of the job flow to store results in Amazon S3. If theJobFlowInstancesConfig (p. 224) KeepJobFlowAliveWhenNoSteps parameter is set to TRUE, thecluster transitions to the WAITING state rather than shutting down after the steps have completed.

For additional protection, you can set the JobFlowInstancesConfig (p. 224) TerminationProtectedparameter to TRUE to lock the cluster and prevent it from being terminated by API call, userintervention, or in the event of a job flow error.

A maximum of 256 steps are allowed in each job flow.

If your cluster is long-running (such as a Hive data warehouse) or complex, you may require more than256 steps to process your data. You can bypass the 256-step limitation in various ways, including usingthe SSH shell to connect to the master node and submitting queries directly to the software running onthe master node, such as Hive and Hadoop. For more information on how to do this, see Add More than256 Steps to a Cluster in the Amazon EMR Management Guide.

For long running clusters, we recommend that you periodically store your results.

NoteThe instance fleets configuration is available only in Amazon EMR versions 4.8.0 and later,excluding 5.0.x versions. The RunJobFlow request can contain InstanceFleets parameters orInstanceGroups parameters, but not both.

Request Syntax{ "AdditionalInfo": "string", "AmiVersion": "string", "Applications": [ { "AdditionalInfo": { "string" : "string" }, "Args": [ "string" ], "Name": "string", "Version": "string" } ], "AutoScalingRole": "string", "BootstrapActions": [ { "Name": "string", "ScriptBootstrapAction": { "Args": [ "string" ], "Path": "string" } } ], "Configurations": [ { "Classification": "string", "Configurations": [ "Configuration" ], "Properties": { "string" : "string"

API Version 2009-03-31111

Page 125: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceRequest Syntax

} } ], "CustomAmiId": "string", "EbsRootVolumeSize": number, "Instances": { "AdditionalMasterSecurityGroups": [ "string" ], "AdditionalSlaveSecurityGroups": [ "string" ], "Ec2KeyName": "string", "Ec2SubnetId": "string", "Ec2SubnetIds": [ "string" ], "EmrManagedMasterSecurityGroup": "string", "EmrManagedSlaveSecurityGroup": "string", "HadoopVersion": "string", "InstanceCount": number, "InstanceFleets": [ { "InstanceFleetType": "string", "InstanceTypeConfigs": [ { "BidPrice": "string", "BidPriceAsPercentageOfOnDemandPrice": number, "Configurations": [ { "Classification": "string", "Configurations": [ "Configuration" ], "Properties": { "string" : "string" } } ], "EbsConfiguration": { "EbsBlockDeviceConfigs": [ { "VolumeSpecification": { "Iops": number, "SizeInGB": number, "VolumeType": "string" }, "VolumesPerInstance": number } ], "EbsOptimized": boolean }, "InstanceType": "string", "WeightedCapacity": number } ], "LaunchSpecifications": { "OnDemandSpecification": { "AllocationStrategy": "string", "CapacityReservationOptions": { "CapacityReservationPreference": "string", "CapacityReservationResourceGroupArn": "string", "UsageStrategy": "string" } }, "SpotSpecification": { "AllocationStrategy": "string", "BlockDurationMinutes": number, "TimeoutAction": "string", "TimeoutDurationMinutes": number } },

API Version 2009-03-31112

Page 126: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceRequest Syntax

"Name": "string", "TargetOnDemandCapacity": number, "TargetSpotCapacity": number } ], "InstanceGroups": [ { "AutoScalingPolicy": { "Constraints": { "MaxCapacity": number, "MinCapacity": number }, "Rules": [ { "Action": { "Market": "string", "SimpleScalingPolicyConfiguration": { "AdjustmentType": "string", "CoolDown": number, "ScalingAdjustment": number } }, "Description": "string", "Name": "string", "Trigger": { "CloudWatchAlarmDefinition": { "ComparisonOperator": "string", "Dimensions": [ { "Key": "string", "Value": "string" } ], "EvaluationPeriods": number, "MetricName": "string", "Namespace": "string", "Period": number, "Statistic": "string", "Threshold": number, "Unit": "string" } } } ] }, "BidPrice": "string", "Configurations": [ { "Classification": "string", "Configurations": [ "Configuration" ], "Properties": { "string" : "string" } } ], "EbsConfiguration": { "EbsBlockDeviceConfigs": [ { "VolumeSpecification": { "Iops": number, "SizeInGB": number, "VolumeType": "string" }, "VolumesPerInstance": number

API Version 2009-03-31113

Page 127: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceRequest Syntax

} ], "EbsOptimized": boolean }, "InstanceCount": number, "InstanceRole": "string", "InstanceType": "string", "Market": "string", "Name": "string" } ], "KeepJobFlowAliveWhenNoSteps": boolean, "MasterInstanceType": "string", "Placement": { "AvailabilityZone": "string", "AvailabilityZones": [ "string" ] }, "ServiceAccessSecurityGroup": "string", "SlaveInstanceType": "string", "TerminationProtected": boolean }, "JobFlowRole": "string", "KerberosAttributes": { "ADDomainJoinPassword": "string", "ADDomainJoinUser": "string", "CrossRealmTrustPrincipalPassword": "string", "KdcAdminPassword": "string", "Realm": "string" }, "LogEncryptionKmsKeyId": "string", "LogUri": "string", "ManagedScalingPolicy": { "ComputeLimits": { "MaximumCapacityUnits": number, "MaximumCoreCapacityUnits": number, "MaximumOnDemandCapacityUnits": number, "MinimumCapacityUnits": number, "UnitType": "string" } }, "Name": "string", "NewSupportedProducts": [ { "Args": [ "string" ], "Name": "string" } ], "PlacementGroupConfigs": [ { "InstanceRole": "string", "PlacementStrategy": "string" } ], "ReleaseLabel": "string", "RepoUpgradeOnBoot": "string", "ScaleDownBehavior": "string", "SecurityConfiguration": "string", "ServiceRole": "string", "StepConcurrencyLevel": number, "Steps": [ { "ActionOnFailure": "string", "HadoopJarStep": { "Args": [ "string" ], "Jar": "string", "MainClass": "string",

API Version 2009-03-31114

Page 128: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceRequest Parameters

"Properties": [ { "Key": "string", "Value": "string" } ] }, "Name": "string" } ], "SupportedProducts": [ "string" ], "Tags": [ { "Key": "string", "Value": "string" } ], "VisibleToAllUsers": boolean}

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

The request accepts the following data in JSON format.

AdditionalInfo (p. 111)

A JSON string for selecting additional features.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: No

AmiVersion (p. 111)

Applies only to Amazon EMR AMI versions 3.x and 2.x. For Amazon EMR releases 4.0 and later,ReleaseLabel is used. To specify a custom AMI, use CustomAmiID.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: No

Applications (p. 111)

Applies to Amazon EMR releases 4.0 and later. A case-insensitive list of applications for AmazonEMR to install and configure when launching the cluster. For a list of applications available for eachAmazon EMR release version, see the Amazon EMR Release Guide.

Type: Array of Application (p. 145) objects

Required: No

API Version 2009-03-31115

Page 129: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceRequest Parameters

AutoScalingRole (p. 111)

An IAM role for automatic scaling policies. The default role is EMR_AutoScaling_DefaultRole.The IAM role provides permissions that the automatic scaling feature requires to launch andterminate EC2 instances in an instance group.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: NoBootstrapActions (p. 111)

A list of bootstrap actions to run before Hadoop starts on the cluster nodes.

Type: Array of BootstrapActionConfig (p. 152) objects

Required: NoConfigurations (p. 111)

For Amazon EMR releases 4.0 and later. The list of configurations supplied for the EMR cluster youare creating.

Type: Array of Configuration (p. 171) objects

Required: NoCustomAmiId (p. 111)

Available only in Amazon EMR version 5.7.0 and later. The ID of a custom Amazon EBS-backedLinux AMI. If specified, Amazon EMR uses this AMI when it launches cluster EC2 instances. Formore information about custom AMIs in Amazon EMR, see Using a Custom AMI in the Amazon EMRManagement Guide. If omitted, the cluster uses the base Linux AMI for the ReleaseLabel specified.For Amazon EMR versions 2.x and 3.x, use AmiVersion instead.

For information about creating a custom AMI, see Creating an Amazon EBS-Backed Linux AMI in theAmazon Elastic Compute Cloud User Guide for Linux Instances. For information about finding an AMIID, see Finding a Linux AMI.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: NoEbsRootVolumeSize (p. 111)

The size, in GiB, of the Amazon EBS root device volume of the Linux AMI that is used for each EC2instance. Available in Amazon EMR version 4.x and later.

Type: Integer

Required: NoInstances (p. 111)

A specification of the number and type of Amazon EC2 instances.

Type: JobFlowInstancesConfig (p. 224) object

API Version 2009-03-31116

Page 130: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceRequest Parameters

Required: YesJobFlowRole (p. 111)

Also called instance profile and EC2 role. An IAM role for an EMR cluster. The EC2 instances of thecluster assume this role. The default role is EMR_EC2_DefaultRole. In order to use the default role,you must have already created it using the CLI or console.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: NoKerberosAttributes (p. 111)

Attributes for Kerberos configuration when Kerberos authentication is enabled using a securityconfiguration. For more information see Use Kerberos Authentication in the Amazon EMRManagement Guide.

Type: KerberosAttributes (p. 231) object

Required: NoLogEncryptionKmsKeyId (p. 111)

The AWS KMS customer master key (CMK) used for encrypting log files. If a value is not provided, thelogs remain encrypted by AES-256. This attribute is only available with Amazon EMR version 5.30.0and later, excluding Amazon EMR 6.0.0.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: NoLogUri (p. 111)

The location in Amazon S3 to write the log files of the job flow. If a value is not provided, logs arenot created.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: NoManagedScalingPolicy (p. 111)

The specified managed scaling policy for an Amazon EMR cluster.

Type: ManagedScalingPolicy (p. 234) object

Required: NoName (p. 111)

The name of the job flow.

Type: String

API Version 2009-03-31117

Page 131: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceRequest Parameters

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: YesNewSupportedProducts (p. 111)

NoteFor Amazon EMR releases 3.x and 2.x. For Amazon EMR releases 4.x and later, useApplications.

A list of strings that indicates third-party software to use with the job flow that accepts a userargument list. EMR accepts and forwards the argument list to the corresponding installation script asbootstrap action arguments. For more information, see "Launch a Job Flow on the MapR Distributionfor Hadoop" in the Amazon EMR Developer Guide. Supported values are:• "mapr-m3" - launch the cluster using MapR M3 Edition.• "mapr-m5" - launch the cluster using MapR M5 Edition.• "mapr" with the user arguments specifying "--edition,m3" or "--edition,m5" - launch the job flow

using MapR M3 or M5 Edition respectively.• "mapr-m7" - launch the cluster using MapR M7 Edition.• "hunk" - launch the cluster with the Hunk Big Data Analytics Platform.• "hue"- launch the cluster with Hue installed.• "spark" - launch the cluster with Apache Spark installed.• "ganglia" - launch the cluster with the Ganglia Monitoring System installed.

Type: Array of SupportedProductConfig (p. 278) objects

Required: NoPlacementGroupConfigs (p. 111)

The specified placement group configuration for an Amazon EMR cluster.

Type: Array of PlacementGroupConfig (p. 244) objects

Required: NoReleaseLabel (p. 111)

The Amazon EMR release label, which determines the version of open-source application packagesinstalled on the cluster. Release labels are in the form emr-x.x.x, where x.x.x is an Amazon EMRrelease version such as emr-5.14.0. For more information about Amazon EMR release versionsand included application versions and features, see https://docs.aws.amazon.com/emr/latest/ReleaseGuide/. The release label applies only to Amazon EMR releases version 4.0 and later. Earlierversions use AmiVersion.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: NoRepoUpgradeOnBoot (p. 111)

Applies only when CustomAmiID is used. Specifies which updates from the Amazon Linux AMIpackage repositories to apply automatically when the instance boots using the AMI. If omitted, thedefault is SECURITY, which indicates that only security updates are applied. If NONE is specified, noupdates are applied, and all updates must be applied manually.

API Version 2009-03-31118

Page 132: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceRequest Parameters

Type: String

Valid Values: SECURITY | NONE

Required: NoScaleDownBehavior (p. 111)

Specifies the way that individual Amazon EC2 instances terminate when an automatic scale-inactivity occurs or an instance group is resized. TERMINATE_AT_INSTANCE_HOUR indicates thatAmazon EMR terminates nodes at the instance-hour boundary, regardless of when the request toterminate the instance was submitted. This option is only available with Amazon EMR 5.1.0 andlater and is the default for clusters created using that version. TERMINATE_AT_TASK_COMPLETIONindicates that Amazon EMR adds nodes to a deny list and drains tasks from nodes beforeterminating the Amazon EC2 instances, regardless of the instance-hour boundary. With eitherbehavior, Amazon EMR removes the least active nodes first and blocks instance termination if itcould lead to HDFS corruption. TERMINATE_AT_TASK_COMPLETION available only in Amazon EMRversion 4.1.0 and later, and is the default for versions of Amazon EMR earlier than 5.1.0.

Type: String

Valid Values: TERMINATE_AT_INSTANCE_HOUR | TERMINATE_AT_TASK_COMPLETION

Required: NoSecurityConfiguration (p. 111)

The name of a security configuration to apply to the cluster.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: NoServiceRole (p. 111)

The IAM role that will be assumed by the Amazon EMR service to access AWS resources on yourbehalf.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: NoStepConcurrencyLevel (p. 111)

Specifies the number of steps that can be executed concurrently. The default value is 1. Themaximum value is 256.

Type: Integer

Required: NoSteps (p. 111)

A list of steps to run.

Type: Array of StepConfig (p. 264) objects

API Version 2009-03-31119

Page 133: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceResponse Syntax

Required: NoSupportedProducts (p. 111)

NoteFor Amazon EMR releases 3.x and 2.x. For Amazon EMR releases 4.x and later, useApplications.

A list of strings that indicates third-party software to use. For more information, see the AmazonEMR Developer Guide. Currently supported values are:• "mapr-m3" - launch the job flow using MapR M3 Edition.• "mapr-m5" - launch the job flow using MapR M5 Edition.

Type: Array of strings

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: NoTags (p. 111)

A list of tags to associate with a cluster and propagate to Amazon EC2 instances.

Type: Array of Tag (p. 279) objects

Required: NoVisibleToAllUsers (p. 111)

Set this value to true so that IAM principals in the AWS account associated with the cluster canperform EMR actions on the cluster that their IAM policies allow. This value defaults to false forclusters created using the EMR API or the AWS CLI create-cluster command.

When set to false, only the IAM principal that created the cluster and the AWS account root usercan perform EMR actions for the cluster, regardless of the IAM permissions policies attached to otherIAM principals. For more information, see Understanding the EMR Cluster VisibleToAllUsers Settingin the Amazon EMR Management Guide.

Type: Boolean

Required: No

Response Syntax{ "ClusterArn": "string", "JobFlowId": "string"}

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

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

ClusterArn (p. 120)

The Amazon Resource Name (ARN) of the cluster.

API Version 2009-03-31120

Page 134: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceErrors

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.JobFlowId (p. 120)

A unique identifier for the job flow.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

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

InternalServerError

Indicates that an error occurred while processing the request and that the request was notcompleted.

HTTP Status Code: 400

Examples

Example 1This example illustrates one usage of RunJobFlow.

Sample Request

POST / HTTP/1.1Content-Type: application/x-amz-json-1.1X-Amz-Target: ElasticMapReduce.RunJobFlowContent-Length: 734User-Agent: aws-sdk-ruby/1.9.2 ruby/1.9.3 i386-mingw32Host: us-east-1.elasticmapreduce.amazonaws.comX-Amz-Date: 20130715T210803ZX-Amz-Content-Sha256: 8676d21986e4628a89fb1232a1344063778d4ffc23d10be02b437e0d53a24db3Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20130715/us-east-1/elasticmapreduce/aws4_request, SignedHeaders=content-length;content-type;host;user-agent;x-amz-content-sha256;x-amz-date;x-amz-target, Signature=71f79725c4dbe77c0e842718485f0b37fe6df69e1153c80f7748ebd9617ca2f3Accept: */*

{ "Name": "Development Job Flow", "Instances": { "KeepJobFlowAliveWhenNoSteps": "false", "TerminationProtected": "false", "InstanceGroups": [{ "Name": "Master Instance Group", "InstanceRole": "MASTER", "InstanceCount": 1, "InstanceType": "m1.small", "Market": "ON_DEMAND"

API Version 2009-03-31121

Page 135: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceSee Also

}] }, "Steps": [{ "Name": "Example Streaming Step", "ActionOnFailure": "CANCEL_AND_WAIT", "HadoopJarStep": { "Jar": "/home/hadoop/contrib/streaming/hadoop-streaming.jar", "Args": [ "-input", "s3://elasticmapreduce/samples/wordcount/input", "-output", "s3://examples-bucket/example-output", "-mapper", "s3://elasticmapreduce/samples/wordcount/wordSplitter.py", "-reducer", "aggregate" ] } }], "BootstrapActions": [], "NewSupportedProduct": [], "AmiVersion": "3.8.0"}

Sample Response

HTTP/1.1 200 OKx-amzn-RequestId: a4406d6b-ed92-11e2-9787-192218ecb460Content-Type: application/x-amz-json-1.1Content-Length: 31Date: Mon, 15 Jul 2013 21:08:05 GMT

{"JobFlowId": "j-ZKIY4CKQRX72"}

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

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

API Version 2009-03-31122

Page 136: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceSetTerminationProtection

SetTerminationProtectionSetTerminationProtection locks a cluster (job flow) so the EC2 instances in the cluster cannot beterminated by user intervention, an API call, or in the event of a job-flow error. The cluster stillterminates upon successful completion of the job flow. Calling SetTerminationProtection on acluster is similar to calling the Amazon EC2 DisableAPITermination API on all EC2 instances in acluster.

SetTerminationProtection is used to prevent accidental termination of a cluster and to ensure thatin the event of an error, the instances persist so that you can recover any data stored in their ephemeralinstance storage.

To terminate a cluster that has been locked by setting SetTerminationProtection to true, you mustfirst unlock the job flow by a subsequent call to SetTerminationProtection in which you set thevalue to false.

For more information, seeManaging Cluster Termination in the Amazon EMR Management Guide.

Request Syntax{ "JobFlowIds": [ "string" ], "TerminationProtected": boolean}

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

The request accepts the following data in JSON format.

JobFlowIds (p. 123)

A list of strings that uniquely identify the clusters to protect. This identifier is returned byRunJobFlow (p. 111) and can also be obtained from DescribeJobFlows (p. 40) .

Type: Array of strings

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: YesTerminationProtected (p. 123)

A Boolean that indicates whether to protect the cluster and prevent the Amazon EC2 instances in thecluster from shutting down due to API calls, user intervention, or job-flow error.

Type: Boolean

Required: Yes

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

API Version 2009-03-31123

Page 137: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceErrors

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

InternalServerError

Indicates that an error occurred while processing the request and that the request was notcompleted.

HTTP Status Code: 400

Examples

ExampleThis example illustrates one usage of SetTerminationProtection.

Sample Request

POST / HTTP/1.1Content-Type: application/x-amz-json-1.1X-Amz-Target: ElasticMapReduce.SetTerminationProtectionContent-Length: 61User-Agent: aws-sdk-ruby/1.9.2 ruby/1.9.3 i386-mingw32Host: us-east-1.elasticmapreduce.amazonaws.comX-Amz-Date: 20130716T211420ZX-Amz-Content-Sha256: c362fadae0fce377aa63f04388aeb90c53cedb17a8bfbb8cffcb10c2378137f9Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20130716/us-east-1/elasticmapreduce/aws4_request, SignedHeaders=content-length;content-type;host;user-agent;x-amz-content-sha256;x-amz-date;x-amz-target, Signature=764b6aa1a38733cadff35a2e884887e9f1208a422266bc83ac77e8d0b80bd4cfAccept: */*

{ "JobFlowIds": ["j-3TS0OIYO4NFN"], "TerminationProtected": true}

Sample Response

HTTP/1.1 200 OKx-amzn-RequestId: af23b1db-ee5c-11e2-9787-192218ecb460Content-Type: application/x-amz-json-1.1Content-Length: 0Date: Tue, 16 Jul 2013 21:14:21 GMT

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

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

API Version 2009-03-31124

Page 139: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceSetVisibleToAllUsers

SetVisibleToAllUsersSets the Cluster:VisibleToAllUsers (p. 161) value for an EMR cluster. When true, IAM principals in theAWS account can perform EMR cluster actions that their IAM policies allow. When false, only the IAMprincipal that created the cluster and the AWS account root user can perform EMR actions on the cluster,regardless of IAM permissions policies attached to other IAM principals.

This action works on running clusters. When you create a cluster, use theRunJobFlow:VisibleToAllUsers (p. 120) parameter.

For more information, see Understanding the EMR Cluster VisibleToAllUsers Setting in the Amazon EMRManagement Guide.

Request Syntax{ "JobFlowIds": [ "string" ], "VisibleToAllUsers": boolean}

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

The request accepts the following data in JSON format.

JobFlowIds (p. 126)

The unique identifier of the job flow (cluster).

Type: Array of strings

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: YesVisibleToAllUsers (p. 126)

A value of true indicates that an IAM principal in the AWS account can perform EMR actions on thecluster that the IAM policies attached to the principal allow. A value of false indicates that only theIAM principal that created the cluster and the AWS root user can perform EMR actions on the cluster.

Type: Boolean

Required: Yes

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

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

API Version 2009-03-31126

Page 140: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceExamples

InternalServerError

Indicates that an error occurred while processing the request and that the request was notcompleted.

HTTP Status Code: 400

ExamplesExampleThis example illustrates one usage of SetVisibleToAllUsers.

Sample Request

POST / HTTP/1.1Content-Type: application/x-amz-json-1.1X-Amz-Target: ElasticMapReduce.SetVisibleToAllUsersContent-Length: 58User-Agent: aws-sdk-ruby/1.9.2 ruby/1.9.3 i386-mingw32Host: us-east-1.elasticmapreduce.amazonaws.comX-Amz-Date: 20130715T221616ZX-Amz-Content-Sha256: 2ff32d11eab2383d764ffcb97571454e798689ecd09a7b1bb2327e22b0b930d4Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20130715/us-east-1/elasticmapreduce/aws4_request, SignedHeaders=content-length;content-type;host;user-agent;x-amz-content-sha256;x-amz-date;x-amz-target, Signature=e1a00b37787d9ccc43c9de32f1f0a73813b0bd6643d4db7762b62a7092d51997Accept: */*

{ "JobFlowIds": ["j-ZKIY4CKQRX72"], "VisibleToAllUsers": true}

Sample Response

HTTP/1.1 200 OKx-amzn-RequestId: 2be9cde9-ed9c-11e2-82b6-2351cde3f33fContent-Type: application/x-amz-json-1.1Content-Length: 0Date: Mon, 15 Jul 2013 22:16:18 GMT

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

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

API Version 2009-03-31127

Page 142: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceStartNotebookExecution

StartNotebookExecutionStarts a notebook execution.

Request Syntax{ "EditorId": "string", "ExecutionEngine": { "Id": "string", "MasterInstanceSecurityGroupId": "string", "Type": "string" }, "NotebookExecutionName": "string", "NotebookInstanceSecurityGroupId": "string", "NotebookParams": "string", "RelativePath": "string", "ServiceRole": "string", "Tags": [ { "Key": "string", "Value": "string" } ]}

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

The request accepts the following data in JSON format.

EditorId (p. 129)

The unique identifier of the EMR Notebook to use for notebook execution.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: YesExecutionEngine (p. 129)

Specifies the execution engine (cluster) that runs the notebook execution.

Type: ExecutionEngineConfig (p. 179) object

Required: YesNotebookExecutionName (p. 129)

An optional name for the notebook execution.

Type: String

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

API Version 2009-03-31129

Page 143: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceRequest Parameters

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: NoNotebookInstanceSecurityGroupId (p. 129)

The unique identifier of the Amazon EC2 security group to associate with the EMR Notebook for thisnotebook execution.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: NoNotebookParams (p. 129)

Input parameters in JSON format passed to the EMR Notebook at runtime for execution.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: NoRelativePath (p. 129)

The path and file name of the notebook file for this execution, relative to the path specified forthe EMR Notebook. For example, if you specify a path of s3://MyBucket/MyNotebooks whenyou create an EMR Notebook for a notebook with an ID of e-ABCDEFGHIJK1234567890ABCD (theEditorID of this request), and you specify a RelativePath of my_notebook_executions/notebook_execution.ipynb, the location of the file for the notebook execution is s3://MyBucket/MyNotebooks/e-ABCDEFGHIJK1234567890ABCD/my_notebook_executions/notebook_execution.ipynb.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: YesServiceRole (p. 129)

The name or ARN of the IAM role that is used as the service role for Amazon EMR (the EMR role) forthe notebook execution.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: YesTags (p. 129)

A list of tags associated with a notebook execution. Tags are user-defined key-value pairs thatconsist of a required key string with a maximum of 128 characters and an optional value string witha maximum of 256 characters.

API Version 2009-03-31130

Page 144: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceResponse Syntax

Type: Array of Tag (p. 279) objects

Required: No

Response Syntax{ "NotebookExecutionId": "string"}

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

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

NotebookExecutionId (p. 131)

The unique identifier of the notebook execution.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

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

InternalServerException

This exception occurs when there is an internal failure in the Amazon EMR service.

HTTP Status Code: 500InvalidRequestException

This exception occurs when there is something wrong with user input.

HTTP Status Code: 400

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

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

API Version 2009-03-31131

Page 145: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceSee Also

• AWS SDK for Python• AWS SDK for Ruby V3

API Version 2009-03-31132

Page 146: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceStopNotebookExecution

StopNotebookExecutionStops a notebook execution.

Request Syntax{ "NotebookExecutionId": "string"}

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

The request accepts the following data in JSON format.

NotebookExecutionId (p. 133)

The unique identifier of the notebook execution.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: Yes

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

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

InternalServerError

Indicates that an error occurred while processing the request and that the request was notcompleted.

HTTP Status Code: 400InvalidRequestException

This exception occurs when there is something wrong with user input.

HTTP Status Code: 400

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

API Version 2009-03-31133

Page 148: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceTerminateJobFlows

TerminateJobFlowsTerminateJobFlows shuts a list of clusters (job flows) down. When a job flow is shut down, any stepnot yet completed is canceled and the EC2 instances on which the cluster is running are stopped. Anylog files not already saved are uploaded to Amazon S3 if a LogUri was specified when the cluster wascreated.

The maximum number of clusters allowed is 10. The call to TerminateJobFlows is asynchronous.Depending on the configuration of the cluster, it may take up to 1-5 minutes for the cluster tocompletely terminate and release allocated resources, such as Amazon EC2 instances.

Request Syntax

{ "JobFlowIds": [ "string" ]}

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

The request accepts the following data in JSON format.

JobFlowIds (p. 135)

A list of job flows to be shut down.

Type: Array of strings

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: Yes

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

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

InternalServerError

Indicates that an error occurred while processing the request and that the request was notcompleted.

HTTP Status Code: 400

API Version 2009-03-31135

Page 149: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceExamples

ExamplesExampleThis example illustrates one usage of TerminateJobFlows.

Sample Request

POST / HTTP/1.1Content-Type: application/x-amz-json-1.1X-Amz-Target: ElasticMapReduce.TerminateJobFlowsContent-Length: 33User-Agent: aws-sdk-ruby/1.9.2 ruby/1.9.3 i386-mingw32Host: us-east-1.elasticmapreduce.amazonaws.comX-Amz-Date: 20130716T211858ZX-Amz-Content-Sha256: ab64713f61e066e80a6083844b9249b6c6362d34a7ae7393047aa46d38b9e315Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20130716/us-east-1/elasticmapreduce/aws4_request, SignedHeaders=content-length;content-type;host;user-agent;x-amz-content-sha256;x-amz-date;x-amz-target, Signature=9791416eaf09f36aa753a324b0de27ff5cc7084b8548cc748487a2bcb3439d58Accept: */*

{"JobFlowIds": ["j-3TS0OIYO4NFN"]}

Sample Response

HTTP/1.1 200 OKx-amzn-RequestId: 5551a7c9-ee5d-11e2-9542-25296c300ff0Content-Type: application/x-amz-json-1.1Content-Length: 0Date: Tue, 16 Jul 2013 21:18:59 GMT

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

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

API Version 2009-03-31136

Page 150: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceUpdateStudio

UpdateStudioUpdates an Amazon EMR Studio configuration, including attributes such as name, description, andsubnets.

Request Syntax{ "DefaultS3Location": "string", "Description": "string", "Name": "string", "StudioId": "string", "SubnetIds": [ "string" ]}

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

The request accepts the following data in JSON format.

DefaultS3Location (p. 137)

The Amazon S3 location to back up Workspaces and notebook files for the Amazon EMR Studio.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: NoDescription (p. 137)

A detailed description to assign to the Amazon EMR Studio.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: NoName (p. 137)

A descriptive name for the Amazon EMR Studio.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: NoStudioId (p. 137)

The ID of the Amazon EMR Studio to update.

API Version 2009-03-31137

Page 151: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceResponse Elements

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: YesSubnetIds (p. 137)

A list of subnet IDs to associate with the Amazon EMR Studio. The list can include new subnet IDs,but must also include all of the subnet IDs previously associated with the Studio. The list order doesnot matter. A Studio can have a maximum of 5 subnets. The subnets must belong to the same VPCas the Studio.

Type: Array of strings

Required: No

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

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

InternalServerException

This exception occurs when there is an internal failure in the Amazon EMR service.

HTTP Status Code: 500InvalidRequestException

This exception occurs when there is something wrong with user input.

HTTP Status Code: 400

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

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

API Version 2009-03-31138

Page 152: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceUpdateStudioSessionMapping

UpdateStudioSessionMappingUpdates the session policy attached to the user or group for the specified Amazon EMR Studio.

Request Syntax{ "IdentityId": "string", "IdentityName": "string", "IdentityType": "string", "SessionPolicyArn": "string", "StudioId": "string"}

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

The request accepts the following data in JSON format.

IdentityId (p. 139)

The globally unique identifier (GUID) of the user or group. For more information, see UserId andGroupId in the AWS SSO Identity Store API Reference. Either IdentityName or IdentityId must bespecified.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: No

IdentityName (p. 139)

The name of the user or group to update. For more information, see UserName and DisplayName inthe AWS SSO Identity Store API Reference. Either IdentityName or IdentityId must be specified.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: No

IdentityType (p. 139)

Specifies whether the identity to update is a user or a group.

Type: String

Valid Values: USER | GROUP

Required: Yes

API Version 2009-03-31139

Page 153: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceResponse Elements

SessionPolicyArn (p. 139)

The Amazon Resource Name (ARN) of the session policy to associate with the specified user orgroup.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: YesStudioId (p. 139)

The ID of the Amazon EMR Studio.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: Yes

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

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

InternalServerError

Indicates that an error occurred while processing the request and that the request was notcompleted.

HTTP Status Code: 400InvalidRequestException

This exception occurs when there is something wrong with user input.

HTTP Status Code: 400

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

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

API Version 2009-03-31140

Page 154: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceSee Also

• AWS SDK for Python• AWS SDK for Ruby V3

API Version 2009-03-31141

Page 155: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API Reference

Data TypesThe Amazon Elastic MapReduce API contains several data types that various actions use. This sectiondescribes each data type in detail.

NoteThe order of each element in a data type structure is not guaranteed. Applications should notassume a particular order.

The following data types are supported:

• Application (p. 145)• AutoScalingPolicy (p. 146)• AutoScalingPolicyDescription (p. 147)• AutoScalingPolicyStateChangeReason (p. 148)• AutoScalingPolicyStatus (p. 149)• BlockPublicAccessConfiguration (p. 150)• BlockPublicAccessConfigurationMetadata (p. 151)• BootstrapActionConfig (p. 152)• BootstrapActionDetail (p. 153)• CancelStepsInfo (p. 154)• CloudWatchAlarmDefinition (p. 155)• Cluster (p. 157)• ClusterStateChangeReason (p. 163)• ClusterStatus (p. 164)• ClusterSummary (p. 165)• ClusterTimeline (p. 167)• Command (p. 168)• ComputeLimits (p. 169)• Configuration (p. 171)• EbsBlockDevice (p. 172)• EbsBlockDeviceConfig (p. 173)• EbsConfiguration (p. 174)• EbsVolume (p. 175)• Ec2InstanceAttributes (p. 176)• ExecutionEngineConfig (p. 179)• FailureDetails (p. 180)• HadoopJarStepConfig (p. 181)• HadoopStepConfig (p. 183)• Instance (p. 184)• InstanceFleet (p. 186)• InstanceFleetConfig (p. 189)• InstanceFleetModifyConfig (p. 191)• InstanceFleetProvisioningSpecifications (p. 192)• InstanceFleetStateChangeReason (p. 193)• InstanceFleetStatus (p. 194)

API Version 2009-03-31142

Page 156: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API Reference

• InstanceFleetTimeline (p. 196)• InstanceGroup (p. 197)• InstanceGroupConfig (p. 200)• InstanceGroupDetail (p. 202)• InstanceGroupModifyConfig (p. 205)• InstanceGroupStateChangeReason (p. 207)• InstanceGroupStatus (p. 208)• InstanceGroupTimeline (p. 209)• InstanceResizePolicy (p. 210)• InstanceStateChangeReason (p. 211)• InstanceStatus (p. 212)• InstanceTimeline (p. 213)• InstanceTypeConfig (p. 214)• InstanceTypeSpecification (p. 216)• JobFlowDetail (p. 218)• JobFlowExecutionStatusDetail (p. 222)• JobFlowInstancesConfig (p. 224)• JobFlowInstancesDetail (p. 228)• KerberosAttributes (p. 231)• KeyValue (p. 233)• ManagedScalingPolicy (p. 234)• MetricDimension (p. 235)• NotebookExecution (p. 236)• NotebookExecutionSummary (p. 239)• OnDemandCapacityReservationOptions (p. 241)• OnDemandProvisioningSpecification (p. 243)• PlacementGroupConfig (p. 244)• PlacementType (p. 245)• PortRange (p. 246)• ScalingAction (p. 247)• ScalingConstraints (p. 248)• ScalingRule (p. 249)• ScalingTrigger (p. 250)• ScriptBootstrapActionConfig (p. 251)• SecurityConfigurationSummary (p. 252)• SessionMappingDetail (p. 253)• SessionMappingSummary (p. 255)• ShrinkPolicy (p. 257)• SimpleScalingPolicyConfiguration (p. 258)• SpotProvisioningSpecification (p. 260)• Step (p. 262)• StepConfig (p. 264)• StepDetail (p. 266)• StepExecutionStatusDetail (p. 267)• StepStateChangeReason (p. 269)• StepStatus (p. 270)

API Version 2009-03-31143

Page 157: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API Reference

• StepSummary (p. 271)• StepTimeline (p. 272)• Studio (p. 273)• StudioSummary (p. 276)• SupportedProductConfig (p. 278)• Tag (p. 279)• VolumeSpecification (p. 280)

API Version 2009-03-31144

Page 158: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceApplication

ApplicationWith Amazon EMR release version 4.0 and later, the only accepted parameter is the application name. Topass arguments to applications, you use configuration classifications specified using configuration JSONobjects. For more information, see Configuring Applications.

With earlier Amazon EMR releases, the application is any Amazon or third-party software that you canadd to the cluster. This structure contains a list of strings that indicates the software to use with thecluster and accepts a user argument list. Amazon EMR accepts and forwards the argument list to thecorresponding installation script as bootstrap action argument.

ContentsAdditionalInfo

This option is for advanced users only. This is meta information about third-party applications thatthird-party vendors use for testing purposes.

Type: String to string map

Required: NoArgs

Arguments for Amazon EMR to pass to the application.

Type: Array of strings

Required: NoName

The name of the application.

Type: String

Required: NoVersion

The version of the application.

Type: String

Required: No

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

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3

API Version 2009-03-31145

Page 159: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceAutoScalingPolicy

AutoScalingPolicyAn automatic scaling policy for a core instance group or task instance group in an Amazon EMR cluster.An automatic scaling policy defines how an instance group dynamically adds and terminates EC2instances in response to the value of a CloudWatch metric. See PutAutoScalingPolicy (p. 96).

ContentsConstraints

The upper and lower EC2 instance limits for an automatic scaling policy. Automatic scaling activitywill not cause an instance group to grow above or below these limits.

Type: ScalingConstraints (p. 248) object

Required: YesRules

The scale-in and scale-out rules that comprise the automatic scaling policy.

Type: Array of ScalingRule (p. 249) objects

Required: Yes

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

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3

API Version 2009-03-31146

Page 160: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceAutoScalingPolicyDescription

AutoScalingPolicyDescriptionAn automatic scaling policy for a core instance group or task instance group in an Amazon EMR cluster.The automatic scaling policy defines how an instance group dynamically adds and terminates EC2instances in response to the value of a CloudWatch metric. See PutAutoScalingPolicy (p. 96).

ContentsConstraints

The upper and lower EC2 instance limits for an automatic scaling policy. Automatic scaling activitywill not cause an instance group to grow above or below these limits.

Type: ScalingConstraints (p. 248) object

Required: NoRules

The scale-in and scale-out rules that comprise the automatic scaling policy.

Type: Array of ScalingRule (p. 249) objects

Required: NoStatus

The status of an automatic scaling policy.

Type: AutoScalingPolicyStatus (p. 149) object

Required: No

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

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3

API Version 2009-03-31147

Page 161: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceAutoScalingPolicyStateChangeReason

AutoScalingPolicyStateChangeReasonThe reason for an AutoScalingPolicyStatus (p. 149) change.

ContentsCode

The code indicating the reason for the change in status.USER_REQUEST indicates that the scalingpolicy status was changed by a user. PROVISION_FAILURE indicates that the status change wasbecause the policy failed to provision. CLEANUP_FAILURE indicates an error.

Type: String

Valid Values: USER_REQUEST | PROVISION_FAILURE | CLEANUP_FAILURE

Required: NoMessage

A friendly, more verbose message that accompanies an automatic scaling policy state change.

Type: String

Required: No

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

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3

API Version 2009-03-31148

Page 162: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceAutoScalingPolicyStatus

AutoScalingPolicyStatusThe status of an automatic scaling policy.

ContentsState

Indicates the status of the automatic scaling policy.

Type: String

Valid Values: PENDING | ATTACHING | ATTACHED | DETACHING | DETACHED | FAILED

Required: NoStateChangeReason

The reason for a change in status.

Type: AutoScalingPolicyStateChangeReason (p. 148) object

Required: No

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

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3

API Version 2009-03-31149

Page 163: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceBlockPublicAccessConfiguration

BlockPublicAccessConfigurationA configuration for Amazon EMR block public access. When BlockPublicSecurityGroupRules isset to true, Amazon EMR prevents cluster creation if one of the cluster's security groups has a rule thatallows inbound traffic from 0.0.0.0/0 or ::/0 on a port, unless the port is specified as an exception usingPermittedPublicSecurityGroupRuleRanges.

ContentsBlockPublicSecurityGroupRules

Indicates whether Amazon EMR block public access is enabled (true) or disabled (false). Bydefault, the value is false for accounts that have created EMR clusters before July 2019. Foraccounts created after this, the default is true.

Type: Boolean

Required: YesPermittedPublicSecurityGroupRuleRanges

Specifies ports and port ranges that are permitted to have security group rules that allowinbound traffic from all public sources. For example, if Port 23 (Telnet) is specified forPermittedPublicSecurityGroupRuleRanges, Amazon EMR allows cluster creation if a securitygroup associated with the cluster has a rule that allows inbound traffic on Port 23 from IPv40.0.0.0/0 or IPv6 port ::/0 as the source.

By default, Port 22, which is used for SSH access to the cluster EC2 instances, is in the list ofPermittedPublicSecurityGroupRuleRanges.

Type: Array of PortRange (p. 246) objects

Required: No

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

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3

API Version 2009-03-31150

Page 164: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceBlockPublicAccessConfigurationMetadata

BlockPublicAccessConfigurationMetadataProperties that describe the AWS principal that created the BlockPublicAccessConfigurationusing the PutBlockPublicAccessConfiguration action as well as the date and time that theconfiguration was created. Each time a configuration for block public access is updated, Amazon EMRupdates this metadata.

ContentsCreatedByArn

The Amazon Resource Name that created or last modified the configuration.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Required: YesCreationDateTime

The date and time that the configuration was created.

Type: Timestamp

Required: Yes

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

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3

API Version 2009-03-31151

Page 165: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceBootstrapActionConfig

BootstrapActionConfigConfiguration of a bootstrap action.

ContentsName

The name of the bootstrap action.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: YesScriptBootstrapAction

The script run by the bootstrap action.

Type: ScriptBootstrapActionConfig (p. 251) object

Required: Yes

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

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3

API Version 2009-03-31152

Page 166: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceBootstrapActionDetail

BootstrapActionDetailReports the configuration of a bootstrap action in a cluster (job flow).

ContentsBootstrapActionConfig

A description of the bootstrap action.

Type: BootstrapActionConfig (p. 152) object

Required: No

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

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3

API Version 2009-03-31153

Page 167: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceCancelStepsInfo

CancelStepsInfoSpecification of the status of a CancelSteps request. Available only in Amazon EMR version 4.8.0 andlater, excluding version 5.0.0.

ContentsReason

The reason for the failure if the CancelSteps request fails.

Type: String

Required: NoStatus

The status of a CancelSteps Request. The value may be SUBMITTED or FAILED.

Type: String

Valid Values: SUBMITTED | FAILED

Required: NoStepId

The encrypted StepId of a step.

Type: String

Required: No

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

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3

API Version 2009-03-31154

Page 168: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceCloudWatchAlarmDefinition

CloudWatchAlarmDefinitionThe definition of a CloudWatch metric alarm, which determines when an automatic scaling activity istriggered. When the defined alarm conditions are satisfied, scaling activity begins.

ContentsComparisonOperator

Determines how the metric specified by MetricName is compared to the value specified byThreshold.

Type: String

Valid Values: GREATER_THAN_OR_EQUAL | GREATER_THAN | LESS_THAN |LESS_THAN_OR_EQUAL

Required: YesDimensions

A CloudWatch metric dimension.

Type: Array of MetricDimension (p. 235) objects

Required: NoEvaluationPeriods

The number of periods, in five-minute increments, during which the alarm condition must existbefore the alarm triggers automatic scaling activity. The default value is 1.

Type: Integer

Required: NoMetricName

The name of the CloudWatch metric that is watched to determine an alarm condition.

Type: String

Required: YesNamespace

The namespace for the CloudWatch metric. The default is AWS/ElasticMapReduce.

Type: String

Required: NoPeriod

The period, in seconds, over which the statistic is applied. EMR CloudWatch metrics are emittedevery five minutes (300 seconds), so if an EMR CloudWatch metric is specified, specify 300.

Type: Integer

Required: YesStatistic

The statistic to apply to the metric associated with the alarm. The default is AVERAGE.

API Version 2009-03-31155

Page 169: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceSee Also

Type: String

Valid Values: SAMPLE_COUNT | AVERAGE | SUM | MINIMUM | MAXIMUM

Required: NoThreshold

The value against which the specified statistic is compared.

Type: Double

Valid Range: Minimum value of 0.0.

Required: YesUnit

The unit of measure associated with the CloudWatch metric being watched. The value specified forUnit must correspond to the units specified in the CloudWatch metric.

Type: String

Valid Values: NONE | SECONDS | MICRO_SECONDS | MILLI_SECONDS | BYTES |KILO_BYTES | MEGA_BYTES | GIGA_BYTES | TERA_BYTES | BITS | KILO_BITS |MEGA_BITS | GIGA_BITS | TERA_BITS | PERCENT | COUNT | BYTES_PER_SECOND| KILO_BYTES_PER_SECOND | MEGA_BYTES_PER_SECOND | GIGA_BYTES_PER_SECOND| TERA_BYTES_PER_SECOND | BITS_PER_SECOND | KILO_BITS_PER_SECOND |MEGA_BITS_PER_SECOND | GIGA_BITS_PER_SECOND | TERA_BITS_PER_SECOND |COUNT_PER_SECOND

Required: No

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

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3

API Version 2009-03-31156

Page 170: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceCluster

ClusterThe detailed description of the cluster.

ContentsApplications

The applications installed on this cluster.

Type: Array of Application (p. 145) objects

Required: NoAutoScalingRole

An IAM role for automatic scaling policies. The default role is EMR_AutoScaling_DefaultRole.The IAM role provides permissions that the automatic scaling feature requires to launch andterminate EC2 instances in an instance group.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: NoAutoTerminate

Specifies whether the cluster should terminate after completing all steps.

Type: Boolean

Required: NoClusterArn

The Amazon Resource Name of the cluster.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Required: NoConfigurations

Applies only to Amazon EMR releases 4.x and later. The list of Configurations supplied to the EMRcluster.

Type: Array of Configuration (p. 171) objects

Required: NoCustomAmiId

Available only in Amazon EMR version 5.7.0 and later. The ID of a custom Amazon EBS-backed LinuxAMI if the cluster uses a custom AMI.

Type: String

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

API Version 2009-03-31157

Page 171: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceContents

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: No

EbsRootVolumeSize

The size, in GiB, of the Amazon EBS root device volume of the Linux AMI that is used for each EC2instance. Available in Amazon EMR version 4.x and later.

Type: Integer

Required: No

Ec2InstanceAttributes

Provides information about the EC2 instances in a cluster grouped by category. For example, keyname, subnet ID, IAM instance profile, and so on.

Type: Ec2InstanceAttributes (p. 176) object

Required: No

Id

The unique identifier for the cluster.

Type: String

Required: No

InstanceCollectionType

NoteThe instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later,excluding 5.0.x versions.

The instance group configuration of the cluster. A value of INSTANCE_GROUP indicates auniform instance group configuration. A value of INSTANCE_FLEET indicates an instance fleetsconfiguration.

Type: String

Valid Values: INSTANCE_FLEET | INSTANCE_GROUP

Required: No

KerberosAttributes

Attributes for Kerberos configuration when Kerberos authentication is enabled using a securityconfiguration. For more information see Use Kerberos Authentication in the Amazon EMRManagement Guide.

Type: KerberosAttributes (p. 231) object

Required: No

LogEncryptionKmsKeyId

The AWS KMS customer master key (CMK) used for encrypting log files. This attribute is onlyavailable with EMR version 5.30.0 and later, excluding EMR 6.0.0.

Type: String

Required: No

API Version 2009-03-31158

Page 172: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceContents

LogUri

The path to the Amazon S3 location where logs for this cluster are stored.

Type: String

Required: NoMasterPublicDnsName

The DNS name of the master node. If the cluster is on a private subnet, this is the private DNS name.On a public subnet, this is the public DNS name.

Type: String

Required: NoName

The name of the cluster.

Type: String

Required: NoNormalizedInstanceHours

An approximation of the cost of the cluster, represented in m1.small/hours. This value isincremented one time for every hour an m1.small instance runs. Larger instances are weighted more,so an EC2 instance that is roughly four times more expensive would result in the normalized instancehours being incremented by four. This result is only an approximation and does not reflect the actualbilling rate.

Type: Integer

Required: NoOutpostArn

The Amazon Resource Name (ARN) of the Outpost where the cluster is launched.

Type: String

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

Required: NoPlacementGroups

Placement group configured for an Amazon EMR cluster.

Type: Array of PlacementGroupConfig (p. 244) objects

Required: NoReleaseLabel

The Amazon EMR release label, which determines the version of open-source application packagesinstalled on the cluster. Release labels are in the form emr-x.x.x, where x.x.x is an Amazon EMRrelease version such as emr-5.14.0. For more information about Amazon EMR release versionsand included application versions and features, see https://docs.aws.amazon.com/emr/latest/ReleaseGuide/. The release label applies only to Amazon EMR releases version 4.0 and later. Earlierversions use AmiVersion.

Type: String

API Version 2009-03-31159

Page 173: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceContents

Required: NoRepoUpgradeOnBoot

Applies only when CustomAmiID is used. Specifies the type of updates that are applied from theAmazon Linux AMI package repositories when an instance boots using the AMI.

Type: String

Valid Values: SECURITY | NONE

Required: NoRequestedAmiVersion

The AMI version requested for this cluster.

Type: String

Required: NoRunningAmiVersion

The AMI version running on this cluster.

Type: String

Required: NoScaleDownBehavior

The way that individual Amazon EC2 instances terminate when an automatic scale-in activity occursor an instance group is resized. TERMINATE_AT_INSTANCE_HOUR indicates that Amazon EMRterminates nodes at the instance-hour boundary, regardless of when the request to terminatethe instance was submitted. This option is only available with Amazon EMR 5.1.0 and later and isthe default for clusters created using that version. TERMINATE_AT_TASK_COMPLETION indicatesthat Amazon EMR adds nodes to a deny list and drains tasks from nodes before terminating theAmazon EC2 instances, regardless of the instance-hour boundary. With either behavior, AmazonEMR removes the least active nodes first and blocks instance termination if it could lead to HDFScorruption. TERMINATE_AT_TASK_COMPLETION is available only in Amazon EMR version 4.1.0 andlater, and is the default for versions of Amazon EMR earlier than 5.1.0.

Type: String

Valid Values: TERMINATE_AT_INSTANCE_HOUR | TERMINATE_AT_TASK_COMPLETION

Required: NoSecurityConfiguration

The name of the security configuration applied to the cluster.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: NoServiceRole

The IAM role that will be assumed by the Amazon EMR service to access AWS resources on yourbehalf.

Type: String

API Version 2009-03-31160

Page 174: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceSee Also

Required: NoStatus

The current status details about the cluster.

Type: ClusterStatus (p. 164) object

Required: NoStepConcurrencyLevel

Specifies the number of steps that can be executed concurrently.

Type: Integer

Required: NoTags

A list of tags associated with a cluster.

Type: Array of Tag (p. 279) objects

Required: NoTerminationProtected

Indicates whether Amazon EMR will lock the cluster to prevent the EC2 instances from beingterminated by an API call or user intervention, or in the event of a cluster error.

Type: Boolean

Required: NoVisibleToAllUsers

Indicates whether the cluster is visible to IAM principals in the AWS account associated with thecluster. When true, IAM principals in the AWS account can perform EMR cluster actions on thecluster that their IAM policies allow. When false, only the IAM principal that created the cluster andthe AWS account root user can perform EMR actions, regardless of IAM permissions policies attachedto other IAM principals.

The default value is false if a value is not provided when creating a cluster using the EMR APIRunJobFlow (p. 111) command or the AWS CLI create-cluster command. The default value is truewhen a cluster is created using the AWS Management Console. IAM principals that are allowed toperform actions on the cluster can use the SetVisibleToAllUsers (p. 126) action to change the valueon a running cluster. For more information, see Understanding the EMR Cluster VisibleToAllUsersSetting in the Amazon EMR Management Guide.

Type: Boolean

Required: No

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

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3

API Version 2009-03-31161

Page 175: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceSee Also

API Version 2009-03-31162

Page 176: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceClusterStateChangeReason

ClusterStateChangeReasonThe reason that the cluster changed to its current state.

ContentsCode

The programmatic code for the state change reason.

Type: String

Valid Values: INTERNAL_ERROR | VALIDATION_ERROR | INSTANCE_FAILURE |INSTANCE_FLEET_TIMEOUT | BOOTSTRAP_FAILURE | USER_REQUEST | STEP_FAILURE |ALL_STEPS_COMPLETED

Required: NoMessage

The descriptive message for the state change reason.

Type: String

Required: No

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

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3

API Version 2009-03-31163

Page 177: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceClusterStatus

ClusterStatusThe detailed status of the cluster.

ContentsState

The current state of the cluster.

Type: String

Valid Values: STARTING | BOOTSTRAPPING | RUNNING | WAITING | TERMINATING |TERMINATED | TERMINATED_WITH_ERRORS

Required: NoStateChangeReason

The reason for the cluster status change.

Type: ClusterStateChangeReason (p. 163) object

Required: NoTimeline

A timeline that represents the status of a cluster over the lifetime of the cluster.

Type: ClusterTimeline (p. 167) object

Required: No

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

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3

API Version 2009-03-31164

Page 178: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceClusterSummary

ClusterSummaryThe summary description of the cluster.

ContentsClusterArn

The Amazon Resource Name of the cluster.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Required: No

Id

The unique identifier for the cluster.

Type: String

Required: No

Name

The name of the cluster.

Type: String

Required: No

NormalizedInstanceHours

An approximation of the cost of the cluster, represented in m1.small/hours. This value isincremented one time for every hour an m1.small instance runs. Larger instances are weighted more,so an EC2 instance that is roughly four times more expensive would result in the normalized instancehours being incremented by four. This result is only an approximation and does not reflect the actualbilling rate.

Type: Integer

Required: No

OutpostArn

The Amazon Resource Name (ARN) of the Outpost where the cluster is launched.

Type: String

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

Required: No

Status

The details about the current status of the cluster.

Type: ClusterStatus (p. 164) object

Required: No

API Version 2009-03-31165

Page 179: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceSee Also

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

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3

API Version 2009-03-31166

Page 180: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceClusterTimeline

ClusterTimelineRepresents the timeline of the cluster's lifecycle.

ContentsCreationDateTime

The creation date and time of the cluster.

Type: Timestamp

Required: NoEndDateTime

The date and time when the cluster was terminated.

Type: Timestamp

Required: NoReadyDateTime

The date and time when the cluster was ready to run steps.

Type: Timestamp

Required: No

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

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3

API Version 2009-03-31167

Page 181: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceCommand

CommandAn entity describing an executable that runs on a cluster.

ContentsArgs

Arguments for Amazon EMR to pass to the command for execution.

Type: Array of strings

Required: NoName

The name of the command.

Type: String

Required: NoScriptPath

The Amazon S3 location of the command script.

Type: String

Required: No

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

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3

API Version 2009-03-31168

Page 182: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceComputeLimits

ComputeLimitsThe EC2 unit limits for a managed scaling policy. The managed scaling activity of a cluster can not beabove or below these limits. The limit only applies to the core and task nodes. The master node cannotbe scaled after initial configuration.

ContentsMaximumCapacityUnits

The upper boundary of EC2 units. It is measured through vCPU cores or instances for instance groupsand measured through units for instance fleets. Managed scaling activities are not allowed beyondthis boundary. The limit only applies to the core and task nodes. The master node cannot be scaledafter initial configuration.

Type: Integer

Required: YesMaximumCoreCapacityUnits

The upper boundary of EC2 units for core node type in a cluster. It is measured through vCPU coresor instances for instance groups and measured through units for instance fleets. The core unitsare not allowed to scale beyond this boundary. The parameter is used to split capacity allocationbetween core and task nodes.

Type: Integer

Required: NoMaximumOnDemandCapacityUnits

The upper boundary of On-Demand EC2 units. It is measured through vCPU cores or instances forinstance groups and measured through units for instance fleets. The On-Demand units are notallowed to scale beyond this boundary. The parameter is used to split capacity allocation betweenOn-Demand and Spot Instances.

Type: Integer

Required: NoMinimumCapacityUnits

The lower boundary of EC2 units. It is measured through vCPU cores or instances for instance groupsand measured through units for instance fleets. Managed scaling activities are not allowed beyondthis boundary. The limit only applies to the core and task nodes. The master node cannot be scaledafter initial configuration.

Type: Integer

Required: YesUnitType

The unit type used for specifying a managed scaling policy.

Type: String

Valid Values: InstanceFleetUnits | Instances | VCPU

Required: Yes

API Version 2009-03-31169

Page 183: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceSee Also

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

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3

API Version 2009-03-31170

Page 184: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceConfiguration

ConfigurationNoteAmazon EMR releases 4.x or later.

An optional configuration specification to be used when provisioning cluster instances, which caninclude configurations for applications and software bundled with Amazon EMR. A configurationconsists of a classification, properties, and optional nested configurations. A classification refers to anapplication-specific configuration file. Properties are the settings you want to change in that file. Formore information, see Configuring Applications.

ContentsClassification

The classification within a configuration.

Type: String

Required: NoConfigurations

A list of additional configurations to apply within a configuration object.

Type: Array of Configuration (p. 171) objects

Required: NoProperties

A set of properties specified within a configuration classification.

Type: String to string map

Required: No

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

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3

API Version 2009-03-31171

Page 185: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceEbsBlockDevice

EbsBlockDeviceConfiguration of requested EBS block device associated with the instance group.

ContentsDevice

The device name that is exposed to the instance, such as /dev/sdh.

Type: String

Required: NoVolumeSpecification

EBS volume specifications such as volume type, IOPS, and size (GiB) that will be requested for theEBS volume attached to an EC2 instance in the cluster.

Type: VolumeSpecification (p. 280) object

Required: No

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

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3

API Version 2009-03-31172

Page 186: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceEbsBlockDeviceConfig

EbsBlockDeviceConfigConfiguration of requested EBS block device associated with the instance group with count of volumesthat will be associated to every instance.

ContentsVolumeSpecification

EBS volume specifications such as volume type, IOPS, and size (GiB) that will be requested for theEBS volume attached to an EC2 instance in the cluster.

Type: VolumeSpecification (p. 280) object

Required: YesVolumesPerInstance

Number of EBS volumes with a specific volume configuration that will be associated with everyinstance in the instance group

Type: Integer

Required: No

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

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3

API Version 2009-03-31173

Page 187: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceEbsConfiguration

EbsConfigurationThe Amazon EBS configuration of a cluster instance.

ContentsEbsBlockDeviceConfigs

An array of Amazon EBS volume specifications attached to a cluster instance.

Type: Array of EbsBlockDeviceConfig (p. 173) objects

Required: NoEbsOptimized

Indicates whether an Amazon EBS volume is EBS-optimized.

Type: Boolean

Required: No

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

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3

API Version 2009-03-31174

Page 188: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceEbsVolume

EbsVolumeEBS block device that's attached to an EC2 instance.

ContentsDevice

The device name that is exposed to the instance, such as /dev/sdh.

Type: String

Required: NoVolumeId

The volume identifier of the EBS volume.

Type: String

Required: No

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

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3

API Version 2009-03-31175

Page 189: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceEc2InstanceAttributes

Ec2InstanceAttributesProvides information about the EC2 instances in a cluster grouped by category. For example, key name,subnet ID, IAM instance profile, and so on.

ContentsAdditionalMasterSecurityGroups

A list of additional Amazon EC2 security group IDs for the master node.

Type: Array of strings

Required: NoAdditionalSlaveSecurityGroups

A list of additional Amazon EC2 security group IDs for the core and task nodes.

Type: Array of strings

Required: NoEc2AvailabilityZone

The Availability Zone in which the cluster will run.

Type: String

Required: NoEc2KeyName

The name of the Amazon EC2 key pair to use when connecting with SSH into the master node as auser named "hadoop".

Type: String

Required: NoEc2SubnetId

Set this parameter to the identifier of the Amazon VPC subnet where you want the cluster to launch.If you do not specify this value, and your account supports EC2-Classic, the cluster launches in EC2-Classic.

Type: String

Required: NoEmrManagedMasterSecurityGroup

The identifier of the Amazon EC2 security group for the master node.

Type: String

Required: NoEmrManagedSlaveSecurityGroup

The identifier of the Amazon EC2 security group for the core and task nodes.

Type: String

API Version 2009-03-31176

Page 190: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceSee Also

Required: NoIamInstanceProfile

The IAM role that was specified when the cluster was launched. The EC2 instances of the clusterassume this role.

Type: String

Required: NoRequestedEc2AvailabilityZones

Applies to clusters configured with the instance fleets option. Specifies one or more AvailabilityZones in which to launch EC2 cluster instances when the EC2-Classic network configuration issupported. Amazon EMR chooses the Availability Zone with the best fit from among the listof RequestedEc2AvailabilityZones, and then launches all cluster instances within thatAvailability Zone. If you do not specify this value, Amazon EMR chooses the Availability Zone for you.RequestedEc2SubnetIDs and RequestedEc2AvailabilityZones cannot be specified together.

Type: Array of strings

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: NoRequestedEc2SubnetIds

Applies to clusters configured with the instance fleets option. Specifies the unique identifier ofone or more Amazon EC2 subnets in which to launch EC2 cluster instances. Subnets must existwithin the same VPC. Amazon EMR chooses the EC2 subnet with the best fit from among the list ofRequestedEc2SubnetIds, and then launches all cluster instances within that Subnet. If this valueis not specified, and the account and Region support EC2-Classic networks, the cluster launchesinstances in the EC2-Classic network and uses RequestedEc2AvailabilityZones instead of thissetting. If EC2-Classic is not supported, and no Subnet is specified, Amazon EMR chooses the subnetfor you. RequestedEc2SubnetIDs and RequestedEc2AvailabilityZones cannot be specifiedtogether.

Type: Array of strings

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: NoServiceAccessSecurityGroup

The identifier of the Amazon EC2 security group for the Amazon EMR service to access clusters inVPC private subnets.

Type: String

Required: No

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

• AWS SDK for C++

API Version 2009-03-31177

Page 192: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceExecutionEngineConfig

ExecutionEngineConfigSpecifies the execution engine (cluster) to run the notebook and perform the notebook execution, forexample, an EMR cluster.

ContentsId

The unique identifier of the execution engine. For an EMR cluster, this is the cluster ID.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: YesMasterInstanceSecurityGroupId

An optional unique ID of an EC2 security group to associate with the master instance of the EMRcluster for this notebook execution. For more information see Specifying EC2 Security Groups forEMR Notebooks in the EMR Management Guide.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: NoType

The type of execution engine. A value of EMR specifies an EMR cluster.

Type: String

Valid Values: EMR

Required: No

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

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3

API Version 2009-03-31179

Page 193: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceFailureDetails

FailureDetailsThe details of the step failure. The service attempts to detect the root cause for many common failures.

ContentsLogFile

The path to the log file where the step failure root cause was originally recorded.

Type: String

Required: NoMessage

The descriptive message including the error the Amazon EMR service has identified as the cause ofstep failure. This is text from an error log that describes the root cause of the failure.

Type: String

Required: NoReason

The reason for the step failure. In the case where the service cannot successfully determine the rootcause of the failure, it returns "Unknown Error" as a reason.

Type: String

Required: No

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

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3

API Version 2009-03-31180

Page 194: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceHadoopJarStepConfig

HadoopJarStepConfigA job flow step consisting of a JAR file whose main function will be executed. The main function submitsa job for Hadoop to execute and waits for the job to finish or fail.

ContentsArgs

A list of command line arguments passed to the JAR file's main function when executed.

Type: Array of strings

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: NoJar

A path to a JAR file run during the step.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: YesMainClass

The name of the main class in the specified Java file. If not specified, the JAR file should specify aMain-Class in its manifest file.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: NoProperties

A list of Java properties that are set when the step runs. You can use these properties to pass key-value pairs to your main function.

Type: Array of KeyValue (p. 233) objects

Required: No

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

• AWS SDK for C++• AWS SDK for Go

API Version 2009-03-31181

Page 195: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceSee Also

• AWS SDK for Java V2• AWS SDK for Ruby V3

API Version 2009-03-31182

Page 196: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceHadoopStepConfig

HadoopStepConfigA cluster step consisting of a JAR file whose main function will be executed. The main function submits ajob for Hadoop to execute and waits for the job to finish or fail.

ContentsArgs

The list of command line arguments to pass to the JAR file's main function for execution.

Type: Array of strings

Required: NoJar

The path to the JAR file that runs during the step.

Type: String

Required: NoMainClass

The name of the main class in the specified Java file. If not specified, the JAR file should specify amain class in its manifest file.

Type: String

Required: NoProperties

The list of Java properties that are set when the step runs. You can use these properties to pass key-value pairs to your main function.

Type: String to string map

Required: No

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

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3

API Version 2009-03-31183

Page 197: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceInstance

InstanceRepresents an EC2 instance provisioned as part of cluster.

ContentsEbsVolumes

The list of EBS volumes that are attached to this instance.

Type: Array of EbsVolume (p. 175) objects

Required: NoEc2InstanceId

The unique identifier of the instance in Amazon EC2.

Type: String

Required: NoId

The unique identifier for the instance in Amazon EMR.

Type: String

Required: NoInstanceFleetId

The unique identifier of the instance fleet to which an EC2 instance belongs.

Type: String

Required: NoInstanceGroupId

The identifier of the instance group to which this instance belongs.

Type: String

Required: NoInstanceType

The EC2 instance type, for example m3.xlarge.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: NoMarket

The instance purchasing option. Valid values are ON_DEMAND or SPOT.

Type: String

API Version 2009-03-31184

Page 198: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceSee Also

Valid Values: ON_DEMAND | SPOT

Required: NoPrivateDnsName

The private DNS name of the instance.

Type: String

Required: NoPrivateIpAddress

The private IP address of the instance.

Type: String

Required: NoPublicDnsName

The public DNS name of the instance.

Type: String

Required: NoPublicIpAddress

The public IP address of the instance.

Type: String

Required: NoStatus

The current status of the instance.

Type: InstanceStatus (p. 212) object

Required: No

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

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3

API Version 2009-03-31185

Page 199: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceInstanceFleet

InstanceFleetDescribes an instance fleet, which is a group of EC2 instances that host a particular node type (master,core, or task) in an Amazon EMR cluster. Instance fleets can consist of a mix of instance types and On-Demand and Spot Instances, which are provisioned to meet a defined target capacity.

NoteThe instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later,excluding 5.0.x versions.

ContentsId

The unique identifier of the instance fleet.

Type: String

Required: NoInstanceFleetType

The node type that the instance fleet hosts. Valid values are MASTER, CORE, or TASK.

Type: String

Valid Values: MASTER | CORE | TASK

Required: NoInstanceTypeSpecifications

The specification for the instance types that comprise an instance fleet. Up to five unique instancespecifications may be defined for each instance fleet.

Type: Array of InstanceTypeSpecification (p. 216) objects

Required: NoLaunchSpecifications

Describes the launch specification for an instance fleet.

Type: InstanceFleetProvisioningSpecifications (p. 192) object

Required: NoName

A friendly name for the instance fleet.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: NoProvisionedOnDemandCapacity

The number of On-Demand units that have been provisioned for the instance fleet to fulfillTargetOnDemandCapacity. This provisioned capacity might be less than or greater thanTargetOnDemandCapacity.

API Version 2009-03-31186

Page 200: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceContents

Type: Integer

Valid Range: Minimum value of 0.

Required: NoProvisionedSpotCapacity

The number of Spot units that have been provisioned for this instance fleet to fulfillTargetSpotCapacity. This provisioned capacity might be less than or greater thanTargetSpotCapacity.

Type: Integer

Valid Range: Minimum value of 0.

Required: NoStatus

The current status of the instance fleet.

Type: InstanceFleetStatus (p. 194) object

Required: NoTargetOnDemandCapacity

The target capacity of On-Demand units for the instance fleet, which determines how manyOn-Demand Instances to provision. When the instance fleet launches, Amazon EMR tries toprovision On-Demand Instances as specified by InstanceTypeConfig (p. 214). Each instanceconfiguration has a specified WeightedCapacity. When an On-Demand Instance is provisioned,the WeightedCapacity units count toward the target capacity. Amazon EMR provisions instancesuntil the target capacity is totally fulfilled, even if this results in an overage. For example, if thereare 2 units remaining to fulfill capacity, and Amazon EMR can only provision an instance with aWeightedCapacity of 5 units, the instance is provisioned, and the target capacity is exceeded by3 units. You can use InstanceFleet:ProvisionedOnDemandCapacity (p. 186) to determine the Spotcapacity units that have been provisioned for the instance fleet.

NoteIf not specified or set to 0, only Spot Instances are provisioned for the instancefleet using TargetSpotCapacity. At least one of TargetSpotCapacity andTargetOnDemandCapacity should be greater than 0. For a master instance fleet, only oneof TargetSpotCapacity and TargetOnDemandCapacity can be specified, and its valuemust be 1.

Type: Integer

Valid Range: Minimum value of 0.

Required: NoTargetSpotCapacity

The target capacity of Spot units for the instance fleet, which determines how many SpotInstances to provision. When the instance fleet launches, Amazon EMR tries to provision SpotInstances as specified by InstanceTypeConfig (p. 214). Each instance configuration has a specifiedWeightedCapacity. When a Spot instance is provisioned, the WeightedCapacity units counttoward the target capacity. Amazon EMR provisions instances until the target capacity is totallyfulfilled, even if this results in an overage. For example, if there are 2 units remaining to fulfillcapacity, and Amazon EMR can only provision an instance with a WeightedCapacity of 5units, the instance is provisioned, and the target capacity is exceeded by 3 units. You can useInstanceFleet:ProvisionedSpotCapacity (p. 187) to determine the Spot capacity units that havebeen provisioned for the instance fleet.

API Version 2009-03-31187

Page 201: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceSee Also

NoteIf not specified or set to 0, only On-Demand Instances are provisioned for the instancefleet. At least one of TargetSpotCapacity and TargetOnDemandCapacity shouldbe greater than 0. For a master instance fleet, only one of TargetSpotCapacity andTargetOnDemandCapacity can be specified, and its value must be 1.

Type: Integer

Valid Range: Minimum value of 0.

Required: No

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

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3

API Version 2009-03-31188

Page 202: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceInstanceFleetConfig

InstanceFleetConfigThe configuration that defines an instance fleet.

NoteThe instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later,excluding 5.0.x versions.

ContentsInstanceFleetType

The node type that the instance fleet hosts. Valid values are MASTER, CORE, and TASK.

Type: String

Valid Values: MASTER | CORE | TASK

Required: YesInstanceTypeConfigs

The instance type configurations that define the EC2 instances in the instance fleet.

Type: Array of InstanceTypeConfig (p. 214) objects

Required: NoLaunchSpecifications

The launch specification for the instance fleet.

Type: InstanceFleetProvisioningSpecifications (p. 192) object

Required: NoName

The friendly name of the instance fleet.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: NoTargetOnDemandCapacity

The target capacity of On-Demand units for the instance fleet, which determines how manyOn-Demand Instances to provision. When the instance fleet launches, Amazon EMR tries toprovision On-Demand Instances as specified by InstanceTypeConfig (p. 214). Each instanceconfiguration has a specified WeightedCapacity. When an On-Demand Instance is provisioned,the WeightedCapacity units count toward the target capacity. Amazon EMR provisions instancesuntil the target capacity is totally fulfilled, even if this results in an overage. For example, if thereare 2 units remaining to fulfill capacity, and Amazon EMR can only provision an instance with aWeightedCapacity of 5 units, the instance is provisioned, and the target capacity is exceeded by 3units.

NoteIf not specified or set to 0, only Spot Instances are provisioned for the instancefleet using TargetSpotCapacity. At least one of TargetSpotCapacity and

API Version 2009-03-31189

Page 203: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceSee Also

TargetOnDemandCapacity should be greater than 0. For a master instance fleet, only oneof TargetSpotCapacity and TargetOnDemandCapacity can be specified, and its valuemust be 1.

Type: Integer

Valid Range: Minimum value of 0.

Required: NoTargetSpotCapacity

The target capacity of Spot units for the instance fleet, which determines how many SpotInstances to provision. When the instance fleet launches, Amazon EMR tries to provision SpotInstances as specified by InstanceTypeConfig (p. 214). Each instance configuration has a specifiedWeightedCapacity. When a Spot Instance is provisioned, the WeightedCapacity units counttoward the target capacity. Amazon EMR provisions instances until the target capacity is totallyfulfilled, even if this results in an overage. For example, if there are 2 units remaining to fulfillcapacity, and Amazon EMR can only provision an instance with a WeightedCapacity of 5 units, theinstance is provisioned, and the target capacity is exceeded by 3 units.

NoteIf not specified or set to 0, only On-Demand Instances are provisioned for the instancefleet. At least one of TargetSpotCapacity and TargetOnDemandCapacity shouldbe greater than 0. For a master instance fleet, only one of TargetSpotCapacity andTargetOnDemandCapacity can be specified, and its value must be 1.

Type: Integer

Valid Range: Minimum value of 0.

Required: No

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

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3

API Version 2009-03-31190

Page 204: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceInstanceFleetModifyConfig

InstanceFleetModifyConfigConfiguration parameters for an instance fleet modification request.

NoteThe instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later,excluding 5.0.x versions.

ContentsInstanceFleetId

A unique identifier for the instance fleet.

Type: String

Required: YesTargetOnDemandCapacity

The target capacity of On-Demand units for the instance fleet. For more information seeInstanceFleetConfig:TargetOnDemandCapacity (p. 189).

Type: Integer

Valid Range: Minimum value of 0.

Required: NoTargetSpotCapacity

The target capacity of Spot units for the instance fleet. For more information, seeInstanceFleetConfig:TargetSpotCapacity (p. 190).

Type: Integer

Valid Range: Minimum value of 0.

Required: No

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

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3

API Version 2009-03-31191

Page 205: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceInstanceFleetProvisioningSpecifications

InstanceFleetProvisioningSpecificationsThe launch specification for Spot Instances in the fleet, which determines the defined duration,provisioning timeout behavior, and allocation strategy.

NoteThe instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later,excluding 5.0.x versions. On-Demand and Spot Instance allocation strategies are available inAmazon EMR version 5.12.1 and later.

ContentsOnDemandSpecification

The launch specification for On-Demand Instances in the instance fleet, which determines theallocation strategy.

NoteThe instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later,excluding 5.0.x versions. On-Demand Instances allocation strategy is available in AmazonEMR version 5.12.1 and later.

Type: OnDemandProvisioningSpecification (p. 243) object

Required: NoSpotSpecification

The launch specification for Spot Instances in the fleet, which determines the defined duration,provisioning timeout behavior, and allocation strategy.

Type: SpotProvisioningSpecification (p. 260) object

Required: No

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

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3

API Version 2009-03-31192

Page 206: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceInstanceFleetStateChangeReason

InstanceFleetStateChangeReasonProvides status change reason details for the instance fleet.

NoteThe instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later,excluding 5.0.x versions.

ContentsCode

A code corresponding to the reason the state change occurred.

Type: String

Valid Values: INTERNAL_ERROR | VALIDATION_ERROR | INSTANCE_FAILURE |CLUSTER_TERMINATED

Required: NoMessage

An explanatory message.

Type: String

Required: No

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

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3

API Version 2009-03-31193

Page 207: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceInstanceFleetStatus

InstanceFleetStatusThe status of the instance fleet.

NoteThe instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later,excluding 5.0.x versions.

ContentsState

A code representing the instance fleet status.• PROVISIONING—The instance fleet is provisioning EC2 resources and is not yet ready to run jobs.• BOOTSTRAPPING—EC2 instances and other resources have been provisioned and the bootstrap

actions specified for the instances are underway.• RUNNING—EC2 instances and other resources are running. They are either executing jobs or

waiting to execute jobs.• RESIZING—A resize operation is underway. EC2 instances are either being added or removed.• SUSPENDED—A resize operation could not complete. Existing EC2 instances are running, but

instances can't be added or removed.• TERMINATING—The instance fleet is terminating EC2 instances.• TERMINATED—The instance fleet is no longer active, and all EC2 instances have been terminated.

Type: String

Valid Values: PROVISIONING | BOOTSTRAPPING | RUNNING | RESIZING | SUSPENDED |TERMINATING | TERMINATED

Required: NoStateChangeReason

Provides status change reason details for the instance fleet.

Type: InstanceFleetStateChangeReason (p. 193) object

Required: NoTimeline

Provides historical timestamps for the instance fleet, including the time of creation, the time itbecame ready to run jobs, and the time of termination.

Type: InstanceFleetTimeline (p. 196) object

Required: No

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

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2

API Version 2009-03-31194

Page 208: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceSee Also

• AWS SDK for Ruby V3

API Version 2009-03-31195

Page 209: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceInstanceFleetTimeline

InstanceFleetTimelineProvides historical timestamps for the instance fleet, including the time of creation, the time it becameready to run jobs, and the time of termination.

NoteThe instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later,excluding 5.0.x versions.

ContentsCreationDateTime

The time and date the instance fleet was created.

Type: Timestamp

Required: NoEndDateTime

The time and date the instance fleet terminated.

Type: Timestamp

Required: NoReadyDateTime

The time and date the instance fleet was ready to run jobs.

Type: Timestamp

Required: No

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

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3

API Version 2009-03-31196

Page 210: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceInstanceGroup

InstanceGroupThis entity represents an instance group, which is a group of instances that have common purpose. Forexample, CORE instance group is used for HDFS.

ContentsAutoScalingPolicy

An automatic scaling policy for a core instance group or task instance group in an AmazonEMR cluster. The automatic scaling policy defines how an instance group dynamically adds andterminates EC2 instances in response to the value of a CloudWatch metric. See PutAutoScalingPolicy.

Type: AutoScalingPolicyDescription (p. 147) object

Required: NoBidPrice

If specified, indicates that the instance group uses Spot Instances. This is the maximum price youare willing to pay for Spot Instances. Specify OnDemandPrice to set the amount equal to the On-Demand price, or specify an amount in USD.

Type: String

Required: NoConfigurations

NoteAmazon EMR releases 4.x or later.

The list of configurations supplied for an EMR cluster instance group. You can specify a separateconfiguration for each instance group (master, core, and task).

Type: Array of Configuration (p. 171) objects

Required: NoConfigurationsVersion

The version number of the requested configuration specification for this instance group.

Type: Long

Required: NoEbsBlockDevices

The EBS block devices that are mapped to this instance group.

Type: Array of EbsBlockDevice (p. 172) objects

Required: NoEbsOptimized

If the instance group is EBS-optimized. An Amazon EBS-optimized instance uses an optimizedconfiguration stack and provides additional, dedicated capacity for Amazon EBS I/O.

Type: Boolean

Required: No

API Version 2009-03-31197

Page 211: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceContents

Id

The identifier of the instance group.

Type: String

Required: NoInstanceGroupType

The type of the instance group. Valid values are MASTER, CORE or TASK.

Type: String

Valid Values: MASTER | CORE | TASK

Required: NoInstanceType

The EC2 instance type for all instances in the instance group.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: NoLastSuccessfullyAppliedConfigurations

A list of configurations that were successfully applied for an instance group last time.

Type: Array of Configuration (p. 171) objects

Required: NoLastSuccessfullyAppliedConfigurationsVersion

The version number of a configuration specification that was successfully applied for an instancegroup last time.

Type: Long

Required: NoMarket

The marketplace to provision instances for this group. Valid values are ON_DEMAND or SPOT.

Type: String

Valid Values: ON_DEMAND | SPOT

Required: NoName

The name of the instance group.

Type: String

Required: NoRequestedInstanceCount

The target number of instances for the instance group.

API Version 2009-03-31198

Page 212: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceSee Also

Type: Integer

Required: NoRunningInstanceCount

The number of instances currently running in this instance group.

Type: Integer

Required: NoShrinkPolicy

Policy for customizing shrink operations.

Type: ShrinkPolicy (p. 257) object

Required: NoStatus

The current status of the instance group.

Type: InstanceGroupStatus (p. 208) object

Required: No

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

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3

API Version 2009-03-31199

Page 213: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceInstanceGroupConfig

InstanceGroupConfigConfiguration defining a new instance group.

ContentsAutoScalingPolicy

An automatic scaling policy for a core instance group or task instance group in an AmazonEMR cluster. The automatic scaling policy defines how an instance group dynamicallyadds and terminates EC2 instances in response to the value of a CloudWatch metric. SeePutAutoScalingPolicy (p. 96).

Type: AutoScalingPolicy (p. 146) object

Required: NoBidPrice

If specified, indicates that the instance group uses Spot Instances. This is the maximum price youare willing to pay for Spot Instances. Specify OnDemandPrice to set the amount equal to the On-Demand price, or specify an amount in USD.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: NoConfigurations

NoteAmazon EMR releases 4.x or later.

The list of configurations supplied for an EMR cluster instance group. You can specify a separateconfiguration for each instance group (master, core, and task).

Type: Array of Configuration (p. 171) objects

Required: NoEbsConfiguration

EBS configurations that will be attached to each EC2 instance in the instance group.

Type: EbsConfiguration (p. 174) object

Required: NoInstanceCount

Target number of instances for the instance group.

Type: Integer

Required: YesInstanceRole

The role of the instance group in the cluster.

API Version 2009-03-31200

Page 214: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceSee Also

Type: String

Valid Values: MASTER | CORE | TASK

Required: YesInstanceType

The EC2 instance type for all instances in the instance group.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: YesMarket

Market type of the EC2 instances used to create a cluster node.

Type: String

Valid Values: ON_DEMAND | SPOT

Required: NoName

Friendly name given to the instance group.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: No

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

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3

API Version 2009-03-31201

Page 215: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceInstanceGroupDetail

InstanceGroupDetailDetailed information about an instance group.

ContentsBidPrice

If specified, indicates that the instance group uses Spot Instances. This is the maximum price youare willing to pay for Spot Instances. Specify OnDemandPrice to set the amount equal to the On-Demand price, or specify an amount in USD.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: NoCreationDateTime

The date/time the instance group was created.

Type: Timestamp

Required: YesEndDateTime

The date/time the instance group was terminated.

Type: Timestamp

Required: NoInstanceGroupId

Unique identifier for the instance group.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: NoInstanceRequestCount

Target number of instances to run in the instance group.

Type: Integer

Required: YesInstanceRole

Instance group role in the cluster

Type: String

Valid Values: MASTER | CORE | TASK

API Version 2009-03-31202

Page 216: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceContents

Required: YesInstanceRunningCount

Actual count of running instances.

Type: Integer

Required: YesInstanceType

EC2 instance type.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: YesLastStateChangeReason

Details regarding the state of the instance group.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: NoMarket

Market type of the EC2 instances used to create a cluster node.

Type: String

Valid Values: ON_DEMAND | SPOT

Required: YesName

Friendly name for the instance group.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: NoReadyDateTime

The date/time the instance group was available to the cluster.

Type: Timestamp

Required: NoStartDateTime

The date/time the instance group was started.

API Version 2009-03-31203

Page 217: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceSee Also

Type: Timestamp

Required: NoState

State of instance group. The following values are deprecated: STARTING, TERMINATED, and FAILED.

Type: String

Valid Values: PROVISIONING | BOOTSTRAPPING | RUNNING | RECONFIGURING | RESIZING| SUSPENDED | TERMINATING | TERMINATED | ARRESTED | SHUTTING_DOWN | ENDED

Required: Yes

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

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3

API Version 2009-03-31204

Page 218: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceInstanceGroupModifyConfig

InstanceGroupModifyConfigModify the size or configurations of an instance group.

ContentsConfigurations

A list of new or modified configurations to apply for an instance group.

Type: Array of Configuration (p. 171) objects

Required: NoEC2InstanceIdsToTerminate

The EC2 InstanceIds to terminate. After you terminate the instances, the instance group will notreturn to its original requested size.

Type: Array of strings

Required: NoInstanceCount

Target size for the instance group.

Type: Integer

Required: NoInstanceGroupId

Unique ID of the instance group to modify.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: YesShrinkPolicy

Policy for customizing shrink operations.

Type: ShrinkPolicy (p. 257) object

Required: No

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

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3

API Version 2009-03-31205

Page 219: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceSee Also

API Version 2009-03-31206

Page 220: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceInstanceGroupStateChangeReason

InstanceGroupStateChangeReasonThe status change reason details for the instance group.

ContentsCode

The programmable code for the state change reason.

Type: String

Valid Values: INTERNAL_ERROR | VALIDATION_ERROR | INSTANCE_FAILURE |CLUSTER_TERMINATED

Required: NoMessage

The status change reason description.

Type: String

Required: No

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

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3

API Version 2009-03-31207

Page 221: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceInstanceGroupStatus

InstanceGroupStatusThe details of the instance group status.

ContentsState

The current state of the instance group.

Type: String

Valid Values: PROVISIONING | BOOTSTRAPPING | RUNNING | RECONFIGURING | RESIZING| SUSPENDED | TERMINATING | TERMINATED | ARRESTED | SHUTTING_DOWN | ENDED

Required: NoStateChangeReason

The status change reason details for the instance group.

Type: InstanceGroupStateChangeReason (p. 207) object

Required: NoTimeline

The timeline of the instance group status over time.

Type: InstanceGroupTimeline (p. 209) object

Required: No

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

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3

API Version 2009-03-31208

Page 222: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceInstanceGroupTimeline

InstanceGroupTimelineThe timeline of the instance group lifecycle.

ContentsCreationDateTime

The creation date and time of the instance group.

Type: Timestamp

Required: NoEndDateTime

The date and time when the instance group terminated.

Type: Timestamp

Required: NoReadyDateTime

The date and time when the instance group became ready to perform tasks.

Type: Timestamp

Required: No

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

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3

API Version 2009-03-31209

Page 223: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceInstanceResizePolicy

InstanceResizePolicyCustom policy for requesting termination protection or termination of specific instances when shrinkingan instance group.

ContentsInstancesToProtect

Specific list of instances to be protected when shrinking an instance group.

Type: Array of strings

Required: NoInstancesToTerminate

Specific list of instances to be terminated when shrinking an instance group.

Type: Array of strings

Required: NoInstanceTerminationTimeout

Decommissioning timeout override for the specific list of instances to be terminated.

Type: Integer

Required: No

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

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3

API Version 2009-03-31210

Page 224: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceInstanceStateChangeReason

InstanceStateChangeReasonThe details of the status change reason for the instance.

ContentsCode

The programmable code for the state change reason.

Type: String

Valid Values: INTERNAL_ERROR | VALIDATION_ERROR | INSTANCE_FAILURE |BOOTSTRAP_FAILURE | CLUSTER_TERMINATED

Required: NoMessage

The status change reason description.

Type: String

Required: No

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

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3

API Version 2009-03-31211

Page 225: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceInstanceStatus

InstanceStatusThe instance status details.

ContentsState

The current state of the instance.

Type: String

Valid Values: AWAITING_FULFILLMENT | PROVISIONING | BOOTSTRAPPING | RUNNING |TERMINATED

Required: NoStateChangeReason

The details of the status change reason for the instance.

Type: InstanceStateChangeReason (p. 211) object

Required: NoTimeline

The timeline of the instance status over time.

Type: InstanceTimeline (p. 213) object

Required: No

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

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3

API Version 2009-03-31212

Page 226: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceInstanceTimeline

InstanceTimelineThe timeline of the instance lifecycle.

ContentsCreationDateTime

The creation date and time of the instance.

Type: Timestamp

Required: NoEndDateTime

The date and time when the instance was terminated.

Type: Timestamp

Required: NoReadyDateTime

The date and time when the instance was ready to perform tasks.

Type: Timestamp

Required: No

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

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3

API Version 2009-03-31213

Page 227: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceInstanceTypeConfig

InstanceTypeConfigAn instance type configuration for each instance type in an instance fleet, which determines the EC2instances Amazon EMR attempts to provision to fulfill On-Demand and Spot target capacities. There canbe a maximum of five instance type configurations in a fleet.

NoteThe instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later,excluding 5.0.x versions.

ContentsBidPrice

The bid price for each EC2 Spot Instance type as defined by InstanceType. Expressed inUSD. If neither BidPrice nor BidPriceAsPercentageOfOnDemandPrice is provided,BidPriceAsPercentageOfOnDemandPrice defaults to 100%.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: NoBidPriceAsPercentageOfOnDemandPrice

The bid price, as a percentage of On-Demand price, for each EC2 Spot Instance asdefined by InstanceType. Expressed as a number (for example, 20 specifies 20%).If neither BidPrice nor BidPriceAsPercentageOfOnDemandPrice is provided,BidPriceAsPercentageOfOnDemandPrice defaults to 100%.

Type: Double

Valid Range: Minimum value of 0.0.

Required: NoConfigurations

A configuration classification that applies when provisioning cluster instances, which can includeconfigurations for applications and software that run on the cluster.

Type: Array of Configuration (p. 171) objects

Required: NoEbsConfiguration

The configuration of Amazon Elastic Block Storage (Amazon EBS) attached to each instance asdefined by InstanceType.

Type: EbsConfiguration (p. 174) object

Required: NoInstanceType

An EC2 instance type, such as m3.xlarge.

Type: String

API Version 2009-03-31214

Page 228: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceSee Also

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: YesWeightedCapacity

The number of units that a provisioned instance of this type provides toward fulfilling the targetcapacities defined in InstanceFleetConfig (p. 189). This value is 1 for a master instance fleet, andmust be 1 or greater for core and task instance fleets. Defaults to 1 if not specified.

Type: Integer

Valid Range: Minimum value of 0.

Required: No

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

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3

API Version 2009-03-31215

Page 229: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceInstanceTypeSpecification

InstanceTypeSpecificationThe configuration specification for each instance type in an instance fleet.

NoteThe instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later,excluding 5.0.x versions.

ContentsBidPrice

The bid price for each EC2 Spot Instance type as defined by InstanceType. Expressed in USD.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: NoBidPriceAsPercentageOfOnDemandPrice

The bid price, as a percentage of On-Demand price, for each EC2 Spot Instance as defined byInstanceType. Expressed as a number (for example, 20 specifies 20%).

Type: Double

Valid Range: Minimum value of 0.0.

Required: NoConfigurations

A configuration classification that applies when provisioning cluster instances, which can includeconfigurations for applications and software bundled with Amazon EMR.

Type: Array of Configuration (p. 171) objects

Required: NoEbsBlockDevices

The configuration of Amazon Elastic Block Storage (Amazon EBS) attached to each instance asdefined by InstanceType.

Type: Array of EbsBlockDevice (p. 172) objects

Required: NoEbsOptimized

Evaluates to TRUE when the specified InstanceType is EBS-optimized.

Type: Boolean

Required: NoInstanceType

The EC2 instance type, for example m3.xlarge.

Type: String

API Version 2009-03-31216

Page 230: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceSee Also

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: NoWeightedCapacity

The number of units that a provisioned instance of this type provides toward fulfilling thetarget capacities defined in InstanceFleetConfig (p. 189). Capacity values represent performancecharacteristics such as vCPUs, memory, or I/O. If not specified, the default value is 1.

Type: Integer

Valid Range: Minimum value of 0.

Required: No

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

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3

API Version 2009-03-31217

Page 231: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceJobFlowDetail

JobFlowDetailA description of a cluster (job flow).

ContentsAmiVersion

Applies only to Amazon EMR AMI versions 3.x and 2.x. For Amazon EMR releases 4.0 and later,ReleaseLabel is used. To specify a custom AMI, use CustomAmiID.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: NoAutoScalingRole

An IAM role for automatic scaling policies. The default role is EMR_AutoScaling_DefaultRole.The IAM role provides a way for the automatic scaling feature to get the required permissions itneeds to launch and terminate EC2 instances in an instance group.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: NoBootstrapActions

A list of the bootstrap actions run by the job flow.

Type: Array of BootstrapActionDetail (p. 153) objects

Required: NoExecutionStatusDetail

Describes the execution status of the job flow.

Type: JobFlowExecutionStatusDetail (p. 222) object

Required: YesInstances

Describes the Amazon EC2 instances of the job flow.

Type: JobFlowInstancesDetail (p. 228) object

Required: YesJobFlowId

The job flow identifier.

Type: String

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

API Version 2009-03-31218

Page 232: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceContents

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: YesJobFlowRole

The IAM role that was specified when the job flow was launched. The EC2 instances of the job flowassume this role.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: NoLogEncryptionKmsKeyId

The AWS KMS customer master key (CMK) used for encrypting log files. This attribute is onlyavailable with EMR version 5.30.0 and later, excluding EMR 6.0.0.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: NoLogUri

The location in Amazon S3 where log files for the job are stored.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: NoName

The name of the job flow.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: YesScaleDownBehavior

The way that individual Amazon EC2 instances terminate when an automatic scale-in activity occursor an instance group is resized. TERMINATE_AT_INSTANCE_HOUR indicates that Amazon EMRterminates nodes at the instance-hour boundary, regardless of when the request to terminatethe instance was submitted. This option is only available with Amazon EMR 5.1.0 and later and isthe default for clusters created using that version. TERMINATE_AT_TASK_COMPLETION indicatesthat Amazon EMR adds nodes to a deny list and drains tasks from nodes before terminating theAmazon EC2 instances, regardless of the instance-hour boundary. With either behavior, AmazonEMR removes the least active nodes first and blocks instance termination if it could lead to HDFScorruption. TERMINATE_AT_TASK_COMPLETION available only in Amazon EMR version 4.1.0 andlater, and is the default for versions of Amazon EMR earlier than 5.1.0.

API Version 2009-03-31219

Page 233: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceSee Also

Type: String

Valid Values: TERMINATE_AT_INSTANCE_HOUR | TERMINATE_AT_TASK_COMPLETION

Required: NoServiceRole

The IAM role that is assumed by the Amazon EMR service to access AWS resources on your behalf.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: NoSteps

A list of steps run by the job flow.

Type: Array of StepDetail (p. 266) objects

Required: NoSupportedProducts

A list of strings set by third-party software when the job flow is launched. If you are not using third-party software to manage the job flow, this value is empty.

Type: Array of strings

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: NoVisibleToAllUsers

Indicates whether the cluster is visible to IAM principals in the AWS account associated with thecluster. When true, IAM principals in the AWS account can perform EMR cluster actions that theirIAM policies allow. When false, only the IAM principal that created the cluster and the AWS accountroot user can perform EMR actions, regardless of IAM permissions policies attached to other IAMprincipals.

The default value is false if a value is not provided when creating a cluster using the EMR APIRunJobFlow (p. 111) command or the AWS CLI create-cluster command. The default value is truewhen a cluster is created using the AWS Management Console. IAM principals that are authorized toperform actions on the cluster can use the SetVisibleToAllUsers (p. 126) action to change the valueon a running cluster. For more information, see Understanding the EMR Cluster VisibleToAllUsersSetting in the Amazon EMR Management Guide.

Type: Boolean

Required: No

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

• AWS SDK for C++

API Version 2009-03-31220

Page 235: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceJobFlowExecutionStatusDetail

JobFlowExecutionStatusDetailDescribes the status of the cluster (job flow).

ContentsCreationDateTime

The creation date and time of the job flow.

Type: Timestamp

Required: Yes

EndDateTime

The completion date and time of the job flow.

Type: Timestamp

Required: No

LastStateChangeReason

Description of the job flow last changed state.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: No

ReadyDateTime

The date and time when the job flow was ready to start running bootstrap actions.

Type: Timestamp

Required: No

StartDateTime

The start date and time of the job flow.

Type: Timestamp

Required: No

State

The state of the job flow.

Type: String

Valid Values: STARTING | BOOTSTRAPPING | RUNNING | WAITING | SHUTTING_DOWN |TERMINATED | COMPLETED | FAILED

Required: Yes

API Version 2009-03-31222

Page 236: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceSee Also

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

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3

API Version 2009-03-31223

Page 237: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceJobFlowInstancesConfig

JobFlowInstancesConfigA description of the Amazon EC2 instance on which the cluster (job flow) runs. A validJobFlowInstancesConfig must contain either InstanceGroups or InstanceFleets. They cannot be usedtogether. You may also have MasterInstanceType, SlaveInstanceType, and InstanceCount (all three mustbe present), but we don't recommend this configuration.

ContentsAdditionalMasterSecurityGroups

A list of additional Amazon EC2 security group IDs for the master node.

Type: Array of strings

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: NoAdditionalSlaveSecurityGroups

A list of additional Amazon EC2 security group IDs for the core and task nodes.

Type: Array of strings

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: NoEc2KeyName

The name of the EC2 key pair that can be used to connect to the master node using SSH as the usercalled "hadoop."

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: NoEc2SubnetId

Applies to clusters that use the uniform instance group configuration. To launch the cluster inAmazon Virtual Private Cloud (Amazon VPC), set this parameter to the identifier of the AmazonVPC subnet where you want the cluster to launch. If you do not specify this value and your accountsupports EC2-Classic, the cluster launches in EC2-Classic.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: No

API Version 2009-03-31224

Page 238: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceContents

Ec2SubnetIds

Applies to clusters that use the instance fleet configuration. When multiple EC2 subnet IDs arespecified, Amazon EMR evaluates them and launches instances in the optimal subnet.

NoteThe instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later,excluding 5.0.x versions.

Type: Array of strings

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: NoEmrManagedMasterSecurityGroup

The identifier of the Amazon EC2 security group for the master node. If you specifyEmrManagedMasterSecurityGroup, you must also specify EmrManagedSlaveSecurityGroup.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: NoEmrManagedSlaveSecurityGroup

The identifier of the Amazon EC2 security group for the core and task nodes. If you specifyEmrManagedSlaveSecurityGroup, you must also specify EmrManagedMasterSecurityGroup.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: NoHadoopVersion

Applies only to Amazon EMR release versions earlier than 4.0. The Hadoop version for the cluster.Valid inputs are "0.18" (no longer maintained), "0.20" (no longer maintained), "0.20.205" (no longermaintained), "1.0.3", "2.2.0", or "2.4.0". If you do not set this value, the default of 0.18 is used, unlessthe AmiVersion parameter is set in the RunJobFlow call, in which case the default version ofHadoop for that AMI version is used.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: NoInstanceCount

The number of EC2 instances in the cluster.

Type: Integer

API Version 2009-03-31225

Page 239: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceContents

Required: NoInstanceFleets

NoteThe instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later,excluding 5.0.x versions.

Describes the EC2 instances and instance configurations for clusters that use the instance fleetconfiguration.

Type: Array of InstanceFleetConfig (p. 189) objects

Required: NoInstanceGroups

Configuration for the instance groups in a cluster.

Type: Array of InstanceGroupConfig (p. 200) objects

Required: NoKeepJobFlowAliveWhenNoSteps

Specifies whether the cluster should remain available after completing all steps. Defaults to true.For more information about configuring cluster termination, see Control Cluster Termination in theEMR Management Guide.

Type: Boolean

Required: NoMasterInstanceType

The EC2 instance type of the master node.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: NoPlacement

The Availability Zone in which the cluster runs.

Type: PlacementType (p. 245) object

Required: NoServiceAccessSecurityGroup

The identifier of the Amazon EC2 security group for the Amazon EMR service to access clusters inVPC private subnets.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: No

API Version 2009-03-31226

Page 240: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceSee Also

SlaveInstanceType

The EC2 instance type of the core and task nodes.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: NoTerminationProtected

Specifies whether to lock the cluster to prevent the Amazon EC2 instances from being terminated byAPI call, user intervention, or in the event of a job-flow error.

Type: Boolean

Required: No

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

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3

API Version 2009-03-31227

Page 241: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceJobFlowInstancesDetail

JobFlowInstancesDetailSpecify the type of Amazon EC2 instances that the cluster (job flow) runs on.

ContentsEc2KeyName

The name of an Amazon EC2 key pair that can be used to connect to the master node using SSH.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: NoEc2SubnetId

For clusters launched within Amazon Virtual Private Cloud, this is the identifier of the subnet wherethe cluster was launched.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: NoHadoopVersion

The Hadoop version for the cluster.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: NoInstanceCount

The number of Amazon EC2 instances in the cluster. If the value is 1, the same instance serves asboth the master and core and task node. If the value is greater than 1, one instance is the masternode and all others are core and task nodes.

Type: Integer

Required: YesInstanceGroups

Details about the instance groups in a cluster.

Type: Array of InstanceGroupDetail (p. 202) objects

Required: NoKeepJobFlowAliveWhenNoSteps

Specifies whether the cluster should remain available after completing all steps.

API Version 2009-03-31228

Page 242: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceContents

Type: Boolean

Required: NoMasterInstanceId

The Amazon EC2 instance identifier of the master node.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: NoMasterInstanceType

The Amazon EC2 master node instance type.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: YesMasterPublicDnsName

The DNS name of the master node. If the cluster is on a private subnet, this is the private DNS name.On a public subnet, this is the public DNS name.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: NoNormalizedInstanceHours

An approximation of the cost of the cluster, represented in m1.small/hours. This value is increasedone time for every hour that an m1.small instance runs. Larger instances are weighted more heavily,so an Amazon EC2 instance that is roughly four times more expensive would result in the normalizedinstance hours being increased incrementally four times. This result is only an approximation anddoes not reflect the actual billing rate.

Type: Integer

Required: NoPlacement

The Amazon EC2 Availability Zone for the cluster.

Type: PlacementType (p. 245) object

Required: NoSlaveInstanceType

The Amazon EC2 core and task node instance type.

Type: String

API Version 2009-03-31229

Page 243: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceSee Also

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: YesTerminationProtected

Specifies whether the Amazon EC2 instances in the cluster are protected from termination by APIcalls, user intervention, or in the event of a job-flow error.

Type: Boolean

Required: No

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

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3

API Version 2009-03-31230

Page 244: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceKerberosAttributes

KerberosAttributesAttributes for Kerberos configuration when Kerberos authentication is enabled using a securityconfiguration. For more information see Use Kerberos Authentication in the Amazon EMR ManagementGuide.

ContentsADDomainJoinPassword

The Active Directory password for ADDomainJoinUser.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: NoADDomainJoinUser

Required only when establishing a cross-realm trust with an Active Directory domain. A user withsufficient privileges to join resources to the domain.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: NoCrossRealmTrustPrincipalPassword

Required only when establishing a cross-realm trust with a KDC in a different realm. The cross-realmprincipal password, which must be identical across realms.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: NoKdcAdminPassword

The password used within the cluster for the kadmin service on the cluster-dedicated KDC, whichmaintains Kerberos principals, password policies, and keytabs for the cluster.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: YesRealm

The name of the Kerberos realm to which all nodes in a cluster belong. For example,EC2.INTERNAL.

API Version 2009-03-31231

Page 245: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceSee Also

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: Yes

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

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3

API Version 2009-03-31232

Page 246: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceKeyValue

KeyValueA key-value pair.

ContentsKey

The unique identifier of a key-value pair.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: NoValue

The value part of the identified key.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: No

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

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3

API Version 2009-03-31233

Page 247: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceManagedScalingPolicy

ManagedScalingPolicyManaged scaling policy for an Amazon EMR cluster. The policy specifies the limits for resources that canbe added or terminated from a cluster. The policy only applies to the core and task nodes. The masternode cannot be scaled after initial configuration.

ContentsComputeLimits

The EC2 unit limits for a managed scaling policy. The managed scaling activity of a cluster is notallowed to go above or below these limits. The limit only applies to the core and task nodes. Themaster node cannot be scaled after initial configuration.

Type: ComputeLimits (p. 169) object

Required: No

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

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3

API Version 2009-03-31234

Page 248: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceMetricDimension

MetricDimensionA CloudWatch dimension, which is specified using a Key (known as a Name in CloudWatch), Valuepair. By default, Amazon EMR uses one dimension whose Key is JobFlowID and Value is a variablerepresenting the cluster ID, which is ${emr.clusterId}. This enables the rule to bootstrap when thecluster ID becomes available.

ContentsKey

The dimension name.

Type: String

Required: NoValue

The dimension value.

Type: String

Required: No

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

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3

API Version 2009-03-31235

Page 249: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceNotebookExecution

NotebookExecutionA notebook execution. An execution is a specific instance that an EMR Notebook is run using theStartNotebookExecution action.

ContentsArn

The Amazon Resource Name (ARN) of the notebook execution.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: NoEditorId

The unique identifier of the EMR Notebook that is used for the notebook execution.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: NoEndTime

The timestamp when notebook execution ended.

Type: Timestamp

Required: NoExecutionEngine

The execution engine, such as an EMR cluster, used to run the EMR notebook and perform thenotebook execution.

Type: ExecutionEngineConfig (p. 179) object

Required: NoLastStateChangeReason

The reason for the latest status change of the notebook execution.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: NoNotebookExecutionId

The unique identifier of a notebook execution.

API Version 2009-03-31236

Page 250: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceContents

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: NoNotebookExecutionName

A name for the notebook execution.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: NoNotebookInstanceSecurityGroupId

The unique identifier of the EC2 security group associated with the EMR Notebook instance. Formore information see Specifying EC2 Security Groups for EMR Notebooks in the EMR ManagementGuide.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: NoNotebookParams

Input parameters in JSON format passed to the EMR Notebook at runtime for execution.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: NoOutputNotebookURI

The location of the notebook execution's output file in Amazon S3.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: NoStartTime

The timestamp when notebook execution started.

Type: Timestamp

Required: No

API Version 2009-03-31237

Page 251: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceSee Also

Status

The status of the notebook execution.• START_PENDING indicates that the cluster has received the execution request but execution has

not begun.• STARTING indicates that the execution is starting on the cluster.• RUNNING indicates that the execution is being processed by the cluster.• FINISHING indicates that execution processing is in the final stages.• FINISHED indicates that the execution has completed without error.• FAILING indicates that the execution is failing and will not finish successfully.• FAILED indicates that the execution failed.• STOP_PENDING indicates that the cluster has received a StopNotebookExecution request and

the stop is pending.• STOPPING indicates that the cluster is in the process of stopping the execution as a result of aStopNotebookExecution request.

• STOPPED indicates that the execution stopped because of a StopNotebookExecution request.

Type: String

Valid Values: START_PENDING | STARTING | RUNNING | FINISHING | FINISHED |FAILING | FAILED | STOP_PENDING | STOPPING | STOPPED

Required: NoTags

A list of tags associated with a notebook execution. Tags are user-defined key-value pairs thatconsist of a required key string with a maximum of 128 characters and an optional value string witha maximum of 256 characters.

Type: Array of Tag (p. 279) objects

Required: No

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

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3

API Version 2009-03-31238

Page 252: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceNotebookExecutionSummary

NotebookExecutionSummary

ContentsEditorId

The unique identifier of the editor associated with the notebook execution.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: NoEndTime

The timestamp when notebook execution started.

Type: Timestamp

Required: NoNotebookExecutionId

The unique identifier of the notebook execution.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: NoNotebookExecutionName

The name of the notebook execution.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: NoStartTime

The timestamp when notebook execution started.

Type: Timestamp

Required: NoStatus

The status of the notebook execution.• START_PENDING indicates that the cluster has received the execution request but execution has

not begun.• STARTING indicates that the execution is starting on the cluster.

API Version 2009-03-31239

Page 253: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceSee Also

• RUNNING indicates that the execution is being processed by the cluster.• FINISHING indicates that execution processing is in the final stages.• FINISHED indicates that the execution has completed without error.• FAILING indicates that the execution is failing and will not finish successfully.• FAILED indicates that the execution failed.• STOP_PENDING indicates that the cluster has received a StopNotebookExecution request and

the stop is pending.• STOPPING indicates that the cluster is in the process of stopping the execution as a result of aStopNotebookExecution request.

• STOPPED indicates that the execution stopped because of a StopNotebookExecution request.

Type: String

Valid Values: START_PENDING | STARTING | RUNNING | FINISHING | FINISHED |FAILING | FAILED | STOP_PENDING | STOPPING | STOPPED

Required: No

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

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3

API Version 2009-03-31240

Page 254: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceOnDemandCapacityReservationOptions

OnDemandCapacityReservationOptionsDescribes the strategy for using unused Capacity Reservations for fulfilling On-Demand capacity.

ContentsCapacityReservationPreference

Indicates the instance's Capacity Reservation preferences. Possible preferences include:• open - The instance can run in any open Capacity Reservation that has matching attributes

(instance type, platform, Availability Zone).• none - The instance avoids running in a Capacity Reservation even if one is available. The instance

runs as an On-Demand Instance.

Type: String

Valid Values: open | none

Required: NoCapacityReservationResourceGroupArn

The ARN of the Capacity Reservation resource group in which to run the instance.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: NoUsageStrategy

Indicates whether to use unused Capacity Reservations for fulfilling On-Demand capacity.

If you specify use-capacity-reservations-first, the fleet uses unused Capacity Reservationsto fulfill On-Demand capacity up to the target On-Demand capacity. If multiple instance pools haveunused Capacity Reservations, the On-Demand allocation strategy (lowest-price) is applied. If thenumber of unused Capacity Reservations is less than the On-Demand target capacity, the remainingOn-Demand target capacity is launched according to the On-Demand allocation strategy (lowest-price).

If you do not specify a value, the fleet fulfills the On-Demand capacity according to the chosen On-Demand allocation strategy.

Type: String

Valid Values: use-capacity-reservations-first

Required: No

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

• AWS SDK for C++• AWS SDK for Go

API Version 2009-03-31241

Page 256: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceOnDemandProvisioningSpecification

OnDemandProvisioningSpecificationThe launch specification for On-Demand Instances in the instance fleet, which determines the allocationstrategy.

NoteThe instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later,excluding 5.0.x versions. On-Demand Instances allocation strategy is available in Amazon EMRversion 5.12.1 and later.

ContentsAllocationStrategy

Specifies the strategy to use in launching On-Demand instance fleets. Currently, the only option islowest-price (the default), which launches the lowest price first.

Type: String

Valid Values: lowest-price

Required: YesCapacityReservationOptions

The launch specification for On-Demand instances in the instance fleet, which determines theallocation strategy.

Type: OnDemandCapacityReservationOptions (p. 241) object

Required: No

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

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3

API Version 2009-03-31243

Page 257: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferencePlacementGroupConfig

PlacementGroupConfigPlacement group configuration for an Amazon EMR cluster. The configuration specifies the placementstrategy that can be applied to instance roles during cluster creation.

To use this configuration, consider attaching managed policyAmazonElasticMapReducePlacementGroupPolicy to the EMR role.

ContentsInstanceRole

Role of the instance in the cluster.

Starting with Amazon EMR version 5.23.0, the only supported instance role is MASTER.

Type: String

Valid Values: MASTER | CORE | TASK

Required: YesPlacementStrategy

EC2 Placement Group strategy associated with instance role.

Starting with Amazon EMR version 5.23.0, the only supported placement strategy is SPREAD for theMASTER instance role.

Type: String

Valid Values: SPREAD | PARTITION | CLUSTER | NONE

Required: No

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

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3

API Version 2009-03-31244

Page 258: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferencePlacementType

PlacementTypeThe Amazon EC2 Availability Zone configuration of the cluster (job flow).

ContentsAvailabilityZone

The Amazon EC2 Availability Zone for the cluster. AvailabilityZone is used for uniform instancegroups, while AvailabilityZones (plural) is used for instance fleets.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: NoAvailabilityZones

When multiple Availability Zones are specified, Amazon EMR evaluates them and launchesinstances in the optimal Availability Zone. AvailabilityZones is used for instance fleets, whileAvailabilityZone (singular) is used for uniform instance groups.

NoteThe instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later,excluding 5.0.x versions.

Type: Array of strings

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: No

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

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3

API Version 2009-03-31245

Page 259: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferencePortRange

PortRangeA list of port ranges that are permitted to allow inbound traffic from all public IP addresses. To specify asingle port, use the same value for MinRange and MaxRange.

ContentsMaxRange

The smallest port number in a specified range of port numbers.

Type: Integer

Valid Range: Minimum value of -1. Maximum value of 65535.

Required: NoMinRange

The smallest port number in a specified range of port numbers.

Type: Integer

Valid Range: Minimum value of -1. Maximum value of 65535.

Required: Yes

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

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3

API Version 2009-03-31246

Page 260: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceScalingAction

ScalingActionThe type of adjustment the automatic scaling activity makes when triggered, and the periodicity of theadjustment.

ContentsMarket

Not available for instance groups. Instance groups use the market type specified for the group.

Type: String

Valid Values: ON_DEMAND | SPOT

Required: NoSimpleScalingPolicyConfiguration

The type of adjustment the automatic scaling activity makes when triggered, and the periodicity ofthe adjustment.

Type: SimpleScalingPolicyConfiguration (p. 258) object

Required: Yes

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

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3

API Version 2009-03-31247

Page 261: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceScalingConstraints

ScalingConstraintsThe upper and lower EC2 instance limits for an automatic scaling policy. Automatic scaling activitiestriggered by automatic scaling rules will not cause an instance group to grow above or below theselimits.

ContentsMaxCapacity

The upper boundary of EC2 instances in an instance group beyond which scaling activities are notallowed to grow. Scale-out activities will not add instances beyond this boundary.

Type: Integer

Required: YesMinCapacity

The lower boundary of EC2 instances in an instance group below which scaling activities are notallowed to shrink. Scale-in activities will not terminate instances below this boundary.

Type: Integer

Required: Yes

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

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3

API Version 2009-03-31248

Page 262: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceScalingRule

ScalingRuleA scale-in or scale-out rule that defines scaling activity, including the CloudWatch metric alarm thattriggers activity, how EC2 instances are added or removed, and the periodicity of adjustments. Theautomatic scaling policy for an instance group can comprise one or more automatic scaling rules.

ContentsAction

The conditions that trigger an automatic scaling activity.

Type: ScalingAction (p. 247) object

Required: YesDescription

A friendly, more verbose description of the automatic scaling rule.

Type: String

Required: NoName

The name used to identify an automatic scaling rule. Rule names must be unique within a scalingpolicy.

Type: String

Required: YesTrigger

The CloudWatch alarm definition that determines when automatic scaling activity is triggered.

Type: ScalingTrigger (p. 250) object

Required: Yes

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

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3

API Version 2009-03-31249

Page 263: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceScalingTrigger

ScalingTriggerThe conditions that trigger an automatic scaling activity.

ContentsCloudWatchAlarmDefinition

The definition of a CloudWatch metric alarm. When the defined alarm conditions are met along withother trigger parameters, scaling activity begins.

Type: CloudWatchAlarmDefinition (p. 155) object

Required: Yes

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

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3

API Version 2009-03-31250

Page 264: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceScriptBootstrapActionConfig

ScriptBootstrapActionConfigConfiguration of the script to run during a bootstrap action.

ContentsArgs

A list of command line arguments to pass to the bootstrap action script.

Type: Array of strings

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: NoPath

Location in Amazon S3 of the script to run during a bootstrap action.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: Yes

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

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3

API Version 2009-03-31251

Page 265: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceSecurityConfigurationSummary

SecurityConfigurationSummaryThe creation date and time, and name, of a security configuration.

ContentsCreationDateTime

The date and time the security configuration was created.

Type: Timestamp

Required: NoName

The name of the security configuration.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: No

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

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3

API Version 2009-03-31252

Page 266: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceSessionMappingDetail

SessionMappingDetailDetails for an Amazon EMR Studio session mapping including creation time, user or group ID, Studio ID,and so on.

ContentsCreationTime

The time the session mapping was created.

Type: Timestamp

Required: NoIdentityId

The globally unique identifier (GUID) of the user or group.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: NoIdentityName

The name of the user or group. For more information, see UserName and DisplayName in the AWSSSO Identity Store API Reference.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: NoIdentityType

Specifies whether the identity mapped to the Amazon EMR Studio is a user or a group.

Type: String

Valid Values: USER | GROUP

Required: NoLastModifiedTime

The time the session mapping was last modified.

Type: Timestamp

Required: NoSessionPolicyArn

The Amazon Resource Name (ARN) of the session policy associated with the user or group.

Type: String

API Version 2009-03-31253

Page 267: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceSee Also

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: NoStudioId

The ID of the Amazon EMR Studio.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: No

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

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3

API Version 2009-03-31254

Page 268: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceSessionMappingSummary

SessionMappingSummaryDetails for an Amazon EMR Studio session mapping. The details do not include the time the sessionmapping was last modified.

ContentsCreationTime

The time the session mapping was created.

Type: Timestamp

Required: NoIdentityId

The globally unique identifier (GUID) of the user or group from the AWS SSO Identity Store.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: NoIdentityName

The name of the user or group. For more information, see UserName and DisplayName in the AWSSSO Identity Store API Reference.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: NoIdentityType

Specifies whether the identity mapped to the Amazon EMR Studio is a user or a group.

Type: String

Valid Values: USER | GROUP

Required: NoSessionPolicyArn

The Amazon Resource Name (ARN) of the session policy associated with the user or group.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: No

API Version 2009-03-31255

Page 269: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceSee Also

StudioId

The ID of the Amazon EMR Studio.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: No

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

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3

API Version 2009-03-31256

Page 270: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceShrinkPolicy

ShrinkPolicyPolicy for customizing shrink operations. Allows configuration of decommissioning timeout and targetedinstance shrinking.

ContentsDecommissionTimeout

The desired timeout for decommissioning an instance. Overrides the default YARN decommissioningtimeout.

Type: Integer

Required: NoInstanceResizePolicy

Custom policy for requesting termination protection or termination of specific instances whenshrinking an instance group.

Type: InstanceResizePolicy (p. 210) object

Required: No

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

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3

API Version 2009-03-31257

Page 271: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceSimpleScalingPolicyConfiguration

SimpleScalingPolicyConfigurationAn automatic scaling configuration, which describes how the policy adds or removes instances, thecooldown period, and the number of EC2 instances that will be added each time the CloudWatch metricalarm condition is satisfied.

ContentsAdjustmentType

The way in which EC2 instances are added (if ScalingAdjustment is a positive number) orterminated (if ScalingAdjustment is a negative number) each time the scaling activity istriggered. CHANGE_IN_CAPACITY is the default. CHANGE_IN_CAPACITY indicates that the EC2instance count increments or decrements by ScalingAdjustment, which should be expressed asan integer. PERCENT_CHANGE_IN_CAPACITY indicates the instance count increments or decrementsby the percentage specified by ScalingAdjustment, which should be expressed as an integer.For example, 20 indicates an increase in 20% increments of cluster capacity. EXACT_CAPACITYindicates the scaling activity results in an instance group with the number of EC2 instances specifiedby ScalingAdjustment, which should be expressed as a positive integer.

Type: String

Valid Values: CHANGE_IN_CAPACITY | PERCENT_CHANGE_IN_CAPACITY | EXACT_CAPACITY

Required: NoCoolDown

The amount of time, in seconds, after a scaling activity completes before any further trigger-relatedscaling activities can start. The default value is 0.

Type: Integer

Required: NoScalingAdjustment

The amount by which to scale in or scale out, based on the specified AdjustmentType. A positivevalue adds to the instance group's EC2 instance count while a negative number removes instances.If AdjustmentType is set to EXACT_CAPACITY, the number should only be a positive integer.If AdjustmentType is set to PERCENT_CHANGE_IN_CAPACITY, the value should express thepercentage as an integer. For example, -20 indicates a decrease in 20% increments of clustercapacity.

Type: Integer

Required: Yes

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

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3

API Version 2009-03-31258

Page 272: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceSee Also

API Version 2009-03-31259

Page 273: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceSpotProvisioningSpecification

SpotProvisioningSpecificationThe launch specification for Spot Instances in the instance fleet, which determines the defined duration,provisioning timeout behavior, and allocation strategy.

NoteThe instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later,excluding 5.0.x versions. Spot Instance allocation strategy is available in Amazon EMR version5.12.1 and later.

ContentsAllocationStrategy

Specifies the strategy to use in launching Spot Instance fleets. Currently, the only option is capacity-optimized (the default), which launches instances from Spot Instance pools with optimal capacity forthe number of instances that are launching.

Type: String

Valid Values: capacity-optimized

Required: NoBlockDurationMinutes

The defined duration for Spot Instances (also known as Spot blocks) in minutes. When specified, theSpot Instance does not terminate before the defined duration expires, and defined duration pricingfor Spot Instances applies. Valid values are 60, 120, 180, 240, 300, or 360. The duration period startsas soon as a Spot Instance receives its instance ID. At the end of the duration, Amazon EC2 marksthe Spot Instance for termination and provides a Spot Instance termination notice, which gives theinstance a two-minute warning before it terminates.

Type: Integer

Valid Range: Minimum value of 0.

Required: NoTimeoutAction

The action to take when TargetSpotCapacity has not been fulfilled when theTimeoutDurationMinutes has expired; that is, when all Spot Instances could not beprovisioned within the Spot provisioning timeout. Valid values are TERMINATE_CLUSTER andSWITCH_TO_ON_DEMAND. SWITCH_TO_ON_DEMAND specifies that if no Spot Instances are available,On-Demand Instances should be provisioned to fulfill any remaining Spot capacity.

Type: String

Valid Values: SWITCH_TO_ON_DEMAND | TERMINATE_CLUSTER

Required: YesTimeoutDurationMinutes

The spot provisioning timeout period in minutes. If Spot Instances are not provisioned within thistime period, the TimeOutAction is taken. Minimum value is 5 and maximum value is 1440. Thetimeout applies only during initial provisioning, when the cluster is first created.

Type: Integer

API Version 2009-03-31260

Page 274: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceSee Also

Valid Range: Minimum value of 0.

Required: Yes

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

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3

API Version 2009-03-31261

Page 275: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceStep

StepThis represents a step in a cluster.

ContentsActionOnFailure

The action to take when the cluster step fails. Possible values are TERMINATE_CLUSTER,CANCEL_AND_WAIT, and CONTINUE. TERMINATE_JOB_FLOW is provided for backward compatibility.We recommend using TERMINATE_CLUSTER instead.

If a cluster's StepConcurrencyLevel is greater than 1, do not use AddJobFlowSteps to submita step with this parameter set to CANCEL_AND_WAIT or TERMINATE_CLUSTER. The step is notsubmitted and the action fails with a message that the ActionOnFailure setting is not valid.

If you change a cluster's StepConcurrencyLevel to be greater than 1 while a step is running, theActionOnFailure parameter may not behave as you expect. In this case, for a step that fails withthis parameter set to CANCEL_AND_WAIT, pending steps and the running step are not canceled; fora step that fails with this parameter set to TERMINATE_CLUSTER, the cluster does not terminate.

Type: String

Valid Values: TERMINATE_JOB_FLOW | TERMINATE_CLUSTER | CANCEL_AND_WAIT |CONTINUE

Required: No

Config

The Hadoop job configuration of the cluster step.

Type: HadoopStepConfig (p. 183) object

Required: No

Id

The identifier of the cluster step.

Type: String

Required: No

Name

The name of the cluster step.

Type: String

Required: No

Status

The current execution status details of the cluster step.

Type: StepStatus (p. 270) object

Required: No

API Version 2009-03-31262

Page 276: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceSee Also

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

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3

API Version 2009-03-31263

Page 277: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceStepConfig

StepConfigSpecification for a cluster (job flow) step.

ContentsActionOnFailure

The action to take when the step fails. Use one of the following values:• TERMINATE_CLUSTER - Shuts down the cluster.• CANCEL_AND_WAIT - Cancels any pending steps and returns the cluster to the WAITING state.• CONTINUE - Continues to the next step in the queue.• TERMINATE_JOB_FLOW - Shuts down the cluster. TERMINATE_JOB_FLOW is provided for

backward compatibility. We recommend using TERMINATE_CLUSTER instead.

If a cluster's StepConcurrencyLevel is greater than 1, do not use AddJobFlowSteps to submita step with this parameter set to CANCEL_AND_WAIT or TERMINATE_CLUSTER. The step is notsubmitted and the action fails with a message that the ActionOnFailure setting is not valid.

If you change a cluster's StepConcurrencyLevel to be greater than 1 while a step is running, theActionOnFailure parameter may not behave as you expect. In this case, for a step that fails withthis parameter set to CANCEL_AND_WAIT, pending steps and the running step are not canceled; fora step that fails with this parameter set to TERMINATE_CLUSTER, the cluster does not terminate.

Type: String

Valid Values: TERMINATE_JOB_FLOW | TERMINATE_CLUSTER | CANCEL_AND_WAIT |CONTINUE

Required: NoHadoopJarStep

The JAR file used for the step.

Type: HadoopJarStepConfig (p. 181) object

Required: YesName

The name of the step.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: Yes

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

• AWS SDK for C++• AWS SDK for Go

API Version 2009-03-31264

Page 278: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceSee Also

• AWS SDK for Java V2• AWS SDK for Ruby V3

API Version 2009-03-31265

Page 279: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceStepDetail

StepDetailCombines the execution state and configuration of a step.

ContentsExecutionStatusDetail

The description of the step status.

Type: StepExecutionStatusDetail (p. 267) object

Required: YesStepConfig

The step configuration.

Type: StepConfig (p. 264) object

Required: Yes

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

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3

API Version 2009-03-31266

Page 280: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceStepExecutionStatusDetail

StepExecutionStatusDetailThe execution state of a step.

ContentsCreationDateTime

The creation date and time of the step.

Type: Timestamp

Required: YesEndDateTime

The completion date and time of the step.

Type: Timestamp

Required: NoLastStateChangeReason

A description of the step's current state.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: NoStartDateTime

The start date and time of the step.

Type: Timestamp

Required: NoState

The state of the step.

Type: String

Valid Values: PENDING | RUNNING | CONTINUE | COMPLETED | CANCELLED | FAILED |INTERRUPTED

Required: Yes

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

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2

API Version 2009-03-31267

Page 281: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceSee Also

• AWS SDK for Ruby V3

API Version 2009-03-31268

Page 282: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceStepStateChangeReason

StepStateChangeReasonThe details of the step state change reason.

ContentsCode

The programmable code for the state change reason. Note: Currently, the service provides no codefor the state change.

Type: String

Valid Values: NONE

Required: NoMessage

The descriptive message for the state change reason.

Type: String

Required: No

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

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3

API Version 2009-03-31269

Page 283: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceStepStatus

StepStatusThe execution status details of the cluster step.

ContentsFailureDetails

The details for the step failure including reason, message, and log file path where the root cause wasidentified.

Type: FailureDetails (p. 180) object

Required: NoState

The execution state of the cluster step.

Type: String

Valid Values: PENDING | CANCEL_PENDING | RUNNING | COMPLETED | CANCELLED |FAILED | INTERRUPTED

Required: NoStateChangeReason

The reason for the step execution status change.

Type: StepStateChangeReason (p. 269) object

Required: NoTimeline

The timeline of the cluster step status over time.

Type: StepTimeline (p. 272) object

Required: No

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

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3

API Version 2009-03-31270

Page 284: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceStepSummary

StepSummaryThe summary of the cluster step.

ContentsActionOnFailure

The action to take when the cluster step fails. Possible values are TERMINATE_CLUSTER,CANCEL_AND_WAIT, and CONTINUE. TERMINATE_JOB_FLOW is available for backward compatibility.

Type: String

Valid Values: TERMINATE_JOB_FLOW | TERMINATE_CLUSTER | CANCEL_AND_WAIT |CONTINUE

Required: NoConfig

The Hadoop job configuration of the cluster step.

Type: HadoopStepConfig (p. 183) object

Required: NoId

The identifier of the cluster step.

Type: String

Required: NoName

The name of the cluster step.

Type: String

Required: NoStatus

The current execution status details of the cluster step.

Type: StepStatus (p. 270) object

Required: No

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

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3

API Version 2009-03-31271

Page 285: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceStepTimeline

StepTimelineThe timeline of the cluster step lifecycle.

ContentsCreationDateTime

The date and time when the cluster step was created.

Type: Timestamp

Required: NoEndDateTime

The date and time when the cluster step execution completed or failed.

Type: Timestamp

Required: NoStartDateTime

The date and time when the cluster step execution started.

Type: Timestamp

Required: No

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

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3

API Version 2009-03-31272

Page 286: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceStudio

StudioDetails for an Amazon EMR Studio including ID, creation time, name, and so on.

ContentsAuthMode

Specifies whether the Amazon EMR Studio authenticates users using single sign-on (SSO) or IAM.

Type: String

Valid Values: SSO | IAM

Required: NoCreationTime

The time the Amazon EMR Studio was created.

Type: Timestamp

Required: NoDefaultS3Location

The Amazon S3 location to back up Amazon EMR Studio Workspaces and notebook files.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: NoDescription

The detailed description of the Amazon EMR Studio.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: NoEngineSecurityGroupId

The ID of the Engine security group associated with the Amazon EMR Studio. The Engine securitygroup allows inbound network traffic from resources in the Workspace security group.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: NoName

The name of the Amazon EMR Studio.

API Version 2009-03-31273

Page 287: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceContents

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: NoServiceRole

The name of the IAM role assumed by the Amazon EMR Studio.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: NoStudioArn

The Amazon Resource Name (ARN) of the Amazon EMR Studio.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: NoStudioId

The ID of the Amazon EMR Studio.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: NoSubnetIds

The list of IDs of the subnets associated with the Amazon EMR Studio.

Type: Array of strings

Required: NoTags

A list of tags associated with the Amazon EMR Studio.

Type: Array of Tag (p. 279) objects

Required: NoUrl

The unique access URL of the Amazon EMR Studio.

Type: String

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

API Version 2009-03-31274

Page 288: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceSee Also

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: NoUserRole

The name of the IAM role assumed by users logged in to the Amazon EMR Studio.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: NoVpcId

The ID of the VPC associated with the Amazon EMR Studio.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: NoWorkspaceSecurityGroupId

The ID of the Workspace security group associated with the Amazon EMR Studio. The Workspacesecurity group allows outbound network traffic to resources in the Engine security group and to theinternet.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: No

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

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3

API Version 2009-03-31275

Page 289: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceStudioSummary

StudioSummaryDetails for an Amazon EMR Studio, including ID, Name, VPC, and Description. The details do not includesubnets, IAM roles, security groups, or tags associated with the Studio.

ContentsCreationTime

The time when the Amazon EMR Studio was created.

Type: Timestamp

Required: NoDescription

The detailed description of the Amazon EMR Studio.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: NoName

The name of the Amazon EMR Studio.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: NoStudioId

The ID of the Amazon EMR Studio.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: NoUrl

The unique access URL of the Amazon EMR Studio.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: No

API Version 2009-03-31276

Page 290: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceSee Also

VpcId

The ID of the Virtual Private Cloud (Amazon VPC) associated with the Amazon EMR Studio.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: No

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

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3

API Version 2009-03-31277

Page 291: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceSupportedProductConfig

SupportedProductConfigThe list of supported product configurations that allow user-supplied arguments. EMR accepts thesearguments and forwards them to the corresponding installation script as bootstrap action arguments.

ContentsArgs

The list of user-supplied arguments.

Type: Array of strings

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: NoName

The name of the product configuration.

Type: String

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

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: No

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

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3

API Version 2009-03-31278

Page 292: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceTag

TagA key-value pair containing user-defined metadata that you can associate with an Amazon EMR resource.Tags make it easier to associate clusters in various ways, such as grouping clusters to track your AmazonEMR resource allocation costs. For more information, see Tag Clusters.

ContentsKey

A user-defined key, which is the minimum required information for a valid tag. For moreinformation, see Tag .

Type: String

Required: NoValue

A user-defined value, which is optional in a tag. For more information, see Tag Clusters.

Type: String

Required: No

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

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3

API Version 2009-03-31279

Page 293: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API ReferenceVolumeSpecification

VolumeSpecificationEBS volume specifications such as volume type, IOPS, and size (GiB) that will be requested for the EBSvolume attached to an EC2 instance in the cluster.

ContentsIops

The number of I/O operations per second (IOPS) that the volume supports.

Type: Integer

Required: NoSizeInGB

The volume size, in gibibytes (GiB). This can be a number from 1 - 1024. If the volume type is EBS-optimized, the minimum value is 10.

Type: Integer

Required: YesVolumeType

The volume type. Volume types supported are gp2, io1, standard.

Type: String

Required: Yes

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

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java V2• AWS SDK for Ruby V3

API Version 2009-03-31280

Page 294: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API Reference

Common ParametersThe following list contains the parameters that all actions use for signing Signature Version 4 requestswith a query string. Any action-specific parameters are listed in the topic for that action. For moreinformation about Signature Version 4, see Signature Version 4 Signing Process in the Amazon WebServices General Reference.

Action

The action to be performed.

Type: string

Required: YesVersion

The API version that the request is written for, expressed in the format YYYY-MM-DD.

Type: string

Required: YesX-Amz-Algorithm

The hash algorithm that you used to create the request signature.

Condition: Specify this parameter when you include authentication information in a query stringinstead of in the HTTP authorization header.

Type: string

Valid Values: AWS4-HMAC-SHA256

Required: ConditionalX-Amz-Credential

The credential scope value, which is a string that includes your access key, the date, the region youare targeting, the service you are requesting, and a termination string ("aws4_request"). The value isexpressed in the following format: access_key/YYYYMMDD/region/service/aws4_request.

For more information, see Task 2: Create a String to Sign for Signature Version 4 in the Amazon WebServices General Reference.

Condition: Specify this parameter when you include authentication information in a query stringinstead of in the HTTP authorization header.

Type: string

Required: ConditionalX-Amz-Date

The date that is used to create the signature. The format must be ISO 8601 basic format(YYYYMMDD'T'HHMMSS'Z'). For example, the following date time is a valid X-Amz-Date value:20120325T120000Z.

Condition: X-Amz-Date is optional for all requests; it can be used to override the date used forsigning requests. If the Date header is specified in the ISO 8601 basic format, X-Amz-Date is

API Version 2009-03-31281

Page 295: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API Reference

not required. When X-Amz-Date is used, it always overrides the value of the Date header. Formore information, see Handling Dates in Signature Version 4 in the Amazon Web Services GeneralReference.

Type: string

Required: ConditionalX-Amz-Security-Token

The temporary security token that was obtained through a call to AWS Security Token Service (AWSSTS). For a list of services that support temporary security credentials from AWS Security TokenService, go to AWS Services That Work with IAM in the IAM User Guide.

Condition: If you're using temporary security credentials from the AWS Security Token Service, youmust include the security token.

Type: string

Required: ConditionalX-Amz-Signature

Specifies the hex-encoded signature that was calculated from the string to sign and the derivedsigning key.

Condition: Specify this parameter when you include authentication information in a query stringinstead of in the HTTP authorization header.

Type: string

Required: ConditionalX-Amz-SignedHeaders

Specifies all the HTTP headers that were included as part of the canonical request. For moreinformation about specifying signed headers, see Task 1: Create a Canonical Request For SignatureVersion 4 in the Amazon Web Services General Reference.

Condition: Specify this parameter when you include authentication information in a query stringinstead of in the HTTP authorization header.

Type: string

Required: Conditional

API Version 2009-03-31282

Page 296: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API Reference

Common ErrorsThis section lists the errors common to the API actions of all AWS services. For errors specific to an APIaction for this service, see the topic for that API action.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 400IncompleteSignature

The request signature does not conform to AWS standards.

HTTP Status Code: 400InternalFailure

The request processing has failed because of an unknown error, exception or failure.

HTTP Status Code: 500InvalidAction

The action or operation requested is invalid. Verify that the action is typed correctly.

HTTP Status Code: 400InvalidClientTokenId

The X.509 certificate or AWS access key ID provided does not exist in our records.

HTTP Status Code: 403InvalidParameterCombination

Parameters that must not be used together were used together.

HTTP Status Code: 400InvalidParameterValue

An invalid or out-of-range value was supplied for the input parameter.

HTTP Status Code: 400InvalidQueryParameter

The AWS query string is malformed or does not adhere to AWS standards.

HTTP Status Code: 400MalformedQueryString

The query string contains a syntax error.

HTTP Status Code: 404MissingAction

The request is missing an action or a required parameter.

HTTP Status Code: 400

API Version 2009-03-31283

Page 297: Amazon Elastic MapReduce...Amazon Elastic MapReduce API Reference AddInstanceFleet AddInstanceFleet Adds an instance fleet to a running cluster. Note The instance fleet configuration

Amazon Elastic MapReduce API Reference

MissingAuthenticationToken

The request must contain either a valid (registered) AWS access key ID or X.509 certificate.

HTTP Status Code: 403MissingParameter

A required parameter for the specified action is not supplied.

HTTP Status Code: 400NotAuthorized

You do not have permission to perform this action.

HTTP Status Code: 400OptInRequired

The AWS access key ID needs a subscription for the service.

HTTP Status Code: 403RequestExpired

The request reached the service more than 15 minutes after the date stamp on the request or morethan 15 minutes after the request expiration date (such as for pre-signed URLs), or the date stampon the request is more than 15 minutes in the future.

HTTP Status Code: 400ServiceUnavailable

The request has failed due to a temporary failure of the server.

HTTP Status Code: 503ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 400ValidationError

The input fails to satisfy the constraints specified by an AWS service.

HTTP Status Code: 400

API Version 2009-03-31284