Skip to content

get_resource_collection

get_resource_collection(
    resource_collection_type: ResourceCollectionType,
    *,
    config_overrides: Optional[DevOpsGuruClientConfig] = None,
    next_token: Optional[UuidNextToken] = None,
) -> GetResourceCollectionResponse

Returns lists Amazon Web Services resources that are of the specified resource collection type. The two types of Amazon Web Services resource collections supported are Amazon Web Services CloudFormation stacks and Amazon Web Services resources that contain the same Amazon Web Services tag. DevOps Guru can be configured to analyze the Amazon Web Services resources that are defined in the stacks or that are tagged using the same tag key. You can specify up to 500 Amazon Web Services CloudFormation stacks.

Parameters:

  • resource_collection_type (ResourceCollectionType) –

    The type of Amazon Web Services resource collections to return. The one valid value is CLOUD_FORMATION for Amazon Web Services CloudFormation stacks.

  • next_token (Optional[UuidNextToken], default: None ) –

    The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

Raises:

  • AccessDeniedException –

    You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access Management in the IAM User Guide.

  • InternalServerException –

    An internal failure in an Amazon service occurred.

  • ResourceNotFoundException –

    A requested resource could not be found

  • ThrottlingException –

    The request was denied due to a request throttling.

  • ValidationException –

    Contains information about data passed in to a field during a request that is not valid.

  • UnknownServiceError –

    The service returned an error code this client does not model.

Source code in docs_src/capo_devops_guru/_services/dev_ops_guru.py
def get_resource_collection(
    self,
    resource_collection_type: "capo_devops_guru.types.resource_collection_type.ResourceCollectionType",
    *,
    config_overrides: Optional[DevOpsGuruClientConfig] = None,
    next_token: Optional[
        "capo_devops_guru.types.uuid_next_token.UuidNextToken"
    ] = None,
) -> "capo_devops_guru.types.get_resource_collection_response.GetResourceCollectionResponse":
    """<p> Returns lists Amazon Web Services resources that are of the specified resource collection type. The two types of Amazon Web Services resource collections supported are Amazon Web Services CloudFormation stacks and Amazon Web Services resources that contain the same Amazon Web Services tag. DevOps Guru can be configured to analyze the Amazon Web Services resources that are defined in the stacks or that are tagged using the same tag <i>key</i>. You can specify up to 500 Amazon Web Services CloudFormation stacks. </p>

    Args:
        resource_collection_type: <p> The type of Amazon Web Services resource collections to return. The one valid value is <code>CLOUD_FORMATION</code> for Amazon Web Services CloudFormation stacks. </p>
        next_token: <p>The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.</p>

    Raises:
        capo_devops_guru.errors.access_denied_exception.AccessDeniedException: <p> You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access.html">Access Management</a> in the <i>IAM User Guide</i>. </p>
        capo_devops_guru.errors.internal_server_exception.InternalServerException: <p>An internal failure in an Amazon service occurred.</p>
        capo_devops_guru.errors.resource_not_found_exception.ResourceNotFoundException: <p>A requested resource could not be found</p>
        capo_devops_guru.errors.throttling_exception.ThrottlingException: <p>The request was denied due to a request throttling.</p>
        capo_devops_guru.errors.validation_exception.ValidationException: <p> Contains information about data passed in to a field during a request that is not valid. </p>
        capo_devops_guru.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_devops_guru.types.get_resource_collection_request.GetResourceCollectionRequest]",
    ) -> OperationResponse[
        "capo_devops_guru.types.get_resource_collection_response.GetResourceCollectionResponse"
    ]:
        import capo_devops_guru._operations.capstone_control_plane_service.get_resource_collection

        output, http_response = (
            capo_devops_guru._operations.capstone_control_plane_service.get_resource_collection.get_resource_collection(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetResourceCollection")
    )
    input_: capo_devops_guru.types.get_resource_collection_request.GetResourceCollectionRequest = {
        "resource_collection_type": resource_collection_type
    }
    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