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

********************************
describe_cluster_security_groups
********************************



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

  

  Returns information about Amazon Redshift security groups. If the name of a security group is specified, the response will contain only information about only that security group.

   

  For information about managing security groups, go to `Amazon Redshift Cluster Security Groups <https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-security-groups.html>`__ in the *Amazon Redshift Cluster Management Guide*.

   

  If you specify both tag keys and tag values in the same request, Amazon Redshift returns all security groups that match any combination of the specified keys and values. For example, if you have ``owner`` and ``environment`` for tag keys, and ``admin`` and ``test`` for tag values, all security groups that have any combination of those values are returned.

   

  If both tag keys and values are omitted from the request, security groups are returned regardless of whether they have tag keys or values associated with them.

  

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


  **Request Syntax**
  ::

    response = client.describe_cluster_security_groups(
        ClusterSecurityGroupName='string',
        MaxRecords=123,
        Marker='string',
        TagKeys=[
            'string',
        ],
        TagValues=[
            'string',
        ]
    )
    
  :type ClusterSecurityGroupName: string
  :param ClusterSecurityGroupName: 

    The name of a cluster security group for which you are requesting details. You must specify either the **Marker** parameter or a **ClusterSecurityGroupName** parameter, but not both.

     

    Example: ``securitygroup1``

    

  
  :type MaxRecords: integer
  :param MaxRecords: 

    The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified ``MaxRecords`` value, a value is returned in a ``marker`` field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

     

    Default: ``100``

     

    Constraints: minimum 20, maximum 100.

    

  
  :type Marker: string
  :param Marker: 

    An optional parameter that specifies the starting point to return a set of response records. When the results of a  DescribeClusterSecurityGroups request exceed the value specified in ``MaxRecords``, Amazon Web Services returns a value in the ``Marker`` field of the response. You can retrieve the next set of response records by providing the returned marker value in the ``Marker`` parameter and retrying the request.

     

    Constraints: You must specify either the **ClusterSecurityGroupName** parameter or the **Marker** parameter, but not both.

    

  
  :type TagKeys: list
  :param TagKeys: 

    A tag key or keys for which you want to return all matching cluster security groups that are associated with the specified key or keys. For example, suppose that you have security groups that are tagged with keys called ``owner`` and ``environment``. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the security groups that have either or both of these tag keys associated with them.

    

  
    - *(string) --* 

    

  :type TagValues: list
  :param TagValues: 

    A tag value or values for which you want to return all matching cluster security groups that are associated with the specified tag value or values. For example, suppose that you have security groups that are tagged with values called ``admin`` and ``test``. If you specify both of these tag values in the request, Amazon Redshift returns a response with the security groups that have either or both of these tag values associated with them.

    

  
    - *(string) --* 

    

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

    
    ::

      {
          'Marker': 'string',
          'ClusterSecurityGroups': [
              {
                  'ClusterSecurityGroupName': 'string',
                  'Description': 'string',
                  'EC2SecurityGroups': [
                      {
                          'Status': 'string',
                          'EC2SecurityGroupName': 'string',
                          'EC2SecurityGroupOwnerId': 'string',
                          'Tags': [
                              {
                                  'Key': 'string',
                                  'Value': 'string'
                              },
                          ]
                      },
                  ],
                  'IPRanges': [
                      {
                          'Status': 'string',
                          'CIDRIP': 'string',
                          'Tags': [
                              {
                                  'Key': 'string',
                                  'Value': 'string'
                              },
                          ]
                      },
                  ],
                  'Tags': [
                      {
                          'Key': 'string',
                          'Value': 'string'
                      },
                  ]
              },
          ]
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **Marker** *(string) --* 

        A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the ``Marker`` parameter and retrying the command. If the ``Marker`` field is empty, all response records have been retrieved for the request.

        
      

      - **ClusterSecurityGroups** *(list) --* 

        A list of  ClusterSecurityGroup instances.

        
        

        - *(dict) --* 

          Describes a security group.

          
          

          - **ClusterSecurityGroupName** *(string) --* 

            The name of the cluster security group to which the operation was applied.

            
          

          - **Description** *(string) --* 

            A description of the security group.

            
          

          - **EC2SecurityGroups** *(list) --* 

            A list of EC2 security groups that are permitted to access clusters associated with this cluster security group.

            
            

            - *(dict) --* 

              Describes an Amazon EC2 security group.

              
              

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

                The status of the EC2 security group.

                
              

              - **EC2SecurityGroupName** *(string) --* 

                The name of the EC2 Security Group.

                
              

              - **EC2SecurityGroupOwnerId** *(string) --* 

                The Amazon Web Services account ID of the owner of the EC2 security group specified in the ``EC2SecurityGroupName`` field.

                
              

              - **Tags** *(list) --* 

                The list of tags for the EC2 security group.

                
                

                - *(dict) --* 

                  A tag consisting of a name/value pair for a resource.

                  
                  

                  - **Key** *(string) --* 

                    The key, or name, for the resource tag.

                    
                  

                  - **Value** *(string) --* 

                    The value for the resource tag.

                    
              
            
          
        
          

          - **IPRanges** *(list) --* 

            A list of IP ranges (CIDR blocks) that are permitted to access clusters associated with this cluster security group.

            
            

            - *(dict) --* 

              Describes an IP range used in a security group.

              
              

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

                The status of the IP range, for example, "authorized".

                
              

              - **CIDRIP** *(string) --* 

                The IP range in Classless Inter-Domain Routing (CIDR) notation.

                
              

              - **Tags** *(list) --* 

                The list of tags for the IP range.

                
                

                - *(dict) --* 

                  A tag consisting of a name/value pair for a resource.

                  
                  

                  - **Key** *(string) --* 

                    The key, or name, for the resource tag.

                    
                  

                  - **Value** *(string) --* 

                    The value for the resource tag.

                    
              
            
          
        
          

          - **Tags** *(list) --* 

            The list of tags for the cluster security group.

            
            

            - *(dict) --* 

              A tag consisting of a name/value pair for a resource.

              
              

              - **Key** *(string) --* 

                The key, or name, for the resource tag.

                
              

              - **Value** *(string) --* 

                The value for the resource tag.

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

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

  