:doc:`SageMakergeospatialcapabilities <../../sagemaker-geospatial>` / Client / export_earth_observation_job

****************************
export_earth_observation_job
****************************



.. py:method:: SageMakergeospatialcapabilities.Client.export_earth_observation_job(**kwargs)

  

  Use this operation to export results of an Earth Observation job and optionally source images used as input to the EOJ to an Amazon S3 location.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/sagemaker-geospatial-2020-05-27/ExportEarthObservationJob>`_  


  **Request Syntax**
  ::

    response = client.export_earth_observation_job(
        Arn='string',
        ClientToken='string',
        ExecutionRoleArn='string',
        ExportSourceImages=True|False,
        OutputConfig={
            'S3Data': {
                'KmsKeyId': 'string',
                'S3Uri': 'string'
            }
        }
    )
    
  :type Arn: string
  :param Arn: **[REQUIRED]** 

    The input Amazon Resource Name (ARN) of the Earth Observation job being exported.

    

  
  :type ClientToken: string
  :param ClientToken: 

    A unique token that guarantees that the call to this API is idempotent.

    This field is autopopulated if not provided.

  
  :type ExecutionRoleArn: string
  :param ExecutionRoleArn: **[REQUIRED]** 

    The Amazon Resource Name (ARN) of the IAM role that you specified for the job.

    

  
  :type ExportSourceImages: boolean
  :param ExportSourceImages: 

    The source images provided to the Earth Observation job being exported.

    

  
  :type OutputConfig: dict
  :param OutputConfig: **[REQUIRED]** 

    An object containing information about the output file.

    

  
    - **S3Data** *(dict) --* **[REQUIRED]** 

      Path to Amazon S3 storage location for the output configuration file.

      

    
      - **KmsKeyId** *(string) --* 

        The Key Management Service key ID for server-side encryption.

        

      
      - **S3Uri** *(string) --* **[REQUIRED]** 

        The URL to the Amazon S3 data input.

        

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

    
    ::

      {
          'Arn': 'string',
          'CreationTime': datetime(2015, 1, 1),
          'ExecutionRoleArn': 'string',
          'ExportSourceImages': True|False,
          'ExportStatus': 'IN_PROGRESS'|'SUCCEEDED'|'FAILED',
          'OutputConfig': {
              'S3Data': {
                  'KmsKeyId': 'string',
                  'S3Uri': 'string'
              }
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **Arn** *(string) --* 

        The output Amazon Resource Name (ARN) of the Earth Observation job being exported.

        
      

      - **CreationTime** *(datetime) --* 

        The creation time.

        
      

      - **ExecutionRoleArn** *(string) --* 

        The Amazon Resource Name (ARN) of the IAM role that you specified for the job.

        
      

      - **ExportSourceImages** *(boolean) --* 

        The source images provided to the Earth Observation job being exported.

        
      

      - **ExportStatus** *(string) --* 

        The status of the results of the Earth Observation job being exported.

        
      

      - **OutputConfig** *(dict) --* 

        An object containing information about the output file.

        
        

        - **S3Data** *(dict) --* 

          Path to Amazon S3 storage location for the output configuration file.

          
          

          - **KmsKeyId** *(string) --* 

            The Key Management Service key ID for server-side encryption.

            
          

          - **S3Uri** *(string) --* 

            The URL to the Amazon S3 data input.

            
      
    
  
  **Exceptions**
  
  *   :py:class:`SageMakergeospatialcapabilities.Client.exceptions.ServiceQuotaExceededException`

  
  *   :py:class:`SageMakergeospatialcapabilities.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`SageMakergeospatialcapabilities.Client.exceptions.ValidationException`

  
  *   :py:class:`SageMakergeospatialcapabilities.Client.exceptions.ThrottlingException`

  
  *   :py:class:`SageMakergeospatialcapabilities.Client.exceptions.InternalServerException`

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

  
  *   :py:class:`SageMakergeospatialcapabilities.Client.exceptions.ConflictException`

  