RDS / Paginator / DescribeDBSecurityGroups

DescribeDBSecurityGroups#

class RDS.Paginator.DescribeDBSecurityGroups#
paginator = client.get_paginator('describe_db_security_groups')
paginate(**kwargs)#

Creates an iterator that will paginate through responses from RDS.Client.describe_db_security_groups().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    DBSecurityGroupName='string',
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:
  • DBSecurityGroupName (string) – The name of the DB security group to return details for.

  • Filters (list) –

    This parameter isn’t currently supported.

    • (dict) –

      A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.

      Note

      Currently, wildcards are not supported in filters.

      The following actions can be filtered:

      • DescribeDBClusterBacktracks

      • DescribeDBClusterEndpoints

      • DescribeDBClusters

      • DescribeDBInstances

      • DescribePendingMaintenanceActions

      • Name (string) – [REQUIRED]

        The name of the filter. Filter names are case-sensitive.

      • Values (list) – [REQUIRED]

        One or more filter values. Filter values are case-sensitive.

        • (string) –

  • PaginationConfig (dict) –

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) –

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) –

      The size of each page.

    • StartingToken (string) –

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'DBSecurityGroups': [
        {
            'OwnerId': 'string',
            'DBSecurityGroupName': 'string',
            'DBSecurityGroupDescription': 'string',
            'VpcId': 'string',
            'EC2SecurityGroups': [
                {
                    'Status': 'string',
                    'EC2SecurityGroupName': 'string',
                    'EC2SecurityGroupId': 'string',
                    'EC2SecurityGroupOwnerId': 'string'
                },
            ],
            'IPRanges': [
                {
                    'Status': 'string',
                    'CIDRIP': 'string'
                },
            ],
            'DBSecurityGroupArn': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    Contains the result of a successful invocation of the DescribeDBSecurityGroups action.

    • DBSecurityGroups (list) –

      A list of DBSecurityGroup instances.

      • (dict) –

        Contains the details for an Amazon RDS DB security group.

        This data type is used as a response element in the DescribeDBSecurityGroups action.

        • OwnerId (string) –

          Provides the Amazon Web Services ID of the owner of a specific DB security group.

        • DBSecurityGroupName (string) –

          Specifies the name of the DB security group.

        • DBSecurityGroupDescription (string) –

          Provides the description of the DB security group.

        • VpcId (string) –

          Provides the VpcId of the DB security group.

        • EC2SecurityGroups (list) –

          Contains a list of EC2SecurityGroup elements.

          • (dict) –

            This data type is used as a response element in the following actions:

            • AuthorizeDBSecurityGroupIngress

            • DescribeDBSecurityGroups

            • RevokeDBSecurityGroupIngress

            • Status (string) –

              Provides the status of the EC2 security group. Status can be “authorizing”, “authorized”, “revoking”, and “revoked”.

            • EC2SecurityGroupName (string) –

              Specifies the name of the EC2 security group.

            • EC2SecurityGroupId (string) –

              Specifies the id of the EC2 security group.

            • EC2SecurityGroupOwnerId (string) –

              Specifies the Amazon Web Services ID of the owner of the EC2 security group specified in the EC2SecurityGroupName field.

        • IPRanges (list) –

          Contains a list of IPRange elements.

          • (dict) –

            This data type is used as a response element in the DescribeDBSecurityGroups action.

            • Status (string) –

              Specifies the status of the IP range. Status can be “authorizing”, “authorized”, “revoking”, and “revoked”.

            • CIDRIP (string) –

              Specifies the IP range.

        • DBSecurityGroupArn (string) –

          The Amazon Resource Name (ARN) for the DB security group.

    • NextToken (string) –

      A token to resume pagination.