Amazon Elastic MapReduce
API Reference (API Version 2009-03-31)
Print this pageEmail this pageGo to the ForumsView the PDFShare this page on TwitterShare this page on FacebookBookmark this page on DeliciousSubmit this page to RedditSubmit this page to DiggDid this page help you?  Yes  No   Tell us about it...

DescribeJobFlows

Description

DescribeJobFlows returns a list of job flows that match all of the supplied parameters. The parameters can 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 Elastic MapReduce can return a maximum of 512 job flow descriptions.

Request Parameters

For information about the common parameters that all actions use, see Common Query Parameters.

Name Description Required
CreatedAfter

Return only job flows created after this date and time.

Type: DateTime

No
CreatedBefore

Return only job flows created before this date and time.

Type: DateTime

No
JobFlowIds.member.N

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

Type: String list

No
JobFlowStates.member.N

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

Type: String list

No

Response Elements

The following elements come wrapped in a DescribeJobFlowsResult structure.
NameDescription
JobFlows

A list of job flows matching the parameters supplied.

Type: JobFlowDetail list

Errors

For information about the common errors that all actions use, see Common Errors.

Error Description HTTP Status Code
InternalServerError

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

500

Examples

Sample Request

https://elasticmapreduce.amazonaws.com?Action=DescribeJobFlows
&JobFlowIds.member.1=j-3UN6WX5RRO2AG 
&AuthParams

Sample Response

<DescribeJobFlowsResponse xmlns="http://elasticmapreduce.amazonaws.com/doc/2009-03-31">
   <DescribeJobFlowsResult> 
      <JobFlows> 
         <member>
            <ExecutionStatusDetail> 
               <CreationDateTime> 
                  2009-01-28T21:49:16Z
               </CreationDateTime> 
               <StartDateTime> 
                  2009-01-28T21:49:16Z
               </StartDateTime> 
               <State> 
                  STARTING 
               </State>
            </ExecutionStatusDetail> 
            <Name> 
               MyJobFlowName 
            </Name> 
            <LogUri>
               myawsbucket/subdir/ 
            </LogUri> 
            <Steps> 
               <member>
                  <ExecutionStatusDetail> 
                     <CreationDateTime> 
                        2009-01-28T21:49:16Z
                     </CreationDateTime> 
                     <State> 
                        PENDING 
                     </State>
                  </ExecutionStatusDetail> 
                  <StepConfig> 
                     <HadoopJarStep> 
                        <Jar>
                           MyJarFile 
                        </Jar> 
                        <MainClass> 
                           MyMainClass 
                        </MainClass> 
                        <Args>
                           <member> 
                              arg1 
                           </member> 
                           <member> 
                              arg2 
                           </member> 
                        </Args>
                        <Properties/> 
                     </HadoopJarStep> 
                     <Name> 
                        MyStepName 
                     </Name>
                     <ActionOnFailure> 
                        CONTINUE 
                     </ActionOnFailure> 
                  </StepConfig>
               </member> 
            </Steps> 
            <JobFlowId> 
               j-3UN6WX5RRO2AG 
            </JobFlowId>
            <Instances> 
               <Placement> 
                  <AvailabilityZone> 
                     us-east-1a
                  </AvailabilityZone> 
               </Placement> 
               <SlaveInstanceType> 
                  m1.small
               </SlaveInstanceType> 
               <MasterInstanceType> 
                  m1.small
               </MasterInstanceType> 
               <Ec2KeyName> 
                  myec2keyname 
               </Ec2KeyName>
               <InstanceCount> 
                  4 
               </InstanceCount> 
               <KeepJobFlowAliveWhenNoSteps> 
                  true
               </KeepJobFlowAliveWhenNoSteps> 
               <TerminationProtected> 
                  true
               </TerminationProtected>
            </Instances> 
         </member>
      </JobFlows> 
   </DescribeJobFlowsResult> 
   <ResponseMetadata>
      <RequestId> 
         9cea3229-ed85-11dd-9877-6fad448a8419 
      </RequestId>
   </ResponseMetadata> 
</DescribeJobFlowsResponse>