Returns a list of subnet group descriptions. If a subnet group name is specified, the list contains only the description of that group.
Parameters:
-
subnet_group_name
(Optional[String], default:
None
)
–
The name of the subnet group to return details for.
-
max_results
(Optional[IntegerOptional], default:
None
)
–
The maximum number of records to include in the response. If more records exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
-
next_token
(Optional[String], default:
None
)
–
An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.
Raises:
Source code in docs_src/capo_memorydb/_services/memory_db.py
| def describe_subnet_groups(
self,
*,
config_overrides: Optional[MemoryDBClientConfig] = None,
subnet_group_name: Optional["capo_memorydb.types.string.String"] = None,
max_results: Optional[
"capo_memorydb.types.integer_optional.IntegerOptional"
] = None,
next_token: Optional["capo_memorydb.types.string.String"] = None,
) -> "capo_memorydb.types.describe_subnet_groups_response.DescribeSubnetGroupsResponse":
"""<p>Returns a list of subnet group descriptions. If a subnet group name is specified, the list contains only the description of that group.</p>
Args:
subnet_group_name: <p>The name of the subnet group to return details for.</p>
max_results: <p>The maximum number of records to include in the response. If more records exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.</p>
next_token: <p>An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. </p>
Raises:
capo_memorydb.errors.service_linked_role_not_found_fault.ServiceLinkedRoleNotFoundFault: <p>The required service-linked role was not found.</p>
capo_memorydb.errors.subnet_group_not_found_fault.SubnetGroupNotFoundFault: <p>The specified subnet group does not exist.</p>
capo_memorydb.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_memorydb.types.describe_subnet_groups_request.DescribeSubnetGroupsRequest]",
) -> OperationResponse[
"capo_memorydb.types.describe_subnet_groups_response.DescribeSubnetGroupsResponse"
]:
import capo_memorydb._operations.amazon_memory_db.describe_subnet_groups
output, http_response = (
capo_memorydb._operations.amazon_memory_db.describe_subnet_groups.describe_subnet_groups(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("DescribeSubnetGroups")
)
input_: capo_memorydb.types.describe_subnet_groups_request.DescribeSubnetGroupsRequest = {}
if subnet_group_name is not None:
input_["subnet_group_name"] = subnet_group_name
if max_results is not None:
input_["max_results"] = max_results
if next_token is not None:
input_["next_token"] = next_token
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|