Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. auditmanager
  5. getAssessment

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.auditmanager.getAssessment

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-aws-native

    An entity that defines the scope of audit evidence collected by AWS Audit Manager.

    Using getAssessment

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getAssessment(args: GetAssessmentArgs, opts?: InvokeOptions): Promise<GetAssessmentResult>
function getAssessmentOutput(args: GetAssessmentOutputArgs, opts?: InvokeOptions): Output<GetAssessmentResult>
    def get_assessment(assessment_id: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetAssessmentResult
def get_assessment_output(assessment_id: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetAssessmentResult]
    func LookupAssessment(ctx *Context, args *LookupAssessmentArgs, opts ...InvokeOption) (*LookupAssessmentResult, error)
func LookupAssessmentOutput(ctx *Context, args *LookupAssessmentOutputArgs, opts ...InvokeOption) LookupAssessmentResultOutput

    > Note: This function is named LookupAssessment in the Go SDK.

    public static class GetAssessment 
{
    public static Task<GetAssessmentResult> InvokeAsync(GetAssessmentArgs args, InvokeOptions? opts = null)
    public static Output<GetAssessmentResult> Invoke(GetAssessmentInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetAssessmentResult> getAssessment(GetAssessmentArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: aws-native:auditmanager:getAssessment
  arguments:
    # arguments dictionary

    The following arguments are supported:

    AssessmentId string
    The unique identifier for the assessment.
    AssessmentId string
    The unique identifier for the assessment.
    assessmentId String
    The unique identifier for the assessment.
    assessmentId string
    The unique identifier for the assessment.
    assessment_id str
    The unique identifier for the assessment.
    assessmentId String
    The unique identifier for the assessment.

    getAssessment Result

    The following output properties are available:

    Arn string
    The Amazon Resource Name (ARN) of the assessment.
    AssessmentId string
    The unique identifier for the assessment.
    AssessmentReportsDestination Pulumi.AwsNative.AuditManager.Outputs.AssessmentReportsDestination
    The destination that evidence reports are stored in for the assessment.
    CreationTime double
    Specifies when the assessment was created.
    Delegations List<Pulumi.AwsNative.AuditManager.Outputs.AssessmentDelegation>
    The list of delegations.
    Roles List<Pulumi.AwsNative.AuditManager.Outputs.AssessmentRole>
    The list of roles for the specified assessment.
    Scope Pulumi.AwsNative.AuditManager.Outputs.AssessmentScope
    The wrapper of AWS accounts and services that are in scope for the assessment.
    Status Pulumi.AwsNative.AuditManager.AssessmentStatus

    The overall status of the assessment.

    When you create a new assessment, the initial Status value is always ACTIVE . When you create an assessment, even if you specify the value as INACTIVE , the value overrides to ACTIVE .

    After you create an assessment, you can change the value of the Status property at any time. For example, when you want to stop collecting evidence for your assessment, you can change the assessment status to INACTIVE .

    Tags List<Pulumi.AwsNative.Outputs.Tag>
    The tags associated with the assessment.
    Arn string
    The Amazon Resource Name (ARN) of the assessment.
    AssessmentId string
    The unique identifier for the assessment.
    AssessmentReportsDestination AssessmentReportsDestination
    The destination that evidence reports are stored in for the assessment.
    CreationTime float64
    Specifies when the assessment was created.
    Delegations []AssessmentDelegation
    The list of delegations.
    Roles []AssessmentRole
    The list of roles for the specified assessment.
    Scope AssessmentScope
    The wrapper of AWS accounts and services that are in scope for the assessment.
    Status AssessmentStatus

    The overall status of the assessment.

    When you create a new assessment, the initial Status value is always ACTIVE . When you create an assessment, even if you specify the value as INACTIVE , the value overrides to ACTIVE .

    After you create an assessment, you can change the value of the Status property at any time. For example, when you want to stop collecting evidence for your assessment, you can change the assessment status to INACTIVE .

    Tags Tag
    The tags associated with the assessment.
    arn String
    The Amazon Resource Name (ARN) of the assessment.
    assessmentId String
    The unique identifier for the assessment.
    assessmentReportsDestination AssessmentReportsDestination
    The destination that evidence reports are stored in for the assessment.
    creationTime Double
    Specifies when the assessment was created.
    delegations List<AssessmentDelegation>
    The list of delegations.
    roles List<AssessmentRole>
    The list of roles for the specified assessment.
    scope AssessmentScope
    The wrapper of AWS accounts and services that are in scope for the assessment.
    status AssessmentStatus

    The overall status of the assessment.

    When you create a new assessment, the initial Status value is always ACTIVE . When you create an assessment, even if you specify the value as INACTIVE , the value overrides to ACTIVE .

    After you create an assessment, you can change the value of the Status property at any time. For example, when you want to stop collecting evidence for your assessment, you can change the assessment status to INACTIVE .

    tags List<Tag>
    The tags associated with the assessment.
    arn string
    The Amazon Resource Name (ARN) of the assessment.
    assessmentId string
    The unique identifier for the assessment.
    assessmentReportsDestination AssessmentReportsDestination
    The destination that evidence reports are stored in for the assessment.
    creationTime number
    Specifies when the assessment was created.
    delegations AssessmentDelegation[]
    The list of delegations.
    roles AssessmentRole[]
    The list of roles for the specified assessment.
    scope AssessmentScope
    The wrapper of AWS accounts and services that are in scope for the assessment.
    status AssessmentStatus

    The overall status of the assessment.

    When you create a new assessment, the initial Status value is always ACTIVE . When you create an assessment, even if you specify the value as INACTIVE , the value overrides to ACTIVE .

    After you create an assessment, you can change the value of the Status property at any time. For example, when you want to stop collecting evidence for your assessment, you can change the assessment status to INACTIVE .

    tags Tag[]
    The tags associated with the assessment.
    arn str
    The Amazon Resource Name (ARN) of the assessment.
    assessment_id str
    The unique identifier for the assessment.
    assessment_reports_destination AssessmentReportsDestination
    The destination that evidence reports are stored in for the assessment.
    creation_time float
    Specifies when the assessment was created.
    delegations Sequence[AssessmentDelegation]
    The list of delegations.
    roles Sequence[AssessmentRole]
    The list of roles for the specified assessment.
    scope AssessmentScope
    The wrapper of AWS accounts and services that are in scope for the assessment.
    status AssessmentStatus

    The overall status of the assessment.

    When you create a new assessment, the initial Status value is always ACTIVE . When you create an assessment, even if you specify the value as INACTIVE , the value overrides to ACTIVE .

    After you create an assessment, you can change the value of the Status property at any time. For example, when you want to stop collecting evidence for your assessment, you can change the assessment status to INACTIVE .

    tags Sequence[root_Tag]
    The tags associated with the assessment.
    arn String
    The Amazon Resource Name (ARN) of the assessment.
    assessmentId String
    The unique identifier for the assessment.
    assessmentReportsDestination Property Map
    The destination that evidence reports are stored in for the assessment.
    creationTime Number
    Specifies when the assessment was created.
    delegations List<Property Map>
    The list of delegations.
    roles List<Property Map>
    The list of roles for the specified assessment.
    scope Property Map
    The wrapper of AWS accounts and services that are in scope for the assessment.
    status "ACTIVE" | "INACTIVE"

    The overall status of the assessment.

    When you create a new assessment, the initial Status value is always ACTIVE . When you create an assessment, even if you specify the value as INACTIVE , the value overrides to ACTIVE .

    After you create an assessment, you can change the value of the Status property at any time. For example, when you want to stop collecting evidence for your assessment, you can change the assessment status to INACTIVE .

    tags List<Property Map>
    The tags associated with the assessment.

    Supporting Types

    AssessmentAwsAccount

    EmailAddress string
    The email address that's associated with the AWS account .
    Id string
    The identifier for the AWS account .
    Name string
    The name of the AWS account .
    EmailAddress string
    The email address that's associated with the AWS account .
    Id string
    The identifier for the AWS account .
    Name string
    The name of the AWS account .
    emailAddress String
    The email address that's associated with the AWS account .
    id String
    The identifier for the AWS account .
    name String
    The name of the AWS account .
    emailAddress string
    The email address that's associated with the AWS account .
    id string
    The identifier for the AWS account .
    name string
    The name of the AWS account .
    email_address str
    The email address that's associated with the AWS account .
    id str
    The identifier for the AWS account .
    name str
    The name of the AWS account .
    emailAddress String
    The email address that's associated with the AWS account .
    id String
    The identifier for the AWS account .
    name String
    The name of the AWS account .

    AssessmentAwsService

    ServiceName string
    The name of the AWS service .
    ServiceName string
    The name of the AWS service .
    serviceName String
    The name of the AWS service .
    serviceName string
    The name of the AWS service .
    service_name str
    The name of the AWS service .
    serviceName String
    The name of the AWS service .

    AssessmentDelegation

    AssessmentId string
    The identifier for the assessment that's associated with the delegation.
    AssessmentName string
    The name of the assessment that's associated with the delegation.
    Comment string
    The comment that's related to the delegation.
    ControlSetId string
    The identifier for the control set that's associated with the delegation.
    CreatedBy string

    The user or role that created the delegation.

    Minimum : 1

    Maximum : 100

    Pattern : ^[a-zA-Z0-9-_()\\[\\]\\s]+$

    CreationTime double
    Specifies when the delegation was created.
    Id string
    The unique identifier for the delegation.
    LastUpdated double
    Specifies when the delegation was last updated.
    RoleArn string
    The Amazon Resource Name (ARN) of the IAM role.
    RoleType Pulumi.AwsNative.AuditManager.AssessmentRoleType

    The type of customer persona.

    In CreateAssessment , roleType can only be PROCESS_OWNER .

    In UpdateSettings , roleType can only be PROCESS_OWNER .

    In BatchCreateDelegationByAssessment , roleType can only be RESOURCE_OWNER .

    Status Pulumi.AwsNative.AuditManager.AssessmentDelegationStatus
    The status of the delegation.
    AssessmentId string
    The identifier for the assessment that's associated with the delegation.
    AssessmentName string
    The name of the assessment that's associated with the delegation.
    Comment string
    The comment that's related to the delegation.
    ControlSetId string
    The identifier for the control set that's associated with the delegation.
    CreatedBy string

    The user or role that created the delegation.

    Minimum : 1

    Maximum : 100

    Pattern : ^[a-zA-Z0-9-_()\\[\\]\\s]+$

    CreationTime float64
    Specifies when the delegation was created.
    Id string
    The unique identifier for the delegation.
    LastUpdated float64
    Specifies when the delegation was last updated.
    RoleArn string
    The Amazon Resource Name (ARN) of the IAM role.
    RoleType AssessmentRoleType

    The type of customer persona.

    In CreateAssessment , roleType can only be PROCESS_OWNER .

    In UpdateSettings , roleType can only be PROCESS_OWNER .

    In BatchCreateDelegationByAssessment , roleType can only be RESOURCE_OWNER .

    Status AssessmentDelegationStatus
    The status of the delegation.
    assessmentId String
    The identifier for the assessment that's associated with the delegation.
    assessmentName String
    The name of the assessment that's associated with the delegation.
    comment String
    The comment that's related to the delegation.
    controlSetId String
    The identifier for the control set that's associated with the delegation.
    createdBy String

    The user or role that created the delegation.

    Minimum : 1

    Maximum : 100

    Pattern : ^[a-zA-Z0-9-_()\\[\\]\\s]+$

    creationTime Double
    Specifies when the delegation was created.
    id String
    The unique identifier for the delegation.
    lastUpdated Double
    Specifies when the delegation was last updated.
    roleArn String
    The Amazon Resource Name (ARN) of the IAM role.
    roleType AssessmentRoleType

    The type of customer persona.

    In CreateAssessment , roleType can only be PROCESS_OWNER .

    In UpdateSettings , roleType can only be PROCESS_OWNER .

    In BatchCreateDelegationByAssessment , roleType can only be RESOURCE_OWNER .

    status AssessmentDelegationStatus
    The status of the delegation.
    assessmentId string
    The identifier for the assessment that's associated with the delegation.
    assessmentName string
    The name of the assessment that's associated with the delegation.
    comment string
    The comment that's related to the delegation.
    controlSetId string
    The identifier for the control set that's associated with the delegation.
    createdBy string

    The user or role that created the delegation.

    Minimum : 1

    Maximum : 100

    Pattern : ^[a-zA-Z0-9-_()\\[\\]\\s]+$

    creationTime number
    Specifies when the delegation was created.
    id string
    The unique identifier for the delegation.
    lastUpdated number
    Specifies when the delegation was last updated.
    roleArn string
    The Amazon Resource Name (ARN) of the IAM role.
    roleType AssessmentRoleType

    The type of customer persona.

    In CreateAssessment , roleType can only be PROCESS_OWNER .

    In UpdateSettings , roleType can only be PROCESS_OWNER .

    In BatchCreateDelegationByAssessment , roleType can only be RESOURCE_OWNER .

    status AssessmentDelegationStatus
    The status of the delegation.
    assessment_id str
    The identifier for the assessment that's associated with the delegation.
    assessment_name str
    The name of the assessment that's associated with the delegation.
    comment str
    The comment that's related to the delegation.
    control_set_id str
    The identifier for the control set that's associated with the delegation.
    created_by str

    The user or role that created the delegation.

    Minimum : 1

    Maximum : 100

    Pattern : ^[a-zA-Z0-9-_()\\[\\]\\s]+$

    creation_time float
    Specifies when the delegation was created.
    id str
    The unique identifier for the delegation.
    last_updated float
    Specifies when the delegation was last updated.
    role_arn str
    The Amazon Resource Name (ARN) of the IAM role.
    role_type AssessmentRoleType

    The type of customer persona.

    In CreateAssessment , roleType can only be PROCESS_OWNER .

    In UpdateSettings , roleType can only be PROCESS_OWNER .

    In BatchCreateDelegationByAssessment , roleType can only be RESOURCE_OWNER .

    status AssessmentDelegationStatus
    The status of the delegation.
    assessmentId String
    The identifier for the assessment that's associated with the delegation.
    assessmentName String
    The name of the assessment that's associated with the delegation.
    comment String
    The comment that's related to the delegation.
    controlSetId String
    The identifier for the control set that's associated with the delegation.
    createdBy String

    The user or role that created the delegation.

    Minimum : 1

    Maximum : 100

    Pattern : ^[a-zA-Z0-9-_()\\[\\]\\s]+$

    creationTime Number
    Specifies when the delegation was created.
    id String
    The unique identifier for the delegation.
    lastUpdated Number
    Specifies when the delegation was last updated.
    roleArn String
    The Amazon Resource Name (ARN) of the IAM role.
    roleType "PROCESS_OWNER" | "RESOURCE_OWNER"

    The type of customer persona.

    In CreateAssessment , roleType can only be PROCESS_OWNER .

    In UpdateSettings , roleType can only be PROCESS_OWNER .

    In BatchCreateDelegationByAssessment , roleType can only be RESOURCE_OWNER .

    status "IN_PROGRESS" | "UNDER_REVIEW" | "COMPLETE"
    The status of the delegation.

    AssessmentDelegationStatus

    AssessmentReportDestinationType

    AssessmentReportsDestination

    Destination string
    The destination bucket where Audit Manager stores assessment reports.
    DestinationType Pulumi.AwsNative.AuditManager.AssessmentReportDestinationType
    The destination type, such as Amazon S3.
    Destination string
    The destination bucket where Audit Manager stores assessment reports.
    DestinationType AssessmentReportDestinationType
    The destination type, such as Amazon S3.
    destination String
    The destination bucket where Audit Manager stores assessment reports.
    destinationType AssessmentReportDestinationType
    The destination type, such as Amazon S3.
    destination string
    The destination bucket where Audit Manager stores assessment reports.
    destinationType AssessmentReportDestinationType
    The destination type, such as Amazon S3.
    destination str
    The destination bucket where Audit Manager stores assessment reports.
    destination_type AssessmentReportDestinationType
    The destination type, such as Amazon S3.
    destination String
    The destination bucket where Audit Manager stores assessment reports.
    destinationType "S3"
    The destination type, such as Amazon S3.

    AssessmentRole

    RoleArn string
    The Amazon Resource Name (ARN) of the IAM role.
    RoleType Pulumi.AwsNative.AuditManager.AssessmentRoleType

    The type of customer persona.

    In CreateAssessment , roleType can only be PROCESS_OWNER .

    In UpdateSettings , roleType can only be PROCESS_OWNER .

    In BatchCreateDelegationByAssessment , roleType can only be RESOURCE_OWNER .

    RoleArn string
    The Amazon Resource Name (ARN) of the IAM role.
    RoleType AssessmentRoleType

    The type of customer persona.

    In CreateAssessment , roleType can only be PROCESS_OWNER .

    In UpdateSettings , roleType can only be PROCESS_OWNER .

    In BatchCreateDelegationByAssessment , roleType can only be RESOURCE_OWNER .

    roleArn String
    The Amazon Resource Name (ARN) of the IAM role.
    roleType AssessmentRoleType

    The type of customer persona.

    In CreateAssessment , roleType can only be PROCESS_OWNER .

    In UpdateSettings , roleType can only be PROCESS_OWNER .

    In BatchCreateDelegationByAssessment , roleType can only be RESOURCE_OWNER .

    roleArn string
    The Amazon Resource Name (ARN) of the IAM role.
    roleType AssessmentRoleType

    The type of customer persona.

    In CreateAssessment , roleType can only be PROCESS_OWNER .

    In UpdateSettings , roleType can only be PROCESS_OWNER .

    In BatchCreateDelegationByAssessment , roleType can only be RESOURCE_OWNER .

    role_arn str
    The Amazon Resource Name (ARN) of the IAM role.
    role_type AssessmentRoleType

    The type of customer persona.

    In CreateAssessment , roleType can only be PROCESS_OWNER .

    In UpdateSettings , roleType can only be PROCESS_OWNER .

    In BatchCreateDelegationByAssessment , roleType can only be RESOURCE_OWNER .

    roleArn String
    The Amazon Resource Name (ARN) of the IAM role.
    roleType "PROCESS_OWNER" | "RESOURCE_OWNER"

    The type of customer persona.

    In CreateAssessment , roleType can only be PROCESS_OWNER .

    In UpdateSettings , roleType can only be PROCESS_OWNER .

    In BatchCreateDelegationByAssessment , roleType can only be RESOURCE_OWNER .

    AssessmentRoleType

    AssessmentScope

    AwsAccounts []AssessmentAwsAccount
    The AWS accounts included in scope.
    AwsServices []AssessmentAwsService
    The AWS services included in scope.
    awsAccounts List<AssessmentAwsAccount>
    The AWS accounts included in scope.
    awsServices List<AssessmentAwsService>
    The AWS services included in scope.
    awsAccounts AssessmentAwsAccount[]
    The AWS accounts included in scope.
    awsServices AssessmentAwsService[]
    The AWS services included in scope.
    aws_accounts Sequence[AssessmentAwsAccount]
    The AWS accounts included in scope.
    aws_services Sequence[AssessmentAwsService]
    The AWS services included in scope.
    awsAccounts List<Property Map>
    The AWS accounts included in scope.
    awsServices List<Property Map>
    The AWS services included in scope.

    AssessmentStatus

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
    pulumi/pulumi-aws-native