Returns a list of datashares where the account identifier being called is a consumer account identifier.
Parameters:
-
consumer_arn
(Optional[String], default:
None
)
–
The Amazon Resource Name (ARN) of the consumer namespace that returns in the list of datashares.
-
status
(Optional[DataShareStatusForConsumer], default:
None
)
–
An identifier giving the status of a datashare in the consumer cluster. If this field is specified, Amazon Redshift returns the list of datashares that have the specified status.
-
max_records
(Optional[IntegerOptional], default:
None
)
–
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.
-
marker
(Optional[String], default:
None
)
–
An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeDataSharesForConsumer 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.
Raises:
Source code in docs_src/capo_redshift/_services/redshift.py
| def describe_data_shares_for_consumer(
self,
*,
config_overrides: Optional[RedshiftClientConfig] = None,
consumer_arn: Optional["capo_redshift.types.string.String"] = None,
status: Optional[
"capo_redshift.types.data_share_status_for_consumer.DataShareStatusForConsumer"
] = None,
max_records: Optional[
"capo_redshift.types.integer_optional.IntegerOptional"
] = None,
marker: Optional["capo_redshift.types.string.String"] = None,
) -> "capo_redshift.types.describe_data_shares_for_consumer_result.DescribeDataSharesForConsumerResult":
"""<p>Returns a list of datashares where the account identifier being called is a consumer account identifier.</p>
Args:
consumer_arn: <p>The Amazon Resource Name (ARN) of the consumer namespace that returns in the list of datashares.</p>
status: <p>An identifier giving the status of a datashare in the consumer cluster. If this field is specified, Amazon Redshift returns the list of datashares that have the specified status.</p>
max_records: <p>The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified <code>MaxRecords</code> value, a value is returned in a <code>marker</code> field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. </p>
marker: <p>An optional parameter that specifies the starting point to return a set of response records. When the results of a <a>DescribeDataSharesForConsumer</a> request exceed the value specified in <code>MaxRecords</code>, Amazon Web Services returns a value in the <code>Marker</code> field of the response. You can retrieve the next set of response records by providing the returned marker value in the <code>Marker</code> parameter and retrying the request. </p>
Raises:
capo_redshift.errors.invalid_namespace_fault.InvalidNamespaceFault: <p>The namespace isn't valid because the namespace doesn't exist. Provide a valid namespace.</p>
capo_redshift.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_redshift.types.describe_data_shares_for_consumer_message.DescribeDataSharesForConsumerMessage]",
) -> OperationResponse[
"capo_redshift.types.describe_data_shares_for_consumer_result.DescribeDataSharesForConsumerResult"
]:
import capo_redshift._operations.redshift_service_version20121201.describe_data_shares_for_consumer
output, http_response = (
capo_redshift._operations.redshift_service_version20121201.describe_data_shares_for_consumer.describe_data_shares_for_consumer(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("DescribeDataSharesForConsumer")
)
input_: capo_redshift.types.describe_data_shares_for_consumer_message.DescribeDataSharesForConsumerMessage = {}
if consumer_arn is not None:
input_["consumer_arn"] = consumer_arn
if status is not None:
input_["status"] = status
if max_records is not None:
input_["max_records"] = max_records
if marker is not None:
input_["marker"] = marker
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|