:doc:`Personalize <../../personalize>` / Client / describe_batch_segment_job

**************************
describe_batch_segment_job
**************************



.. py:method:: Personalize.Client.describe_batch_segment_job(**kwargs)

  

  Gets the properties of a batch segment job including name, Amazon Resource Name (ARN), status, input and output configurations, and the ARN of the solution version used to generate segments.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeBatchSegmentJob>`_  


  **Request Syntax**
  ::

    response = client.describe_batch_segment_job(
        batchSegmentJobArn='string'
    )
    
  :type batchSegmentJobArn: string
  :param batchSegmentJobArn: **[REQUIRED]** 

    The ARN of the batch segment job to describe.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'batchSegmentJob': {
              'jobName': 'string',
              'batchSegmentJobArn': 'string',
              'filterArn': 'string',
              'failureReason': 'string',
              'solutionVersionArn': 'string',
              'numResults': 123,
              'jobInput': {
                  's3DataSource': {
                      'path': 'string',
                      'kmsKeyArn': 'string'
                  }
              },
              'jobOutput': {
                  's3DataDestination': {
                      'path': 'string',
                      'kmsKeyArn': 'string'
                  }
              },
              'roleArn': 'string',
              'status': 'string',
              'creationDateTime': datetime(2015, 1, 1),
              'lastUpdatedDateTime': datetime(2015, 1, 1)
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **batchSegmentJob** *(dict) --* 

        Information on the specified batch segment job.

        
        

        - **jobName** *(string) --* 

          The name of the batch segment job.

          
        

        - **batchSegmentJobArn** *(string) --* 

          The Amazon Resource Name (ARN) of the batch segment job.

          
        

        - **filterArn** *(string) --* 

          The ARN of the filter used on the batch segment job.

          
        

        - **failureReason** *(string) --* 

          If the batch segment job failed, the reason for the failure.

          
        

        - **solutionVersionArn** *(string) --* 

          The Amazon Resource Name (ARN) of the solution version used by the batch segment job to generate batch segments.

          
        

        - **numResults** *(integer) --* 

          The number of predicted users generated by the batch segment job for each line of input data. The maximum number of users per segment is 5 million.

          
        

        - **jobInput** *(dict) --* 

          The Amazon S3 path that leads to the input data used to generate the batch segment job.

          
          

          - **s3DataSource** *(dict) --* 

            The configuration details of an Amazon S3 input or output bucket.

            
            

            - **path** *(string) --* 

              The file path of the Amazon S3 bucket.

              
            

            - **kmsKeyArn** *(string) --* 

              The Amazon Resource Name (ARN) of the Key Management Service (KMS) key that Amazon Personalize uses to encrypt or decrypt the input and output files.

              
        
      
        

        - **jobOutput** *(dict) --* 

          The Amazon S3 bucket that contains the output data generated by the batch segment job.

          
          

          - **s3DataDestination** *(dict) --* 

            The configuration details of an Amazon S3 input or output bucket.

            
            

            - **path** *(string) --* 

              The file path of the Amazon S3 bucket.

              
            

            - **kmsKeyArn** *(string) --* 

              The Amazon Resource Name (ARN) of the Key Management Service (KMS) key that Amazon Personalize uses to encrypt or decrypt the input and output files.

              
        
      
        

        - **roleArn** *(string) --* 

          The ARN of the Amazon Identity and Access Management (IAM) role that requested the batch segment job.

          
        

        - **status** *(string) --* 

          The status of the batch segment job. The status is one of the following values:

           

          
          * PENDING
           
          * IN PROGRESS
           
          * ACTIVE
           
          * CREATE FAILED
          

          
        

        - **creationDateTime** *(datetime) --* 

          The time at which the batch segment job was created.

          
        

        - **lastUpdatedDateTime** *(datetime) --* 

          The time at which the batch segment job last updated.

          
    
  
  **Exceptions**
  
  *   :py:class:`Personalize.Client.exceptions.InvalidInputException`

  
  *   :py:class:`Personalize.Client.exceptions.ResourceNotFoundException`

  