:doc:`Redshift <../../redshift>` / Client / authorize_endpoint_access

*************************
authorize_endpoint_access
*************************



.. py:method:: Redshift.Client.authorize_endpoint_access(**kwargs)

  

  Grants access to a cluster.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/AuthorizeEndpointAccess>`_  


  **Request Syntax**
  ::

    response = client.authorize_endpoint_access(
        ClusterIdentifier='string',
        Account='string',
        VpcIds=[
            'string',
        ]
    )
    
  :type ClusterIdentifier: string
  :param ClusterIdentifier: 

    The cluster identifier of the cluster to grant access to.

    

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

    The Amazon Web Services account ID to grant access to.

    

  
  :type VpcIds: list
  :param VpcIds: 

    The virtual private cloud (VPC) identifiers to grant access to.

    

  
    - *(string) --* 

    

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

    
    ::

      {
          'Grantor': 'string',
          'Grantee': 'string',
          'ClusterIdentifier': 'string',
          'AuthorizeTime': datetime(2015, 1, 1),
          'ClusterStatus': 'string',
          'Status': 'Authorized'|'Revoking',
          'AllowedAllVPCs': True|False,
          'AllowedVPCs': [
              'string',
          ],
          'EndpointCount': 123
      }
      
    **Response Structure**

    

    - *(dict) --* 

      Describes an endpoint authorization for authorizing Redshift-managed VPC endpoint access to a cluster across Amazon Web Services accounts.

      
      

      - **Grantor** *(string) --* 

        The Amazon Web Services account ID of the cluster owner.

        
      

      - **Grantee** *(string) --* 

        The Amazon Web Services account ID of the grantee of the cluster.

        
      

      - **ClusterIdentifier** *(string) --* 

        The cluster identifier.

        
      

      - **AuthorizeTime** *(datetime) --* 

        The time (UTC) when the authorization was created.

        
      

      - **ClusterStatus** *(string) --* 

        The status of the cluster.

        
      

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

        The status of the authorization action.

        
      

      - **AllowedAllVPCs** *(boolean) --* 

        Indicates whether all VPCs in the grantee account are allowed access to the cluster.

        
      

      - **AllowedVPCs** *(list) --* 

        The VPCs allowed access to the cluster.

        
        

        - *(string) --* 
    
      

      - **EndpointCount** *(integer) --* 

        The number of Redshift-managed VPC endpoints created for the authorization.

        
  
  **Exceptions**
  
  *   :py:class:`Redshift.Client.exceptions.ClusterNotFoundFault`

  
  *   :py:class:`Redshift.Client.exceptions.EndpointAuthorizationsPerClusterLimitExceededFault`

  
  *   :py:class:`Redshift.Client.exceptions.UnsupportedOperationFault`

  
  *   :py:class:`Redshift.Client.exceptions.EndpointAuthorizationAlreadyExistsFault`

  
  *   :py:class:`Redshift.Client.exceptions.InvalidAuthorizationStateFault`

  
  *   :py:class:`Redshift.Client.exceptions.InvalidClusterStateFault`

  