create_resource_snapshot_job ¶

def create_resource_snapshot_job(
    self,
    catalog: "capo_partnercentral_selling.types.catalog_identifier.CatalogIdentifier",
    client_token: "capo_partnercentral_selling.types.client_token.ClientToken",
    engagement_identifier: "capo_partnercentral_selling.types.engagement_identifier.EngagementIdentifier",
    resource_type: "capo_partnercentral_selling.types.resource_type.ResourceType",
    resource_identifier: "capo_partnercentral_selling.types.resource_identifier.ResourceIdentifier",
    resource_snapshot_template_identifier: "capo_partnercentral_selling.types.resource_template_name.ResourceTemplateName",
    *,
    config_overrides: Optional[PartnerCentralSellingClientConfig] = None,
    tags: Optional["capo_partnercentral_selling.types.tag_list.TagList"] = None,
) -> "capo_partnercentral_selling.types.create_resource_snapshot_job_response.CreateResourceSnapshotJobResponse":
    """<p>Use this action to create a job to generate a snapshot of the specified resource within an engagement. It initiates an asynchronous process to create a resource snapshot. The job creates a new snapshot only if the resource state has changed, adhering to the same access control and immutability rules as direct snapshot creation.</p>

    Args:
        catalog: <p>Specifies the catalog in which to create the snapshot job. Valid values are <code>AWS</code> and <code> Sandbox</code>.</p>
        client_token: <p>A client-generated UUID used for idempotency check. The token helps prevent duplicate job creations.</p>
        engagement_identifier: <p>Specifies the identifier of the engagement associated with the resource to be snapshotted.</p>
        resource_type: <p>The type of resource for which the snapshot job is being created. Must be one of the supported resource types i.e. <code>Opportunity</code> </p>
        resource_identifier: <p>Specifies the identifier of the specific resource to be snapshotted. The format depends on the <code> ResourceType</code>.</p>
        resource_snapshot_template_identifier: <p>Specifies the name of the template that defines the schema for the snapshot.</p>
        tags: <p>A map of the key-value pairs of the tag or tags to assign.</p>

    Raises:
        capo_partnercentral_selling.errors.access_denied_exception.AccessDeniedException: <p>This error occurs when you don't have permission to perform the requested action.</p> <p>You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.</p>
        capo_partnercentral_selling.errors.conflict_exception.ConflictException: <p>This error occurs when the request can’t be processed due to a conflict with the target resource's current state, which could result from updating or deleting the resource.</p> <p>Suggested action: Fetch the latest state of the resource, verify the state, and retry the request.</p>
        capo_partnercentral_selling.errors.internal_server_exception.InternalServerException: <p>This error occurs when the specified resource can’t be found or doesn't exist. Resource ID and type might be incorrect.</p> <p>Suggested action: This is usually a transient error. Retry after the provided retry delay or a short interval. If the problem persists, contact AWS support.</p>
        capo_partnercentral_selling.errors.resource_not_found_exception.ResourceNotFoundException: <p>This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.</p> <p>Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.</p>
        capo_partnercentral_selling.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>This error occurs when the request would cause a service quota to be exceeded. Service quotas represent the maximum allowed use of a specific resource, and this error indicates that the request would surpass that limit.</p> <p>Suggested action: Review the <a href="https://docs.aws.amazon.com/partner-central/latest/selling-api/quotas.html">Quotas</a> for the resource, and either reduce usage or request a quota increase.</p>
        capo_partnercentral_selling.errors.throttling_exception.ThrottlingException: <p>This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.</p> <p>This error occurs when there are too many requests sent. Review the provided <a href="https://docs.aws.amazon.com/partner-central/latest/selling-api/quotas.html">Quotas</a> and retry after the provided delay.</p>
        capo_partnercentral_selling.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by the service or business validation rules.</p> <p>Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.</p>
        capo_partnercentral_selling.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_partnercentral_selling.types.create_resource_snapshot_job_request.CreateResourceSnapshotJobRequest]",
    ) -> OperationResponse[
        "capo_partnercentral_selling.types.create_resource_snapshot_job_response.CreateResourceSnapshotJobResponse"
    ]:
        import capo_partnercentral_selling._operations.aws_partner_central_selling.create_resource_snapshot_job

        output, http_response = (
            capo_partnercentral_selling._operations.aws_partner_central_selling.create_resource_snapshot_job.create_resource_snapshot_job(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateResourceSnapshotJob")
    )
    input_: capo_partnercentral_selling.types.create_resource_snapshot_job_request.CreateResourceSnapshotJobRequest = {
        "catalog": catalog,
        "client_token": client_token,
        "engagement_identifier": engagement_identifier,
        "resource_type": resource_type,
        "resource_identifier": resource_identifier,
        "resource_snapshot_template_identifier": resource_snapshot_template_identifier,
    }
    if tags is not None:
        input_["tags"] = tags

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