get_resource_shares ¶

def get_resource_shares(
    self,
    resource_owner: "capo_ram.types.resource_owner.ResourceOwner",
    *,
    config_overrides: Optional[RAMClientConfig] = None,
    resource_share_arns: Optional[
        "capo_ram.types.resource_share_arn_list.ResourceShareArnList"
    ] = None,
    resource_share_status: Optional[
        "capo_ram.types.resource_share_status.ResourceShareStatus"
    ] = None,
    name: Optional["capo_ram.types.string.String"] = None,
    tag_filters: Optional["capo_ram.types.tag_filters.TagFilters"] = None,
    next_token: Optional["capo_ram.types.string.String"] = None,
    max_results: Optional["capo_ram.types.max_results.MaxResults"] = None,
    permission_arn: Optional["capo_ram.types.string.String"] = None,
    permission_version: Optional["capo_ram.types.integer.Integer"] = None,
) -> "capo_ram.types.get_resource_shares_response.GetResourceSharesResponse":
    """<p>Retrieves details about the resource shares that you own or that are shared with you.</p> <note> <p>Always check the <code>NextToken</code> response parameter for a <code>null</code> value when calling a paginated operation. These operations can occasionally return an empty set of results even when there are more results available. The <code>NextToken</code> response parameter value is <code>null</code> <i>only</i> when there are no more results to display.</p> </note>

    Args:
        resource_share_arns: <p>Specifies the <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a> of individual resource shares that you want information about.</p>
        resource_share_status: <p>Specifies that you want to retrieve details of only those resource shares that have this status.</p>
        resource_owner: <p>Specifies that you want to retrieve details of only those resource shares that match the following:</p> <ul> <li> <p> <b> <code>SELF</code> </b> – resource shares that your account shares with other accounts</p> </li> <li> <p> <b> <code>OTHER-ACCOUNTS</code> </b> – resource shares that other accounts share with your account</p> </li> </ul>
        name: <p>Specifies the name of an individual resource share that you want to retrieve details about.</p>
        tag_filters: <p>Specifies that you want to retrieve details of only those resource shares that match the specified tag keys and values.</p>
        next_token: <p>Specifies that you want to receive the next page of results. Valid only if you received a <code>NextToken</code> response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's <code>NextToken</code> response to request the next page of results.</p>
        max_results: <p>Specifies the total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the number you specify, the <code>NextToken</code> response element is returned with a value (not null). Include the specified value as the <code>NextToken</code> request parameter in the next call to the operation to get the next part of the results. Note that the service might return fewer results than the maximum even when there are more results available. You should check <code>NextToken</code> after every operation to ensure that you receive all of the results.</p>
        permission_arn: <p>Specifies that you want to retrieve details of only those resource shares that use the managed permission with this <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Name (ARN)</a>.</p>
        permission_version: <p>Specifies that you want to retrieve details for only those resource shares that use the specified version of the managed permission.</p>

    Raises:
        capo_ram.errors.invalid_next_token_exception.InvalidNextTokenException: <p>The operation failed because the specified value for <code>NextToken</code> isn't valid. You must specify a value you received in the <code>NextToken</code> response of a previous call to this operation.</p>
        capo_ram.errors.invalid_parameter_exception.InvalidParameterException: <p>The operation failed because a parameter you specified isn't valid.</p>
        capo_ram.errors.malformed_arn_exception.MalformedArnException: <p>The operation failed because the specified <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Name (ARN)</a> has a format that isn't valid.</p>
        capo_ram.errors.server_internal_exception.ServerInternalException: <p>The operation failed because the service could not respond to the request due to an internal problem. Try again later.</p>
        capo_ram.errors.service_unavailable_exception.ServiceUnavailableException: <p>The operation failed because the service isn't available. Try again later.</p>
        capo_ram.errors.unknown_resource_exception.UnknownResourceException: <p>The operation failed because a specified resource couldn't be found.</p>
        capo_ram.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_ram.types.get_resource_shares_request.GetResourceSharesRequest]",
    ) -> OperationResponse[
        "capo_ram.types.get_resource_shares_response.GetResourceSharesResponse"
    ]:
        import capo_ram._operations.amazon_resource_sharing.get_resource_shares

        output, http_response = (
            capo_ram._operations.amazon_resource_sharing.get_resource_shares.get_resource_shares(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetResourceShares")
    )
    input_: capo_ram.types.get_resource_shares_request.GetResourceSharesRequest = {
        "resource_owner": resource_owner
    }
    if resource_share_arns is not None:
        input_["resource_share_arns"] = resource_share_arns
    if resource_share_status is not None:
        input_["resource_share_status"] = resource_share_status
    if name is not None:
        input_["name"] = name
    if tag_filters is not None:
        input_["tag_filters"] = tag_filters
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results
    if permission_arn is not None:
        input_["permission_arn"] = permission_arn
    if permission_version is not None:
        input_["permission_version"] = permission_version

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output