:doc:`WellArchitected <../../wellarchitected>` / Client / update_workload_share

*********************
update_workload_share
*********************



.. py:method:: WellArchitected.Client.update_workload_share(**kwargs)

  

  Update a workload share.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/UpdateWorkloadShare>`_  


  **Request Syntax**
  ::

    response = client.update_workload_share(
        ShareId='string',
        WorkloadId='string',
        PermissionType='READONLY'|'CONTRIBUTOR'
    )
    
  :type ShareId: string
  :param ShareId: **[REQUIRED]** 

    The ID associated with the share.

    

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

    The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.

    

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

    Permission granted on a share request.

    

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

    
    ::

      {
          'WorkloadId': 'string',
          'WorkloadShare': {
              'ShareId': 'string',
              'SharedBy': 'string',
              'SharedWith': 'string',
              'PermissionType': 'READONLY'|'CONTRIBUTOR',
              'Status': 'ACCEPTED'|'REJECTED'|'PENDING'|'REVOKED'|'EXPIRED'|'ASSOCIATING'|'ASSOCIATED'|'FAILED',
              'WorkloadName': 'string',
              'WorkloadId': 'string'
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 

      Input for Update Workload Share

      
      

      - **WorkloadId** *(string) --* 

        The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.

        
      

      - **WorkloadShare** *(dict) --* 

        A workload share return object.

        
        

        - **ShareId** *(string) --* 

          The ID associated with the share.

          
        

        - **SharedBy** *(string) --* 

          An Amazon Web Services account ID.

          
        

        - **SharedWith** *(string) --* 

          The Amazon Web Services account ID, organization ID, or organizational unit (OU) ID with which the workload, lens, profile, or review template is shared.

          
        

        - **PermissionType** *(string) --* 

          Permission granted on a share request.

          
        

        - **Status** *(string) --* 

          The status of the share request.

          
        

        - **WorkloadName** *(string) --* 

          The name of the workload.

           

          The name must be unique within an account within an Amazon Web Services Region. Spaces and capitalization are ignored when checking for uniqueness.

          
        

        - **WorkloadId** *(string) --* 

          The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.

          
    
  
  **Exceptions**
  
  *   :py:class:`WellArchitected.Client.exceptions.ValidationException`

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

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

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

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

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

  