amazon.aws.backup_restore_job_info 模块 – 列出备份恢复作业的信息

注意

此模块是 amazon.aws 集合（版本 9.0.0）的一部分。

如果您正在使用 ansible 包，您可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install amazon.aws。您需要其他要求才能使用此模块，有关详细信息，请参阅 要求。

要在 playbook 中使用它，请指定：amazon.aws.backup_restore_job_info。

amazon.aws 6.0.0 中的新增功能

概要

• 列出有关为恢复已保存资源而启动的 AWS Backup 恢复作业的详细信息。

要求

以下要求需要在执行此模块的主机上满足。

• python >= 3.6

• boto3 >= 1.28.0

• botocore >= 1.31.0

参数

参数	注释
access_key 别名：aws_access_key_id, aws_access_key, ec2_access_key 字符串	AWS 访问密钥 ID。 有关访问令牌的更多信息，请参阅 AWS 文档 https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys。 还可以使用 AWS_ACCESS_KEY_ID、AWS_ACCESS_KEY 或 EC2_ACCESS_KEY 环境变量，优先级依次降低。 aws_access_key 和 profile 选项是互斥的。 为了与 AWS botocore SDK 保持一致，在 5.1.0 版本中添加了 aws_access_key_id 别名。 ec2_access_key 别名已被弃用，将在 2024-12-01 之后的版本中删除。 对 EC2_ACCESS_KEY 环境变量的支持已被弃用，将在 2024-12-01 之后的版本中删除。
account_id 字符串	从中列出恢复作业的账户 ID。
aws_ca_bundle 路径	用于验证 SSL 证书的 CA 包的位置。 也可以使用 AWS_CA_BUNDLE 环境变量。
aws_config 字典	用于修改 botocore 配置的字典。 可以在 AWS 文档 https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config 中找到参数。
completed_after 字符串	指定的日期，用于根据恢复作业完成的日期时间筛选结果。 如果指定，则只返回在指定日期时间之后创建的恢复作业。 日期必须采用 Unix 格式和协调世界时 (UTC)，例如“2023-02-25T00:05:36.309Z”。
completed_before 字符串	指定的日期，用于根据恢复作业完成的日期时间筛选结果。 如果指定，则只返回在指定日期时间之前创建的恢复作业。 日期必须采用 Unix 格式和协调世界时 (UTC)，例如“2023-02-25T00:05:36.309Z”。
created_after 字符串	指定的日期，用于根据恢复作业的创建日期时间筛选结果。 如果指定，则只返回在指定日期时间之后创建的恢复作业。 日期必须采用 Unix 格式和协调世界时 (UTC)，例如“2023-02-25T00:05:36.309Z”。
created_before 字符串	指定的日期，用于根据恢复作业的创建日期时间筛选结果。 如果指定，则只返回在指定日期时间之前创建的恢复作业。 日期必须采用 Unix 格式和协调世界时 (UTC)，例如“2023-02-25T00:05:36.309Z”。
debug_botocore_endpoint_logs 布尔值	使用 botocore.endpoint 记录器来解析任务期间发出的唯一（而不是总计）"resource:action" API 调用，并将该集合输出到任务结果中的 resource_actions 键中。使用 aws_resource_action 回调输出到 playbook 期间创建的总列表。 也可以使用 ANSIBLE_DEBUG_BOTOCORE_LOGS 环境变量。 选择 false ←（默认） true
endpoint_url 别名：ec2_url, aws_endpoint_url, s3_url 字符串	要连接的 URL，而不是默认的 AWS 端点。虽然这可以用于连接到其他与 AWS 兼容的服务，但 amazon.aws 和 community.aws 集合仅针对 AWS 进行了测试。 还可以使用 AWS_URL 或 EC2_URL 环境变量，优先级依次降低。 ec2_url 和 s3_url 别名已被弃用，将在 2024-12-01 之后的版本中删除。 对 EC2_URL 环境变量的支持已被弃用，将在 2024-12-01 之后的版本中删除。
profile 别名：aws_profile 字符串	用于身份验证的已命名 AWS 配置文件。 有关已命名配置文件的更多信息，请参阅 AWS 文档 https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html。 也可以使用 AWS_PROFILE 环境变量。 profile 选项与 aws_access_key、aws_secret_key 和 security_token 选项互斥。
region 别名: aws_region, ec2_region 字符串	要使用的 AWS 区域。 对于 IAM、Route53 和 CloudFront 等全局服务，将忽略 region。 也可以使用 AWS_REGION 或 EC2_REGION 环境变量。 有关更多信息，请参阅 Amazon AWS 文档 http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region。 ec2_region 别名已弃用，将在 2024-12-01 之后的版本中删除 对 EC2_REGION 环境变量的支持已弃用，将在 2024-12-01 之后的版本中删除。
restore_job_id 字符串	要获取信息的恢复作业的 ID。 此参数与所有其他参数互斥。
secret_key 别名: aws_secret_access_key, aws_secret_key, ec2_secret_key 字符串	AWS 秘密访问密钥。 有关访问令牌的更多信息，请参阅 AWS 文档 https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys。 也可以按优先级递减顺序使用 AWS_SECRET_ACCESS_KEY、AWS_SECRET_KEY 或 EC2_SECRET_KEY 环境变量。 secret_key 和 profile 选项互斥。 aws_secret_access_key 别名在 5.1.0 版本中添加，以与 AWS botocore SDK 保持一致。 ec2_secret_key 别名已弃用，将在 2024-12-01 之后的版本中删除。 对 EC2_SECRET_KEY 环境变量的支持已弃用，将在 2024-12-01 之后的版本中删除。
session_token 别名: aws_session_token, security_token, aws_security_token, access_token 字符串	用于临时凭证的 AWS STS 会话令牌。 有关访问令牌的更多信息，请参阅 AWS 文档 https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys。 也可以按优先级递减顺序使用 AWS_SESSION_TOKEN、AWS_SECURITY_TOKEN 或 EC2_SECURITY_TOKEN 环境变量。 security_token 和 profile 选项互斥。 别名 aws_session_token 和 session_token 在 3.2.0 版本中添加，该参数在 6.0.0 版本中从 security_token 重命名为 session_token。 security_token、aws_security_token 和 access_token 别名已弃用，将在 2024-12-01 之后的版本中删除。 对 EC2_SECRET_KEY 和 AWS_SECURITY_TOKEN 环境变量的支持已弃用，将在 2024-12-01 之后的版本中删除。
status 字符串	恢复作业的状态，用于根据作业状态过滤结果。 选择 "PENDING" "RUNNING" "COMPLETED" "ABORTED" "FAILED"
validate_certs 布尔值	设置为 false 时，与 AWS API 通信时将不会验证 SSL 证书。 强烈建议不要设置 validate_certs=false，作为替代方案，请考虑设置 aws_ca_bundle。 选择 false true ← (默认)

注意

注意

• 注意： 对于模块，环境变量和配置文件是从 Ansible “主机” 上下文而不是 “控制器” 上下文中读取的。因此，可能需要将文件显式复制到 “主机”。对于查找和连接插件，环境变量和配置文件是从 Ansible “控制器” 上下文而不是 “主机” 上下文中读取的。

• Ansible 使用的 AWS SDK (boto3) 也可能从 Ansible “主机” 上下文中的配置文件（通常是 ~/.aws/credentials）中读取凭证和其他设置（如区域）的默认值。有关更多信息，请参阅 https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html。

示例

# Note: These examples do not set authentication details, see the AWS Guide for details.

- name: List all restore jobs
  amazon.aws.backup_restore_job_info:

- name: List specific restore job's info by job ID
  amazon.aws.backup_restore_job_info:
    restore_job_id: "52BEE289-xxxx-xxxx-xxxx-47DCAA2E7ACD"

- name: List restore jobs based on Account ID
  amazon.aws.backup_restore_job_info:
    account_id: xx1234567890

- name: List restore jobs based on status and created_before time
  amazon.aws.backup_restore_job_info:
    status: completed
    created_before: "2023-02-25T00:05:36.309Z"

返回值

常见返回值记录在 此处，以下是此模块特有的字段

键	描述
restore_jobs 列表 / 元素=字典	与提供的过滤器匹配的恢复作业。 每个元素都包含一个字典，其中包含与该恢复作业相关的详细信息。 返回: 总是
account_id 字符串	拥有恢复作业的帐户 ID。 返回: 如果恢复作业存在 示例: "123456789012"
created_resource_arn 字符串	唯一标识正在恢复的恢复点的资源的 Amazon 资源名称 (ARN)。 ARN 的格式取决于备份资源的资源类型。 返回: 如果恢复作业存在 示例: "arn:aws:ec2:us-east-2:xxxxxxxxxx..."
creation_date 字符串	创建恢复作业的日期和时间，采用 Unix 格式和协调世界时 (UTC)。 返回: 如果恢复作业存在 示例: "2023-03-13T15:53:07.172000-07:00"
iam_role_arn 字符串	用于创建目标恢复点的 IAM 角色 ARN。 返回: 如果恢复作业存在 示例: "arn:aws:ec2:us-east-2:xxxxxxxxxx..."
percent_done 字符串	查询作业状态时，作业完成的估计百分比。 返回: 如果恢复作业存在 示例: "0.00%"
recovery_point_arn 字符串	唯一标识恢复点的 ARN。 返回: 如果恢复作业存在 示例: "arn:aws:ec2:us-east-2:xxxxxxxxxx..."
restore_job_id 字符串	恢复恢复点的作业的 ID。 返回: 如果恢复作业存在 示例: "AAAA1234-1D1D-1234-3F8E-1EB111EEEE00"
status 字符串	由 Backup 启动的用于恢复恢复点的作业的状态。 返回: 如果恢复作业存在 示例: "COMPLETED"

作者

• Mandar Vijay Kulkarni (@mandar242)

集合链接

• 问题跟踪器
• 存储库（源代码）
• 沟通