AWS-ExportOpsDataToS3 - AWS Systems Manager Automation runbook reference

AWS-ExportOpsDataToS3

Description

This runbook retrieves a list of OpsData summaries in AWS Systems Manager Explorer and exports them to an object in a specified Amazon Simple Storage Service (Amazon S3) bucket.

Run this Automation (console)

Document type

Automation

Owner

Amazon

Platforms

Linux, macOS, Windows

Parameters

  • AutomationAssumeRole

    Type: String

    Description: (Optional) The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that allows Systems Manager Automation to perform the actions on your behalf. If no role is specified, Systems Manager Automation uses the permissions of the user that starts this runbook.

  • columnFields

    Type: StringList

    Description: (Required) Column fields to write to the output file.

  • filters

    Type: String

    Description: (Optional) Filters for the getOpsSummary request.

  • resultAttribute

    Type: String

    Description: (Optional) The result attribute for getOpsSummary request.

  • s3BucketName

    Type: String

    Description: (Required) S3 bucket where you want to download the output file.

  • snsSuccessMessage

    Type: String

    Description: (Optional) Message to send when runbook finishes.

  • snsTopicArn

    Type: String

    Description: (Required) Amazon Simple Notification Service (Amazon SNS) topic ARN to notify when the download completes.

  • syncName

    Type: String

    Description: (Optional) The name of the resource data sync.

Document Steps

getOpsSummaryStep – Retrieves up to 5,000 ops summaries to export in a CSV file now.

Outputs

OpsData object – If the runbook runs successfully, you will find the exported OpsData object in your target S3 bucket.