Package software.amazon.awssdk.services.backup.model

Interface ListBackupJobSummariesRequest.Builder

    • Method Detail

      • accountId

        ListBackupJobSummariesRequest.Builder accountId​(String accountId)

        Returns the job count for the specified account.

        If the request is sent from a member account or an account not part of Amazon Web Services Organizations, jobs within requestor's account will be returned.

        Root, admin, and delegated administrator accounts can use the value ANY to return job counts from every account in the organization.

        AGGREGATE_ALL aggregates job counts from all accounts within the authenticated organization, then returns the sum.

        Parameters:
        accountId - Returns the job count for the specified account.

        If the request is sent from a member account or an account not part of Amazon Web Services Organizations, jobs within requestor's account will be returned.

        Root, admin, and delegated administrator accounts can use the value ANY to return job counts from every account in the organization.

        AGGREGATE_ALL aggregates job counts from all accounts within the authenticated organization, then returns the sum.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • state

        ListBackupJobSummariesRequest.Builder state​(String state)

        This parameter returns the job count for jobs with the specified state.

        The the value ANY returns count of all states.

        AGGREGATE_ALL aggregates job counts for all states and returns the sum.

        Completed with issues is a status found only in the Backup console. For API, this status refers to jobs with a state of COMPLETED and a MessageCategory with a value other than SUCCESS; that is, the status is completed but comes with a status message. To obtain the job count for Completed with issues, run two GET requests, and subtract the second, smaller number:

        GET /audit/backup-job-summaries?AggregationPeriod=FOURTEEN_DAYS&State=COMPLETED

        GET /audit/backup-job-summaries?AggregationPeriod=FOURTEEN_DAYS&MessageCategory=SUCCESS&State=COMPLETED

        Parameters:
        state - This parameter returns the job count for jobs with the specified state.

        The the value ANY returns count of all states.

        AGGREGATE_ALL aggregates job counts for all states and returns the sum.

        Completed with issues is a status found only in the Backup console. For API, this status refers to jobs with a state of COMPLETED and a MessageCategory with a value other than SUCCESS; that is, the status is completed but comes with a status message. To obtain the job count for Completed with issues, run two GET requests, and subtract the second, smaller number:

        GET /audit/backup-job-summaries?AggregationPeriod=FOURTEEN_DAYS&State=COMPLETED

        GET /audit/backup-job-summaries?AggregationPeriod=FOURTEEN_DAYS&MessageCategory=SUCCESS&State= COMPLETED

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        BackupJobStatus, BackupJobStatus

      • state

        ListBackupJobSummariesRequest.Builder state​(BackupJobStatus state)

        This parameter returns the job count for jobs with the specified state.

        The the value ANY returns count of all states.

        AGGREGATE_ALL aggregates job counts for all states and returns the sum.

        Completed with issues is a status found only in the Backup console. For API, this status refers to jobs with a state of COMPLETED and a MessageCategory with a value other than SUCCESS; that is, the status is completed but comes with a status message. To obtain the job count for Completed with issues, run two GET requests, and subtract the second, smaller number:

        GET /audit/backup-job-summaries?AggregationPeriod=FOURTEEN_DAYS&State=COMPLETED

        GET /audit/backup-job-summaries?AggregationPeriod=FOURTEEN_DAYS&MessageCategory=SUCCESS&State=COMPLETED

        Parameters:
        state - This parameter returns the job count for jobs with the specified state.

        The the value ANY returns count of all states.

        AGGREGATE_ALL aggregates job counts for all states and returns the sum.

        Completed with issues is a status found only in the Backup console. For API, this status refers to jobs with a state of COMPLETED and a MessageCategory with a value other than SUCCESS; that is, the status is completed but comes with a status message. To obtain the job count for Completed with issues, run two GET requests, and subtract the second, smaller number:

        GET /audit/backup-job-summaries?AggregationPeriod=FOURTEEN_DAYS&State=COMPLETED

        GET /audit/backup-job-summaries?AggregationPeriod=FOURTEEN_DAYS&MessageCategory=SUCCESS&State= COMPLETED

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        BackupJobStatus, BackupJobStatus

      • resourceType

        ListBackupJobSummariesRequest.Builder resourceType​(String resourceType)

        Returns the job count for the specified resource type. Use request GetSupportedResourceTypes to obtain strings for supported resource types.

        The the value ANY returns count of all resource types.

        AGGREGATE_ALL aggregates job counts for all resource types and returns the sum.

        The type of Amazon Web Services resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.

        Parameters:
        resourceType - Returns the job count for the specified resource type. Use request GetSupportedResourceTypes to obtain strings for supported resource types.

        The the value ANY returns count of all resource types.

        AGGREGATE_ALL aggregates job counts for all resource types and returns the sum.

        The type of Amazon Web Services resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • messageCategory

        ListBackupJobSummariesRequest.Builder messageCategory​(String messageCategory)

        This parameter returns the job count for the specified message category.

        Example accepted strings include AccessDenied, Success, and InvalidParameters. See Monitoring for a list of accepted MessageCategory strings.

        The the value ANY returns count of all message categories.

        AGGREGATE_ALL aggregates job counts for all message categories and returns the sum.

        Parameters:
        messageCategory - This parameter returns the job count for the specified message category.

        Example accepted strings include AccessDenied, Success, and InvalidParameters. See Monitoring for a list of accepted MessageCategory strings.

        The the value ANY returns count of all message categories.

        AGGREGATE_ALL aggregates job counts for all message categories and returns the sum.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • aggregationPeriod

        ListBackupJobSummariesRequest.Builder aggregationPeriod​(String aggregationPeriod)

        This is the period that sets the boundaries for returned results.

        Acceptable values include

        • ONE_DAY for daily job count for the prior 14 days.

        • SEVEN_DAYS for the aggregated job count for the prior 7 days.

        • FOURTEEN_DAYS for aggregated job count for prior 14 days.

        Parameters:
        aggregationPeriod - This is the period that sets the boundaries for returned results.

        Acceptable values include

        • ONE_DAY for daily job count for the prior 14 days.

        • SEVEN_DAYS for the aggregated job count for the prior 7 days.

        • FOURTEEN_DAYS for aggregated job count for prior 14 days.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        AggregationPeriod, AggregationPeriod

      • aggregationPeriod

        ListBackupJobSummariesRequest.Builder aggregationPeriod​(AggregationPeriod aggregationPeriod)

        This is the period that sets the boundaries for returned results.

        Acceptable values include

        • ONE_DAY for daily job count for the prior 14 days.

        • SEVEN_DAYS for the aggregated job count for the prior 7 days.

        • FOURTEEN_DAYS for aggregated job count for prior 14 days.

        Parameters:
        aggregationPeriod - This is the period that sets the boundaries for returned results.

        Acceptable values include

        • ONE_DAY for daily job count for the prior 14 days.

        • SEVEN_DAYS for the aggregated job count for the prior 7 days.

        • FOURTEEN_DAYS for aggregated job count for prior 14 days.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        AggregationPeriod, AggregationPeriod

      • maxResults

        ListBackupJobSummariesRequest.Builder maxResults​(Integer maxResults)

        This parameter sets the maximum number of items to be returned.

        The value is an integer. Range of accepted values is from 1 to 500.

        Parameters:
        maxResults - This parameter sets the maximum number of items to be returned.

        The value is an integer. Range of accepted values is from 1 to 500.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • nextToken

        ListBackupJobSummariesRequest.Builder nextToken​(String nextToken)

        The next item following a partial list of returned resources. For example, if a request is made to return MaxResults number of resources, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

        Parameters:
        nextToken - The next item following a partial list of returned resources. For example, if a request is made to return MaxResults number of resources, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
        Returns:
        Returns a reference to this object so that method calls can be chained together.