:doc:`CodeGuruProfiler <../../codeguruprofiler>` / Client / update_profiling_group

**********************
update_profiling_group
**********************



.. py:method:: CodeGuruProfiler.Client.update_profiling_group(**kwargs)

  

  Updates a profiling group.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/codeguruprofiler-2019-07-18/UpdateProfilingGroup>`_  


  **Request Syntax**
  ::

    response = client.update_profiling_group(
        agentOrchestrationConfig={
            'profilingEnabled': True|False
        },
        profilingGroupName='string'
    )
    
  :type agentOrchestrationConfig: dict
  :param agentOrchestrationConfig: **[REQUIRED]** 

    Specifies whether profiling is enabled or disabled for a profiling group.

    

  
    - **profilingEnabled** *(boolean) --* **[REQUIRED]** 

      A ``Boolean`` that specifies whether the profiling agent collects profiling data or not. Set to ``true`` to enable profiling.

      

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

    The name of the profiling group to update.

    

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

    
    ::

      {
          'profilingGroup': {
              'agentOrchestrationConfig': {
                  'profilingEnabled': True|False
              },
              'arn': 'string',
              'computePlatform': 'Default'|'AWSLambda',
              'createdAt': datetime(2015, 1, 1),
              'name': 'string',
              'profilingStatus': {
                  'latestAgentOrchestratedAt': datetime(2015, 1, 1),
                  'latestAgentProfileReportedAt': datetime(2015, 1, 1),
                  'latestAggregatedProfile': {
                      'period': 'PT5M'|'PT1H'|'P1D',
                      'start': datetime(2015, 1, 1)
                  }
              },
              'tags': {
                  'string': 'string'
              },
              'updatedAt': datetime(2015, 1, 1)
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 

      The structure representing the updateProfilingGroupResponse.

      
      

      - **profilingGroup** *(dict) --* 

        A `ProfilingGroupDescription <https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ProfilingGroupDescription.html>`__ that contains information about the returned updated profiling group.

        
        

        - **agentOrchestrationConfig** *(dict) --* 

          An `AgentOrchestrationConfig <https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_AgentOrchestrationConfig.html>`__ object that indicates if the profiling group is enabled for profiled or not.

          
          

          - **profilingEnabled** *(boolean) --* 

            A ``Boolean`` that specifies whether the profiling agent collects profiling data or not. Set to ``true`` to enable profiling.

            
      
        

        - **arn** *(string) --* 

          The Amazon Resource Name (ARN) identifying the profiling group resource.

          
        

        - **computePlatform** *(string) --* 

          The compute platform of the profiling group. If it is set to ``AWSLambda``, then the profiled application runs on AWS Lambda. If it is set to ``Default``, then the profiled application runs on a compute platform that is not AWS Lambda, such an Amazon EC2 instance, an on-premises server, or a different platform. The default is ``Default``.

          
        

        - **createdAt** *(datetime) --* 

          The time when the profiling group was created. Specify using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.

          
        

        - **name** *(string) --* 

          The name of the profiling group.

          
        

        - **profilingStatus** *(dict) --* 

          A `ProfilingStatus <https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ProfilingStatus.html>`__ object that includes information about the last time a profile agent pinged back, the last time a profile was received, and the aggregation period and start time for the most recent aggregated profile.

          
          

          - **latestAgentOrchestratedAt** *(datetime) --* 

            The date and time when the profiling agent most recently pinged back. Specify using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.

            
          

          - **latestAgentProfileReportedAt** *(datetime) --* 

            The date and time when the most recent profile was received. Specify using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.

            
          

          - **latestAggregatedProfile** *(dict) --* 

            An `AggregatedProfileTime <https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_AggregatedProfileTime.html>`__ object that contains the aggregation period and start time for an aggregated profile.

            
            

            - **period** *(string) --* 

              The aggregation period. This indicates the period during which an aggregation profile collects posted agent profiles for a profiling group. Use one of three valid durations that are specified using the ISO 8601 format.

               

              
              * ``P1D`` — 1 day
               
              * ``PT1H`` — 1 hour
               
              * ``PT5M`` — 5 minutes
              

              
            

            - **start** *(datetime) --* 

              The time that aggregation of posted agent profiles for a profiling group starts. The aggregation profile contains profiles posted by the agent starting at this time for an aggregation period specified by the ``period`` property of the ``AggregatedProfileTime`` object.

               

              Specify ``start`` using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.

              
        
      
        

        - **tags** *(dict) --* 

          A list of the tags that belong to this profiling group.

          
          

          - *(string) --* 
            

            - *(string) --* 
      
    
        

        - **updatedAt** *(datetime) --* 

          The date and time when the profiling group was last updated. Specify using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.

          
    
  
  **Exceptions**
  
  *   :py:class:`CodeGuruProfiler.Client.exceptions.InternalServerException`

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

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

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

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

  