Welcome to the AWS Audit Manager API reference. This guide is for developers who need detailed information about the AWS Audit Manager API operations, data types, and errors.
AWS Audit Manager is a service that provides automated evidence collection so that you can continuously audit your AWS usage, and assess the effectiveness of your controls to better manage risk and simplify compliance.
AWS Audit Manager provides pre-built frameworks that structure and automate assessments for a given compliance standard. Frameworks include a pre-built collection of controls with descriptions and testing procedures, which are grouped according to the requirements of the specified compliance standard or regulation. You can also customize frameworks and controls to support internal audits with unique requirements.
Use the following links to get started with the AWS Audit Manager API:
Actions: An alphabetical list of all AWS Audit Manager API operations.
Data types: An alphabetical list of all AWS Audit Manager data types.
Common parameters: Parameters that all Query operations can use.
Common errors: Client and server errors that all operations can return.
If you're new to AWS Audit Manager, we recommend that you review the AWS Audit Manager User Guide.
", + "operations": { + "AssociateAssessmentReportEvidenceFolder": "Associates an evidence folder to the specified assessment report in AWS Audit Manager.
", + "BatchAssociateAssessmentReportEvidence": "Associates a list of evidence to an assessment report in an AWS Audit Manager assessment.
", + "BatchCreateDelegationByAssessment": "Create a batch of delegations for a specified assessment in AWS Audit Manager.
", + "BatchDeleteDelegationByAssessment": "Deletes the delegations in the specified AWS Audit Manager assessment.
", + "BatchDisassociateAssessmentReportEvidence": "Disassociates a list of evidence from the specified assessment report in AWS Audit Manager.
", + "BatchImportEvidenceToAssessmentControl": "Uploads one or more pieces of evidence to the specified control in the assessment in AWS Audit Manager.
", + "CreateAssessment": "Creates an assessment in AWS Audit Manager.
", + "CreateAssessmentFramework": "Creates a custom framework in AWS Audit Manager.
", + "CreateAssessmentReport": "Creates an assessment report for the specified assessment.
", + "CreateControl": "Creates a new custom control in AWS Audit Manager.
", + "DeleteAssessment": "Deletes an assessment in AWS Audit Manager.
", + "DeleteAssessmentFramework": "Deletes a custom framework in AWS Audit Manager.
", + "DeleteAssessmentReport": "Deletes an assessment report from an assessment in AWS Audit Manager.
", + "DeleteControl": "Deletes a custom control in AWS Audit Manager.
", + "DeregisterAccount": "Deregisters an account in AWS Audit Manager.
", + "DeregisterOrganizationAdminAccount": "Deregisters the delegated AWS administrator account from the AWS organization.
", + "DisassociateAssessmentReportEvidenceFolder": "Disassociates an evidence folder from the specified assessment report in AWS Audit Manager.
", + "GetAccountStatus": "Returns the registration status of an account in AWS Audit Manager.
", + "GetAssessment": "Returns an assessment from AWS Audit Manager.
", + "GetAssessmentFramework": "Returns a framework from AWS Audit Manager.
", + "GetAssessmentReportUrl": "Returns the URL of a specified assessment report in AWS Audit Manager.
", + "GetChangeLogs": "Returns a list of changelogs from AWS Audit Manager.
", + "GetControl": "Returns a control from AWS Audit Manager.
", + "GetDelegations": "Returns a list of delegations from an audit owner to a delegate.
", + "GetEvidence": "Returns evidence from AWS Audit Manager.
", + "GetEvidenceByEvidenceFolder": "Returns all evidence from a specified evidence folder in AWS Audit Manager.
", + "GetEvidenceFolder": "Returns an evidence folder from the specified assessment in AWS Audit Manager.
", + "GetEvidenceFoldersByAssessment": "Returns the evidence folders from a specified assessment in AWS Audit Manager.
", + "GetEvidenceFoldersByAssessmentControl": "Returns a list of evidence folders associated with a specified control of an assessment in AWS Audit Manager.
", + "GetOrganizationAdminAccount": "Returns the name of the delegated AWS administrator account for the AWS organization.
", + "GetServicesInScope": "Returns a list of the in-scope AWS services for the specified assessment.
", + "GetSettings": "Returns the settings for the specified AWS account.
", + "ListAssessmentFrameworks": "Returns a list of the frameworks available in the AWS Audit Manager framework library.
", + "ListAssessmentReports": "Returns a list of assessment reports created in AWS Audit Manager.
", + "ListAssessments": "Returns a list of current and past assessments from AWS Audit Manager.
", + "ListControls": "Returns a list of controls from AWS Audit Manager.
", + "ListKeywordsForDataSource": "Returns a list of keywords that pre-mapped to the specified control data source.
", + "ListNotifications": "Returns a list of all AWS Audit Manager notifications.
", + "ListTagsForResource": "Returns a list of tags for the specified resource in AWS Audit Manager.
", + "RegisterAccount": "Enables AWS Audit Manager for the specified AWS account.
", + "RegisterOrganizationAdminAccount": "Enables an AWS account within the organization as the delegated administrator for AWS Audit Manager.
", + "TagResource": "Tags the specified resource in AWS Audit Manager.
", + "UntagResource": "Removes a tag from a resource in AWS Audit Manager.
", + "UpdateAssessment": "Edits an AWS Audit Manager assessment.
", + "UpdateAssessmentControl": "Updates a control within an assessment in AWS Audit Manager.
", + "UpdateAssessmentControlSetStatus": "Updates the status of a control set in an AWS Audit Manager assessment.
", + "UpdateAssessmentFramework": "Updates a custom framework in AWS Audit Manager.
", + "UpdateAssessmentStatus": "Updates the status of an assessment in AWS Audit Manager.
", + "UpdateControl": "Updates a custom control in AWS Audit Manager.
", + "UpdateSettings": "Updates AWS Audit Manager settings for the current user account.
", + "ValidateAssessmentReportIntegrity": "Validates the integrity of an assessment report in AWS Audit Manager.
" + }, + "shapes": { + "AWSAccount": { + "base": "The wrapper of AWS account details, such as account ID, email address, and so on.
", + "refs": { + "AWSAccounts$member": null, + "Assessment$awsAccount": "The AWS account associated with the assessment.
" + } + }, + "AWSAccounts": { + "base": null, + "refs": { + "Scope$awsAccounts": "The AWS accounts included in the scope of the assessment.
" + } + }, + "AWSService": { + "base": "An AWS service such as Amazon S3, AWS CloudTrail, and so on.
", + "refs": { + "AWSServices$member": null + } + }, + "AWSServiceName": { + "base": null, + "refs": { + "AWSService$serviceName": "The name of the AWS service.
", + "Evidence$eventSource": "The AWS service from which the evidence is collected.
", + "ServiceMetadata$name": "The name of the AWS service.
" + } + }, + "AWSServices": { + "base": null, + "refs": { + "Scope$awsServices": "The AWS services included in the scope of the assessment.
" + } + }, + "AccessDeniedException": { + "base": "You do not have sufficient access to perform this action.
", + "refs": { + } + }, + "AccountId": { + "base": null, + "refs": { + "AWSAccount$id": "The identifier for the specified AWS account.
", + "AssessmentReport$awsAccountId": "The identifier for the specified AWS account.
", + "DeregisterOrganizationAdminAccountRequest$adminAccountId": "The identifier for the specified administrator account.
", + "Evidence$evidenceAwsAccountId": "The identifier for the specified AWS account.
", + "Evidence$awsAccountId": "The identifier for the specified AWS account.
", + "GetOrganizationAdminAccountResponse$adminAccountId": "The identifier for the specified administrator account.
", + "RegisterAccountRequest$delegatedAdminAccount": "The delegated administrator account for AWS Audit Manager.
", + "RegisterOrganizationAdminAccountRequest$adminAccountId": "The identifier for the specified delegated administrator account.
", + "RegisterOrganizationAdminAccountResponse$adminAccountId": "The identifier for the specified delegated administrator account.
" + } + }, + "AccountName": { + "base": null, + "refs": { + "AWSAccount$name": "The name of the specified AWS account.
" + } + }, + "AccountStatus": { + "base": null, + "refs": { + "DeregisterAccountResponse$status": "The registration status of the account.
", + "GetAccountStatusResponse$status": "The status of the specified AWS account.
", + "RegisterAccountResponse$status": "The status of the account registration request.
" + } + }, + "ActionEnum": { + "base": null, + "refs": { + "ChangeLog$action": "The action performed.
" + } + }, + "ActionPlanInstructions": { + "base": null, + "refs": { + "Control$actionPlanInstructions": "The recommended actions to carry out if the control is not fulfilled.
", + "CreateControlRequest$actionPlanInstructions": "The recommended actions to carry out if the control is not fulfilled.
", + "UpdateControlRequest$actionPlanInstructions": "The recommended actions to carry out if the control is not fulfilled.
" + } + }, + "ActionPlanTitle": { + "base": null, + "refs": { + "Control$actionPlanTitle": "The title of the action plan for remediating the control.
", + "CreateControlRequest$actionPlanTitle": "The title of the action plan for remediating the control.
", + "UpdateControlRequest$actionPlanTitle": "The title of the action plan for remediating the control.
" + } + }, + "Assessment": { + "base": "An entity that defines the scope of audit evidence collected by AWS Audit Manager. An AWS Audit Manager assessment is an implementation of an AWS Audit Manager framework.
", + "refs": { + "CreateAssessmentResponse$assessment": null, + "GetAssessmentResponse$assessment": null, + "UpdateAssessmentResponse$assessment": " The response object (name of the updated assessment) for the UpdateAssessmentRequest API.
The name of the updated assessment returned by the UpdateAssessmentStatus API.
The control entity that represents a standard or custom control used in an AWS Audit Manager assessment.
", + "refs": { + "AssessmentControls$member": null, + "UpdateAssessmentControlResponse$control": " The name of the updated control set returned by the UpdateAssessmentControl API.
Represents a set of controls in an AWS Audit Manager assessment.
", + "refs": { + "AssessmentControlSets$member": null, + "UpdateAssessmentControlSetStatusResponse$controlSet": " The name of the updated control set returned by the UpdateAssessmentControlSetStatus API.
The control sets associated with the framework.
" + } + }, + "AssessmentControls": { + "base": null, + "refs": { + "AssessmentControlSet$controls": "The list of controls contained with the control set.
" + } + }, + "AssessmentDescription": { + "base": null, + "refs": { + "AssessmentMetadata$description": "The description of the assessment.
", + "CreateAssessmentRequest$description": "The optional description of the assessment to be created.
", + "UpdateAssessmentRequest$assessmentDescription": "The description of the specified assessment.
" + } + }, + "AssessmentEvidenceFolder": { + "base": "The folder in which AWS Audit Manager stores evidence for an assessment.
", + "refs": { + "AssessmentEvidenceFolders$member": null, + "GetEvidenceFolderResponse$evidenceFolder": "The folder in which evidence is stored.
" + } + }, + "AssessmentEvidenceFolderName": { + "base": null, + "refs": { + "AssessmentEvidenceFolder$name": "The name of the specified evidence folder.
" + } + }, + "AssessmentEvidenceFolders": { + "base": null, + "refs": { + "GetEvidenceFoldersByAssessmentControlResponse$evidenceFolders": " The list of evidence folders returned by the GetEvidenceFoldersByAssessmentControl API.
The list of evidence folders returned by the GetEvidenceFoldersByAssessment API.
The file used to structure and automate AWS Audit Manager assessments for a given compliance standard.
", + "refs": { + "Assessment$framework": "The framework from which the assessment was created.
" + } + }, + "AssessmentFrameworkDescription": { + "base": null, + "refs": { + "FrameworkMetadata$description": "The description of the framework.
" + } + }, + "AssessmentFrameworkMetadata": { + "base": "The metadata associated with a standard or custom framework.
", + "refs": { + "FrameworkMetadataList$member": null + } + }, + "AssessmentMetadata": { + "base": "The metadata associated with the specified assessment.
", + "refs": { + "Assessment$metadata": "The metadata for the specified assessment.
" + } + }, + "AssessmentMetadataItem": { + "base": "A metadata object associated with an assessment in AWS Audit Manager.
", + "refs": { + "ListAssessmentMetadata$member": null + } + }, + "AssessmentName": { + "base": null, + "refs": { + "AssessmentMetadata$name": "The name of the assessment.
", + "AssessmentMetadataItem$name": "The name of the assessment.
", + "AssessmentReport$assessmentName": "The name of the associated assessment.
", + "AssessmentReportMetadata$assessmentName": "The name of the associated assessment.
", + "CreateAssessmentRequest$name": "The name of the assessment to be created.
", + "Delegation$assessmentName": "The name of the associated assessment.
", + "DelegationMetadata$assessmentName": "The name of the associated assessment.
", + "FrameworkMetadata$name": "The name of the framework.
", + "Notification$assessmentName": "The name of the related assessment.
", + "UpdateAssessmentRequest$assessmentName": "The name of the specified assessment to be updated.
" + } + }, + "AssessmentReport": { + "base": "A finalized document generated from an AWS Audit Manager assessment. These reports summarize the relevant evidence collected for your audit, and link to the relevant evidence folders which are named and organized according to the controls specified in your assessment.
", + "refs": { + "CreateAssessmentReportResponse$assessmentReport": " The new assessment report returned by the CreateAssessmentReport API.
The description of the specified assessment report.
", + "AssessmentReportMetadata$description": "The description of the specified assessment report.
", + "CreateAssessmentReportRequest$description": "The description of the assessment report.
" + } + }, + "AssessmentReportDestinationType": { + "base": null, + "refs": { + "AssessmentReportsDestination$destinationType": "The destination type, such as Amazon S3.
" + } + }, + "AssessmentReportEvidenceError": { + "base": " An error entity for the AssessmentReportEvidence API. This is used to provide more meaningful errors than a simple string message.
A list of errors returned by the BatchAssociateAssessmentReportEvidence API.
A list of errors returned by the BatchDisassociateAssessmentReportEvidence API.
The metadata objects associated with the specified assessment report.
", + "refs": { + "AssessmentReportsMetadata$member": null + } + }, + "AssessmentReportName": { + "base": null, + "refs": { + "AssessmentReport$name": "The name given to the assessment report.
", + "AssessmentReportMetadata$name": "The name of the assessment report.
", + "CreateAssessmentReportRequest$name": "The name of the new assessment report.
" + } + }, + "AssessmentReportStatus": { + "base": null, + "refs": { + "AssessmentReport$status": "The current status of the specified assessment report.
", + "AssessmentReportMetadata$status": "The current status of the assessment report.
" + } + }, + "AssessmentReportsDestination": { + "base": "The location in which AWS Audit Manager saves assessment reports for the given assessment.
", + "refs": { + "AssessmentMetadata$assessmentReportsDestination": "The destination in which evidence reports are stored for the specified assessment.
", + "CreateAssessmentRequest$assessmentReportsDestination": "The assessment report storage destination for the specified assessment that is being created.
", + "Settings$defaultAssessmentReportsDestination": "The default storage destination for assessment reports.
", + "UpdateAssessmentRequest$assessmentReportsDestination": "The assessment report storage destination for the specified assessment that is being updated.
", + "UpdateSettingsRequest$defaultAssessmentReportsDestination": "The default storage destination for assessment reports.
" + } + }, + "AssessmentReportsMetadata": { + "base": null, + "refs": { + "ListAssessmentReportsResponse$assessmentReports": " The list of assessment reports returned by the ListAssessmentReports API.
The overall status of the assessment.
", + "AssessmentMetadataItem$status": "The current status of the assessment.
", + "UpdateAssessmentStatusRequest$status": "The current status of the specified assessment.
" + } + }, + "AssociateAssessmentReportEvidenceFolderRequest": { + "base": null, + "refs": { + } + }, + "AssociateAssessmentReportEvidenceFolderResponse": { + "base": null, + "refs": { + } + }, + "AuditManagerArn": { + "base": null, + "refs": { + "Assessment$arn": "The Amazon Resource Name (ARN) of the assessment.
", + "AssessmentFramework$arn": "The Amazon Resource Name (ARN) of the specified framework.
", + "Control$arn": "The Amazon Resource Name (ARN) of the specified control.
", + "ControlMetadata$arn": "The Amazon Resource Name (ARN) of the specified control.
", + "Framework$arn": "The Amazon Resource Name (ARN) of the specified framework.
", + "ListTagsForResourceRequest$resourceArn": "The Amazon Resource Name (ARN) of the specified resource.
", + "TagResourceRequest$resourceArn": "The Amazon Resource Name (ARN) of the specified resource.
", + "UntagResourceRequest$resourceArn": "The Amazon Resource Name (ARN) of the specified resource.
" + } + }, + "BatchAssociateAssessmentReportEvidenceRequest": { + "base": null, + "refs": { + } + }, + "BatchAssociateAssessmentReportEvidenceResponse": { + "base": null, + "refs": { + } + }, + "BatchCreateDelegationByAssessmentError": { + "base": " An error entity for the BatchCreateDelegationByAssessment API. This is used to provide more meaningful errors than a simple string message.
A list of errors returned by the BatchCreateDelegationByAssessment API.
An error entity for the BatchDeleteDelegationByAssessment API. This is used to provide more meaningful errors than a simple string message.
A list of errors returned by the BatchDeleteDelegationByAssessment API.
An error entity for the BatchImportEvidenceToAssessmentControl API. This is used to provide more meaningful errors than a simple string message.
A list of errors returned by the BatchImportEvidenceToAssessmentControl API.
Specifies whether AWS Organizations is enabled.
", + "ValidateAssessmentReportIntegrityResponse$signatureValid": "Specifies whether the signature key is valid.
" + } + }, + "ChangeLog": { + "base": "The record of a change within AWS Audit Manager, such as a modified assessment, a delegated control set, and so on.
", + "refs": { + "ChangeLogs$member": null + } + }, + "ChangeLogs": { + "base": null, + "refs": { + "GetChangeLogsResponse$changeLogs": "The list of user activity for the control.
" + } + }, + "ComplianceType": { + "base": null, + "refs": { + "AssessmentFrameworkMetadata$complianceType": "The compliance type that the new custom framework supports, such as CIS or HIPAA.
", + "AssessmentMetadata$complianceType": "The name of a compliance standard related to the assessment, such as PCI-DSS.
", + "AssessmentMetadataItem$complianceType": "The name of the compliance standard related to the assessment, such as PCI-DSS.
", + "CreateAssessmentFrameworkRequest$complianceType": "The compliance type that the new custom framework supports, such as CIS or HIPAA.
", + "Framework$complianceType": "The compliance type that the new custom framework supports, such as CIS or HIPAA.
", + "FrameworkMetadata$complianceType": "The compliance standard associated with the framework, such as PCI-DSS or HIPAA.
", + "UpdateAssessmentFrameworkRequest$complianceType": "The compliance type that the new custom framework supports, such as CIS or HIPAA.
" + } + }, + "Control": { + "base": "A control in AWS Audit Manager.
", + "refs": { + "Controls$member": null, + "CreateControlResponse$control": " The new control returned by the CreateControl API.
The name of the control returned by the GetControl API.
The name of the updated control set returned by the UpdateControl API.
A comment posted by a user on a control. This includes the author's name, the comment text, and a timestamp.
", + "refs": { + "ControlComments$member": null + } + }, + "ControlCommentBody": { + "base": null, + "refs": { + "ControlComment$commentBody": "The body text of a control comment.
", + "UpdateAssessmentControlRequest$commentBody": "The comment body text for the specified control.
" + } + }, + "ControlComments": { + "base": null, + "refs": { + "AssessmentControl$comments": "The list of comments attached to the specified control.
" + } + }, + "ControlDescription": { + "base": null, + "refs": { + "AssessmentControl$description": "The description of the specified control.
", + "Control$description": "The description of the specified control.
", + "CreateControlRequest$description": "The description of the control.
", + "UpdateControlRequest$description": "The optional description of the control.
" + } + }, + "ControlMappingSource": { + "base": "The data source that determines from where AWS Audit Manager collects evidence for the control.
", + "refs": { + "ControlMappingSources$member": null + } + }, + "ControlMappingSources": { + "base": null, + "refs": { + "Control$controlMappingSources": "The data mapping sources for the specified control.
", + "UpdateControlRequest$controlMappingSources": "The data source that determines from where AWS Audit Manager collects evidence for the control.
" + } + }, + "ControlMetadata": { + "base": "The metadata associated with the specified standard or custom control.
", + "refs": { + "ControlMetadataList$member": null + } + }, + "ControlMetadataList": { + "base": null, + "refs": { + "ListControlsResponse$controlMetadataList": " The list of control metadata objects returned by the ListControls API.
The name of the specified control.
", + "AssessmentEvidenceFolder$controlName": "The name of the control.
", + "Control$name": "The name of the specified control.
", + "ControlMetadata$name": "The name of the specified control.
", + "CreateControlRequest$name": "The name of the control.
", + "UpdateControlRequest$name": "The name of the control to be updated.
" + } + }, + "ControlResponse": { + "base": null, + "refs": { + "AssessmentControl$response": "The response of the specified control.
" + } + }, + "ControlSet": { + "base": "A set of controls in AWS Audit Manager.
", + "refs": { + "ControlSets$member": null + } + }, + "ControlSetId": { + "base": null, + "refs": { + "AssessmentControlSet$id": "The identifier of the control set in the assessment. This is the control set name in a plain string format.
", + "AssessmentEvidenceFolder$controlSetId": "The identifier for the control set.
", + "BatchImportEvidenceToAssessmentControlRequest$controlSetId": "The identifier for the specified control set.
", + "CreateDelegationRequest$controlSetId": "The unique identifier for the control set.
", + "Delegation$controlSetId": "The identifier for the associated control set.
", + "GetChangeLogsRequest$controlSetId": "The identifier for the specified control set.
", + "GetEvidenceByEvidenceFolderRequest$controlSetId": "The identifier for the control set.
", + "GetEvidenceFolderRequest$controlSetId": "The identifier for the specified control set.
", + "GetEvidenceFoldersByAssessmentControlRequest$controlSetId": "The identifier for the specified control set.
", + "GetEvidenceRequest$controlSetId": "The identifier for the specified control set.
", + "Notification$controlSetId": "The identifier for the specified control set.
", + "UpdateAssessmentControlRequest$controlSetId": "The identifier for the specified control set.
" + } + }, + "ControlSetName": { + "base": null, + "refs": { + "ControlSet$name": "The name of the control set.
", + "CreateAssessmentFrameworkControlSet$name": "The name of the specified control set.
", + "UpdateAssessmentFrameworkControlSet$name": "The name of the control set.
" + } + }, + "ControlSetStatus": { + "base": null, + "refs": { + "AssessmentControlSet$status": "Specifies the current status of the control set.
", + "UpdateAssessmentControlSetStatusRequest$status": "The status of the control set that is being updated.
" + } + }, + "ControlSets": { + "base": null, + "refs": { + "Framework$controlSets": "The control sets associated with the framework.
" + } + }, + "ControlSetsCount": { + "base": null, + "refs": { + "AssessmentFrameworkMetadata$controlSetsCount": "The number of control sets associated with the specified framework.
" + } + }, + "ControlSources": { + "base": null, + "refs": { + "Control$controlSources": "The data mapping sources for the specified control.
", + "ControlMetadata$controlSources": "The data source that determines from where AWS Audit Manager collects evidence for the control.
", + "Framework$controlSources": "The sources from which AWS Audit Manager collects evidence for the control.
" + } + }, + "ControlStatus": { + "base": null, + "refs": { + "AssessmentControl$status": "The status of the specified control.
", + "UpdateAssessmentControlRequest$controlStatus": "The status of the specified control.
" + } + }, + "ControlType": { + "base": null, + "refs": { + "Control$type": "The type of control, such as custom or standard.
", + "ListControlsRequest$controlType": "The type of control, such as standard or custom.
" + } + }, + "Controls": { + "base": null, + "refs": { + "ControlSet$controls": "The list of controls within the control set.
" + } + }, + "ControlsCount": { + "base": null, + "refs": { + "AssessmentFrameworkMetadata$controlsCount": "The number of controls associated with the specified framework.
" + } + }, + "CreateAssessmentFrameworkControl": { + "base": "Control entity attributes that uniquely identify an existing control to be added to a framework in AWS Audit Manager.
", + "refs": { + "CreateAssessmentFrameworkControls$member": null + } + }, + "CreateAssessmentFrameworkControlSet": { + "base": " A controlSet entity that represents a collection of controls in AWS Audit Manager. This does not contain the control set ID.
The control sets to be associated with the framework.
" + } + }, + "CreateAssessmentFrameworkControls": { + "base": null, + "refs": { + "CreateAssessmentFrameworkControlSet$controls": "The list of controls within the control set. This does not contain the control set ID.
", + "UpdateAssessmentFrameworkControlSet$controls": "The list of controls contained within the control set.
" + } + }, + "CreateAssessmentFrameworkRequest": { + "base": null, + "refs": { + } + }, + "CreateAssessmentFrameworkResponse": { + "base": null, + "refs": { + } + }, + "CreateAssessmentReportRequest": { + "base": null, + "refs": { + } + }, + "CreateAssessmentReportResponse": { + "base": null, + "refs": { + } + }, + "CreateAssessmentRequest": { + "base": null, + "refs": { + } + }, + "CreateAssessmentResponse": { + "base": null, + "refs": { + } + }, + "CreateControlMappingSource": { + "base": " Control mapping fields that represent the source for evidence collection, along with related parameters and metadata. This does not contain mappingID.
The data source that determines from where AWS Audit Manager collects evidence for the control.
" + } + }, + "CreateControlRequest": { + "base": null, + "refs": { + } + }, + "CreateControlResponse": { + "base": null, + "refs": { + } + }, + "CreateDelegationRequest": { + "base": "A collection of attributes used to create a delegation for an assessment in AWS Audit Manager.
", + "refs": { + "BatchCreateDelegationByAssessmentError$createDelegationRequest": "The API request to batch create delegations in AWS Audit Manager.
", + "CreateDelegationRequests$member": null + } + }, + "CreateDelegationRequests": { + "base": null, + "refs": { + "BatchCreateDelegationByAssessmentRequest$createDelegationRequests": "The API request to batch create delegations in AWS Audit Manager.
" + } + }, + "CreatedBy": { + "base": null, + "refs": { + "Control$createdBy": "The IAM user or role that created the control.
", + "Delegation$createdBy": "The IAM user or role that created the delegation.
", + "Framework$createdBy": "The IAM user or role that created the framework.
" + } + }, + "Delegation": { + "base": "The assignment of a control set to a delegate for review.
", + "refs": { + "Delegations$member": null + } + }, + "DelegationComment": { + "base": null, + "refs": { + "CreateDelegationRequest$comment": "A comment related to the delegation request.
", + "Delegation$comment": "The comment related to the delegation.
", + "UpdateAssessmentControlSetStatusRequest$comment": "The comment related to the status update.
" + } + }, + "DelegationIds": { + "base": null, + "refs": { + "BatchDeleteDelegationByAssessmentRequest$delegationIds": "The identifiers for the specified delegations.
" + } + }, + "DelegationMetadata": { + "base": "The metadata associated with the specified delegation.
", + "refs": { + "DelegationMetadataList$member": null + } + }, + "DelegationMetadataList": { + "base": null, + "refs": { + "GetDelegationsResponse$delegations": " The list of delegations returned by the GetDelegations API.
The status of the delegation.
", + "DelegationMetadata$status": "The current status of the delgation.
" + } + }, + "Delegations": { + "base": null, + "refs": { + "AssessmentControlSet$delegations": "The delegations associated with the control set.
", + "AssessmentMetadata$delegations": "The delegations associated with the assessment.
", + "AssessmentMetadataItem$delegations": "The delegations associated with the assessment.
", + "BatchCreateDelegationByAssessmentResponse$delegations": "The delegations associated with the assessment.
" + } + }, + "DeleteAssessmentFrameworkRequest": { + "base": null, + "refs": { + } + }, + "DeleteAssessmentFrameworkResponse": { + "base": null, + "refs": { + } + }, + "DeleteAssessmentReportRequest": { + "base": null, + "refs": { + } + }, + "DeleteAssessmentReportResponse": { + "base": null, + "refs": { + } + }, + "DeleteAssessmentRequest": { + "base": null, + "refs": { + } + }, + "DeleteAssessmentResponse": { + "base": null, + "refs": { + } + }, + "DeleteControlRequest": { + "base": null, + "refs": { + } + }, + "DeleteControlResponse": { + "base": null, + "refs": { + } + }, + "DeregisterAccountRequest": { + "base": null, + "refs": { + } + }, + "DeregisterAccountResponse": { + "base": null, + "refs": { + } + }, + "DeregisterOrganizationAdminAccountRequest": { + "base": null, + "refs": { + } + }, + "DeregisterOrganizationAdminAccountResponse": { + "base": null, + "refs": { + } + }, + "DisassociateAssessmentReportEvidenceFolderRequest": { + "base": null, + "refs": { + } + }, + "DisassociateAssessmentReportEvidenceFolderResponse": { + "base": null, + "refs": { + } + }, + "EmailAddress": { + "base": null, + "refs": { + "AWSAccount$emailAddress": "The email address associated with the specified AWS account.
" + } + }, + "ErrorCode": { + "base": null, + "refs": { + "AssessmentReportEvidenceError$errorCode": " The error code returned by the AssessmentReportEvidence API.
The error code returned by the BatchCreateDelegationByAssessment API.
The error code returned by the BatchDeleteDelegationByAssessment API.
The error code returned by the BatchImportEvidenceToAssessmentControl API.
The error message returned by the AssessmentReportEvidence API.
The error message returned by the BatchCreateDelegationByAssessment API.
The error message returned by the BatchDeleteDelegationByAssessment API.
The error message returned by the BatchImportEvidenceToAssessmentControlError API.
The name of the specified evidence event.
" + } + }, + "Evidence": { + "base": "A record that contains the information needed to demonstrate compliance with the requirements specified by a control. Examples of evidence include change activity triggered by a user, or a system configuration snapshot.
", + "refs": { + "EvidenceList$member": null, + "GetEvidenceResponse$evidence": " The evidence returned by the GetEvidenceResponse API.
The names and values used by the evidence event, including an attribute name (such as allowUsersToChangePassword) and value (such as true or false).
The list of evidence identifiers.
", + "BatchAssociateAssessmentReportEvidenceResponse$evidenceIds": "The identifier for the evidence.
", + "BatchDisassociateAssessmentReportEvidenceRequest$evidenceIds": "The list of evidence identifiers.
", + "BatchDisassociateAssessmentReportEvidenceResponse$evidenceIds": "The identifier for the evidence.
" + } + }, + "EvidenceList": { + "base": null, + "refs": { + "GetEvidenceByEvidenceFolderResponse$evidence": " The list of evidence returned by the GetEvidenceByEvidenceFolder API.
The list of data sources for the specified evidence.
" + } + }, + "Filename": { + "base": null, + "refs": { + "AssessmentFrameworkMetadata$logo": "The logo associated with the framework.
", + "Framework$logo": "The logo associated with the framework.
", + "FrameworkMetadata$logo": "The logo associated with the framework.
" + } + }, + "Framework": { + "base": "The file used to structure and automate AWS Audit Manager assessments for a given compliance standard.
", + "refs": { + "CreateAssessmentFrameworkResponse$framework": " The name of the new framework returned by the CreateAssessmentFramework API.
The framework returned by the GetAssessmentFramework API.
The name of the specified framework.
" + } + }, + "FrameworkDescription": { + "base": null, + "refs": { + "AssessmentFrameworkMetadata$description": "The description of the specified framework.
", + "CreateAssessmentFrameworkRequest$description": "An optional description for the new custom framework.
", + "Framework$description": "The description of the specified framework.
", + "UpdateAssessmentFrameworkRequest$description": "The description of the framework that is to be updated.
" + } + }, + "FrameworkMetadata": { + "base": "The metadata of a framework, such as the name, ID, description, and so on.
", + "refs": { + "AssessmentFramework$metadata": null + } + }, + "FrameworkMetadataList": { + "base": null, + "refs": { + "ListAssessmentFrameworksResponse$frameworkMetadataList": "The list of metadata objects for the specified framework.
" + } + }, + "FrameworkName": { + "base": null, + "refs": { + "AssessmentFrameworkMetadata$name": "The name of the specified framework.
", + "CreateAssessmentFrameworkRequest$name": "The name of the new custom framework.
", + "Framework$name": "The name of the specified framework.
", + "UpdateAssessmentFrameworkRequest$name": "The name of the framework to be updated.
" + } + }, + "FrameworkType": { + "base": null, + "refs": { + "AssessmentFrameworkMetadata$type": "The framework type, such as standard or custom.
", + "Framework$type": "The framework type, such as custom or standard.
", + "ListAssessmentFrameworksRequest$frameworkType": "The type of framework, such as standard or custom.
" + } + }, + "GenericArn": { + "base": null, + "refs": { + "Resource$arn": "The Amazon Resource Name (ARN) for the specified resource.
" + } + }, + "GetAccountStatusRequest": { + "base": null, + "refs": { + } + }, + "GetAccountStatusResponse": { + "base": null, + "refs": { + } + }, + "GetAssessmentFrameworkRequest": { + "base": null, + "refs": { + } + }, + "GetAssessmentFrameworkResponse": { + "base": null, + "refs": { + } + }, + "GetAssessmentReportUrlRequest": { + "base": null, + "refs": { + } + }, + "GetAssessmentReportUrlResponse": { + "base": null, + "refs": { + } + }, + "GetAssessmentRequest": { + "base": null, + "refs": { + } + }, + "GetAssessmentResponse": { + "base": null, + "refs": { + } + }, + "GetChangeLogsRequest": { + "base": null, + "refs": { + } + }, + "GetChangeLogsResponse": { + "base": null, + "refs": { + } + }, + "GetControlRequest": { + "base": null, + "refs": { + } + }, + "GetControlResponse": { + "base": null, + "refs": { + } + }, + "GetDelegationsRequest": { + "base": null, + "refs": { + } + }, + "GetDelegationsResponse": { + "base": null, + "refs": { + } + }, + "GetEvidenceByEvidenceFolderRequest": { + "base": null, + "refs": { + } + }, + "GetEvidenceByEvidenceFolderResponse": { + "base": null, + "refs": { + } + }, + "GetEvidenceFolderRequest": { + "base": null, + "refs": { + } + }, + "GetEvidenceFolderResponse": { + "base": null, + "refs": { + } + }, + "GetEvidenceFoldersByAssessmentControlRequest": { + "base": null, + "refs": { + } + }, + "GetEvidenceFoldersByAssessmentControlResponse": { + "base": null, + "refs": { + } + }, + "GetEvidenceFoldersByAssessmentRequest": { + "base": null, + "refs": { + } + }, + "GetEvidenceFoldersByAssessmentResponse": { + "base": null, + "refs": { + } + }, + "GetEvidenceRequest": { + "base": null, + "refs": { + } + }, + "GetEvidenceResponse": { + "base": null, + "refs": { + } + }, + "GetOrganizationAdminAccountRequest": { + "base": null, + "refs": { + } + }, + "GetOrganizationAdminAccountResponse": { + "base": null, + "refs": { + } + }, + "GetServicesInScopeRequest": { + "base": null, + "refs": { + } + }, + "GetServicesInScopeResponse": { + "base": null, + "refs": { + } + }, + "GetSettingsRequest": { + "base": null, + "refs": { + } + }, + "GetSettingsResponse": { + "base": null, + "refs": { + } + }, + "HyperlinkName": { + "base": null, + "refs": { + "URL$hyperlinkName": "The name or word used as a hyperlink to the URL.
" + } + }, + "IamArn": { + "base": null, + "refs": { + "ChangeLog$createdBy": "The IAM user or role that performed the action.
", + "CreateDelegationRequest$roleArn": "The Amazon Resource Name (ARN) of the IAM role.
", + "Delegation$roleArn": "The Amazon Resource Name (ARN) of the IAM role.
", + "DelegationMetadata$roleArn": "The Amazon Resource Name (ARN) of the IAM role.
", + "Evidence$iamId": "The unique identifier for the IAM user or role associated with the evidence.
", + "Role$roleArn": "The Amazon Resource Name (ARN) of the IAM role.
" + } + }, + "Integer": { + "base": null, + "refs": { + "AssessmentControl$evidenceCount": "The amount of evidence generated for the control.
", + "AssessmentControl$assessmentReportEvidenceCount": "The amount of evidence in the assessment report.
", + "AssessmentControlSet$systemEvidenceCount": "The total number of evidence objects retrieved automatically for the control set.
", + "AssessmentControlSet$manualEvidenceCount": "The total number of evidence objects uploaded manually to the control set.
", + "AssessmentEvidenceFolder$totalEvidence": "The total amount of evidence in the evidence folder.
", + "AssessmentEvidenceFolder$assessmentReportSelectionCount": "The total count of evidence included in the assessment report.
", + "AssessmentEvidenceFolder$evidenceResourcesIncludedCount": "The amount of evidence included in the evidence folder.
", + "AssessmentEvidenceFolder$evidenceByTypeConfigurationDataCount": "The number of evidence that falls under the configuration data category. This evidence is collected from configuration snapshots of other AWS services such as Amazon EC2, Amazon S3, or IAM.
", + "AssessmentEvidenceFolder$evidenceByTypeManualCount": "The number of evidence that falls under the manual category. This evidence is imported manually.
", + "AssessmentEvidenceFolder$evidenceByTypeComplianceCheckCount": "The number of evidence that falls under the compliance check category. This evidence is collected from AWS Config or AWS Security Hub.
", + "AssessmentEvidenceFolder$evidenceByTypeComplianceCheckIssuesCount": "The total number of issues that were reported directly from AWS Security Hub, AWS Config, or both.
", + "AssessmentEvidenceFolder$evidenceByTypeUserActivityCount": "The number of evidence that falls under the user activity category. This evidence is collected from AWS CloudTrail logs.
", + "AssessmentEvidenceFolder$evidenceAwsServiceSourceCount": "The total number of AWS resources assessed to generate the evidence.
" + } + }, + "InternalServerException": { + "base": "An internal service error occurred during the processing of your request. Try again later.
", + "refs": { + } + }, + "KeywordInputType": { + "base": null, + "refs": { + "SourceKeyword$keywordInputType": "The method of input for the specified keyword.
" + } + }, + "KeywordValue": { + "base": null, + "refs": { + "Keywords$member": null, + "SourceKeyword$keywordValue": "The value of the keyword used to search AWS CloudTrail logs when mapping a control data source.
" + } + }, + "Keywords": { + "base": null, + "refs": { + "ListKeywordsForDataSourceResponse$keywords": "The list of keywords for the specified event mapping source.
" + } + }, + "KmsKey": { + "base": null, + "refs": { + "RegisterAccountRequest$kmsKey": "The AWS KMS key details.
", + "Settings$kmsKey": "The AWS KMS key details.
", + "UpdateSettingsRequest$kmsKey": "The AWS KMS key details.
" + } + }, + "LastUpdatedBy": { + "base": null, + "refs": { + "Control$lastUpdatedBy": "The IAM user or role that most recently updated the control.
", + "Framework$lastUpdatedBy": "The IAM user or role that most recently updated the framework.
" + } + }, + "ListAssessmentFrameworksRequest": { + "base": null, + "refs": { + } + }, + "ListAssessmentFrameworksResponse": { + "base": null, + "refs": { + } + }, + "ListAssessmentMetadata": { + "base": null, + "refs": { + "ListAssessmentsResponse$assessmentMetadata": "The metadata associated with the assessment.
" + } + }, + "ListAssessmentReportsRequest": { + "base": null, + "refs": { + } + }, + "ListAssessmentReportsResponse": { + "base": null, + "refs": { + } + }, + "ListAssessmentsRequest": { + "base": null, + "refs": { + } + }, + "ListAssessmentsResponse": { + "base": null, + "refs": { + } + }, + "ListControlsRequest": { + "base": null, + "refs": { + } + }, + "ListControlsResponse": { + "base": null, + "refs": { + } + }, + "ListKeywordsForDataSourceRequest": { + "base": null, + "refs": { + } + }, + "ListKeywordsForDataSourceResponse": { + "base": null, + "refs": { + } + }, + "ListNotificationsRequest": { + "base": null, + "refs": { + } + }, + "ListNotificationsResponse": { + "base": null, + "refs": { + } + }, + "ListTagsForResourceRequest": { + "base": null, + "refs": { + } + }, + "ListTagsForResourceResponse": { + "base": null, + "refs": { + } + }, + "ManualEvidence": { + "base": "Evidence that is uploaded to AWS Audit Manager manually.
", + "refs": { + "BatchImportEvidenceToAssessmentControlError$manualEvidence": "Manual evidence that cannot be collected automatically by AWS Audit Manager.
", + "ManualEvidenceList$member": null + } + }, + "ManualEvidenceList": { + "base": null, + "refs": { + "BatchImportEvidenceToAssessmentControlRequest$manualEvidence": "The list of manual evidence objects.
" + } + }, + "MaxResults": { + "base": "Max results in the page.", + "refs": { + "GetChangeLogsRequest$maxResults": "Represents the maximum number of results per page, or per API request call.
", + "GetDelegationsRequest$maxResults": "Represents the maximum number of results per page, or per API request call.
", + "GetEvidenceByEvidenceFolderRequest$maxResults": "Represents the maximum number of results per page, or per API request call.
", + "GetEvidenceFoldersByAssessmentControlRequest$maxResults": "Represents the maximum number of results per page, or per API request call.
", + "GetEvidenceFoldersByAssessmentRequest$maxResults": "Represents the maximum number of results per page, or per API request call.
", + "ListAssessmentFrameworksRequest$maxResults": "Represents the maximum number of results per page, or per API request call.
", + "ListAssessmentReportsRequest$maxResults": "Represents the maximum number of results per page, or per API request call.
", + "ListAssessmentsRequest$maxResults": "Represents the maximum number of results per page, or per API request call.
", + "ListControlsRequest$maxResults": "Represents the maximum number of results per page, or per API request call.
", + "ListKeywordsForDataSourceRequest$maxResults": "Represents the maximum number of results per page, or per API request call.
", + "ListNotificationsRequest$maxResults": "Represents the maximum number of results per page, or per API request call.
" + } + }, + "NonEmptyString": { + "base": null, + "refs": { + "AssessmentControlSet$description": "The description for the control set.
", + "ChangeLog$objectName": "The name of the changelog object.
", + "DelegationMetadata$controlSetName": "Specifies the name of the control set delegated for review.
", + "EvidenceSources$member": null, + "Notification$controlSetName": "Specifies the name of the control set that the notification is about.
", + "Notification$description": "The description of the notification.
", + "Notification$source": "The sender of the notification.
", + "ServiceMetadata$displayName": "The display name of the AWS service.
", + "ServiceMetadata$description": "The description of the specified AWS service.
", + "ServiceMetadata$category": "The category in which the AWS service belongs, such as compute, storage, database, and so on.
", + "ValidationErrors$member": null + } + }, + "Notification": { + "base": "The notification used to inform a user of an update in AWS Audit Manager. For example, this includes the notification that is sent when a control set is delegated for review.
", + "refs": { + "Notifications$member": null + } + }, + "Notifications": { + "base": null, + "refs": { + "ListNotificationsResponse$notifications": "The returned list of notifications.
" + } + }, + "ObjectTypeEnum": { + "base": null, + "refs": { + "ChangeLog$objectType": "The changelog object type, such as an assessment, control, or control set.
" + } + }, + "RegisterAccountRequest": { + "base": null, + "refs": { + } + }, + "RegisterAccountResponse": { + "base": null, + "refs": { + } + }, + "RegisterOrganizationAdminAccountRequest": { + "base": null, + "refs": { + } + }, + "RegisterOrganizationAdminAccountResponse": { + "base": null, + "refs": { + } + }, + "Resource": { + "base": "A system asset that is evaluated in an AWS Audit Manager assessment.
", + "refs": { + "Resources$member": null + } + }, + "ResourceNotFoundException": { + "base": "The resource specified in the request cannot be found.
", + "refs": { + } + }, + "Resources": { + "base": null, + "refs": { + "Evidence$resourcesIncluded": "The list of resources assessed to generate the evidence.
" + } + }, + "Role": { + "base": "The wrapper that contains AWS Audit Manager role information, such as the role type and IAM Amazon Resource Name (ARN).
", + "refs": { + "Roles$member": null + } + }, + "RoleType": { + "base": null, + "refs": { + "CreateDelegationRequest$roleType": "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.
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.
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.
The roles associated with the control set.
", + "AssessmentMetadata$roles": "The roles associated with the assessment.
", + "AssessmentMetadataItem$roles": "The roles associated with the assessment.
", + "CreateAssessmentRequest$roles": "The list of roles for the specified assessment.
", + "Settings$defaultProcessOwners": "The designated default audit owners.
", + "UpdateAssessmentRequest$roles": "The list of roles for the specified assessment.
", + "UpdateSettingsRequest$defaultProcessOwners": "A list of the default audit owners.
" + } + }, + "S3Url": { + "base": null, + "refs": { + "AssessmentReportsDestination$destination": "The destination of the assessment report.
", + "ManualEvidence$s3ResourcePath": "The Amazon S3 URL that points to a manual evidence object.
", + "ValidateAssessmentReportIntegrityRequest$s3RelativePath": "The relative path of the specified Amazon S3 bucket in which the assessment report is stored.
" + } + }, + "SNSTopic": { + "base": null, + "refs": { + "Settings$snsTopic": "The designated Amazon Simple Notification Service (Amazon SNS) topic.
" + } + }, + "Scope": { + "base": "The wrapper that contains the AWS accounts and AWS services in scope for the assessment.
", + "refs": { + "AssessmentMetadata$scope": "The wrapper of AWS accounts and services in scope for the assessment.
", + "CreateAssessmentRequest$scope": null, + "UpdateAssessmentRequest$scope": "The scope of the specified assessment.
" + } + }, + "ServiceMetadata": { + "base": "The metadata associated with the specified AWS service.
", + "refs": { + "ServiceMetadataList$member": null + } + }, + "ServiceMetadataList": { + "base": null, + "refs": { + "GetServicesInScopeResponse$serviceMetadata": "The metadata associated with the aAWS service.
" + } + }, + "SettingAttribute": { + "base": null, + "refs": { + "GetSettingsRequest$attribute": " The list of SettingAttribute enum values.
The settings object that holds all supported AWS Audit Manager settings.
", + "refs": { + "GetSettingsResponse$settings": "The settings object that holds all supported AWS Audit Manager settings.
", + "UpdateSettingsResponse$settings": "The current list of settings.
" + } + }, + "SnsArn": { + "base": null, + "refs": { + "UpdateSettingsRequest$snsTopic": "The Amazon Simple Notification Service (Amazon SNS) topic to which AWS Audit Manager sends notifications.
" + } + }, + "SourceDescription": { + "base": null, + "refs": { + "ControlMappingSource$sourceDescription": "The description of the specified source.
", + "CreateControlMappingSource$sourceDescription": "The description of the data source that determines from where AWS Audit Manager collects evidence for the control.
" + } + }, + "SourceFrequency": { + "base": null, + "refs": { + "ControlMappingSource$sourceFrequency": "The frequency of evidence collection for the specified control mapping source.
", + "CreateControlMappingSource$sourceFrequency": "The frequency of evidence collection for the specified control mapping source.
" + } + }, + "SourceKeyword": { + "base": "The keyword to search for in AWS CloudTrail logs.
", + "refs": { + "ControlMappingSource$sourceKeyword": null, + "CreateControlMappingSource$sourceKeyword": null + } + }, + "SourceName": { + "base": null, + "refs": { + "ControlMappingSource$sourceName": "The name of the specified source.
", + "CreateControlMappingSource$sourceName": "The name of the control mapping data source.
" + } + }, + "SourceSetUpOption": { + "base": null, + "refs": { + "ControlMappingSource$sourceSetUpOption": "The setup option for the data source, which reflects if the evidence collection is automated or manual.
", + "CreateControlMappingSource$sourceSetUpOption": "The setup option for the data source, which reflects if the evidence collection is automated or manual.
" + } + }, + "SourceType": { + "base": null, + "refs": { + "ControlMappingSource$sourceType": "Specifies one of the five types of data sources for evidence collection.
", + "CreateControlMappingSource$sourceType": "Specifies one of the five types of data sources for evidence collection.
", + "ListKeywordsForDataSourceRequest$source": "The control mapping data source to which the keywords apply.
" + } + }, + "String": { + "base": null, + "refs": { + "AccessDeniedException$message": null, + "AssessmentEvidenceFolder$dataSource": "The AWS service from which the evidence was collected.
", + "AssessmentEvidenceFolder$author": "The name of the user who created the evidence folder.
", + "Evidence$dataSource": "The data source from which the specified evidence was collected.
", + "Evidence$evidenceByType": "The type of automated evidence.
", + "Evidence$complianceCheck": "The evaluation status for evidence that falls under the compliance check category. For evidence collected from AWS Security Hub, a Pass or Fail result is shown. For evidence collected from AWS Config, a Compliant or Noncompliant result is shown.
", + "Evidence$awsOrganization": "The AWS account from which the evidence is collected, and its AWS organization path.
", + "Evidence$assessmentReportSelection": "Specifies whether the evidence is inclded in the assessment report.
", + "InternalServerException$message": null, + "Resource$value": "The value of the specified resource.
", + "ResourceNotFoundException$message": null, + "ResourceNotFoundException$resourceId": "The unique identifier for the specified resource.
", + "ResourceNotFoundException$resourceType": "The type of resource affected by the error.
", + "UpdateAssessmentControlSetStatusRequest$controlSetId": "The identifier for the specified control set.
", + "ValidateAssessmentReportIntegrityResponse$signatureAlgorithm": "The signature algorithm used to code sign the assessment report file.
", + "ValidateAssessmentReportIntegrityResponse$signatureDateTime": "The date and time signature that specifies when the assessment report was created.
", + "ValidateAssessmentReportIntegrityResponse$signatureKeyId": "The unique identifier for the validation signature key.
", + "ValidationException$message": null, + "ValidationExceptionField$name": "The name of the validation error.
", + "ValidationExceptionField$message": "The body of the error message.
" + } + }, + "TagKey": { + "base": null, + "refs": { + "TagKeyList$member": null, + "TagMap$key": null + } + }, + "TagKeyList": { + "base": null, + "refs": { + "UntagResourceRequest$tagKeys": "The name or key of the tag.
" + } + }, + "TagMap": { + "base": null, + "refs": { + "Assessment$tags": "The tags associated with the assessment.
", + "Control$tags": "The tags associated with the control.
", + "CreateAssessmentRequest$tags": "The tags associated with the assessment.
", + "CreateControlRequest$tags": "The tags associated with the control.
", + "ListTagsForResourceResponse$tags": " The list of tags returned by the ListTagsForResource API.
The tags to be associated with the resource.
" + } + }, + "TagResourceRequest": { + "base": null, + "refs": { + } + }, + "TagResourceResponse": { + "base": null, + "refs": { + } + }, + "TagValue": { + "base": null, + "refs": { + "TagMap$value": null + } + }, + "TestingInformation": { + "base": null, + "refs": { + "Control$testingInformation": "The steps to follow to determine if the control has been satisfied.
", + "CreateControlRequest$testingInformation": "The steps to follow to determine if the control has been satisfied.
", + "UpdateControlRequest$testingInformation": "The steps that to follow to determine if the control has been satisfied.
" + } + }, + "Timestamp": { + "base": null, + "refs": { + "AssessmentEvidenceFolder$date": "The date when the first evidence was added to the evidence folder.
", + "AssessmentFrameworkMetadata$createdAt": "Specifies when the framework was created.
", + "AssessmentFrameworkMetadata$lastUpdatedAt": "Specifies when the framework was most recently updated.
", + "AssessmentMetadata$creationTime": "Specifies when the assessment was created.
", + "AssessmentMetadata$lastUpdated": "The time of the most recent update.
", + "AssessmentMetadataItem$creationTime": "Specifies when the assessment was created.
", + "AssessmentMetadataItem$lastUpdated": "The time of the most recent update.
", + "AssessmentReport$creationTime": "Specifies when the assessment report was created.
", + "AssessmentReportMetadata$creationTime": "Specifies when the assessment report was created.
", + "ChangeLog$createdAt": "The time of creation for the changelog object.
", + "Control$createdAt": "Specifies when the control was created.
", + "Control$lastUpdatedAt": "Specifies when the control was most recently updated.
", + "ControlComment$postedDate": "The time when the comment was posted.
", + "ControlMetadata$createdAt": "Specifies when the control was created.
", + "ControlMetadata$lastUpdatedAt": "Specifies when the control was most recently updated.
", + "Delegation$creationTime": "Specifies when the delegation was created.
", + "Delegation$lastUpdated": "Specifies when the delegation was last updated.
", + "DelegationMetadata$creationTime": "Specifies when the delegation was created.
", + "Evidence$time": "The timestamp that represents when the evidence was collected.
", + "Framework$createdAt": "Specifies when the framework was created.
", + "Framework$lastUpdatedAt": "Specifies when the framework was most recently updated.
", + "Notification$eventTime": "The time when the notification was sent.
" + } + }, + "TimestampUUID": { + "base": null, + "refs": { + "Notification$id": "The unique identifier for the notification.
" + } + }, + "Token": { + "base": null, + "refs": { + "GetChangeLogsRequest$nextToken": "The pagination token used to fetch the next set of results.
", + "GetChangeLogsResponse$nextToken": "The pagination token used to fetch the next set of results.
", + "GetDelegationsRequest$nextToken": "The pagination token used to fetch the next set of results.
", + "GetDelegationsResponse$nextToken": "The pagination token used to fetch the next set of results.
", + "GetEvidenceByEvidenceFolderRequest$nextToken": "The pagination token used to fetch the next set of results.
", + "GetEvidenceByEvidenceFolderResponse$nextToken": "The pagination token used to fetch the next set of results.
", + "GetEvidenceFoldersByAssessmentControlRequest$nextToken": "The pagination token used to fetch the next set of results.
", + "GetEvidenceFoldersByAssessmentControlResponse$nextToken": "The pagination token used to fetch the next set of results.
", + "GetEvidenceFoldersByAssessmentRequest$nextToken": "The pagination token used to fetch the next set of results.
", + "GetEvidenceFoldersByAssessmentResponse$nextToken": "The pagination token used to fetch the next set of results.
", + "ListAssessmentFrameworksRequest$nextToken": "The pagination token used to fetch the next set of results.
", + "ListAssessmentFrameworksResponse$nextToken": "The pagination token used to fetch the next set of results.
", + "ListAssessmentReportsRequest$nextToken": "The pagination token used to fetch the next set of results.
", + "ListAssessmentReportsResponse$nextToken": "The pagination token used to fetch the next set of results.
", + "ListAssessmentsRequest$nextToken": "The pagination token used to fetch the next set of results.
", + "ListAssessmentsResponse$nextToken": "The pagination token used to fetch the next set of results.
", + "ListControlsRequest$nextToken": "The pagination token used to fetch the next set of results.
", + "ListControlsResponse$nextToken": "The pagination token used to fetch the next set of results.
", + "ListKeywordsForDataSourceRequest$nextToken": "The pagination token used to fetch the next set of results.
", + "ListKeywordsForDataSourceResponse$nextToken": "The pagination token used to fetch the next set of results.
", + "ListNotificationsRequest$nextToken": "The pagination token used to fetch the next set of results.
", + "ListNotificationsResponse$nextToken": "The pagination token used to fetch the next set of results.
" + } + }, + "TroubleshootingText": { + "base": null, + "refs": { + "ControlMappingSource$troubleshootingText": "The instructions for troubleshooting the specified control.
", + "CreateControlMappingSource$troubleshootingText": "The instructions for troubleshooting the specified control.
" + } + }, + "URL": { + "base": "A uniform resource locator, used as a unique identifier to locate a resource on the internet.
", + "refs": { + "GetAssessmentReportUrlResponse$preSignedUrl": null + } + }, + "UUID": { + "base": null, + "refs": { + "AssessmentControl$id": "The identifier for the specified control.
", + "AssessmentEvidenceFolder$assessmentId": "The identifier for the specified assessment.
", + "AssessmentEvidenceFolder$controlId": "The unique identifier for the specified control.
", + "AssessmentEvidenceFolder$id": "The identifier for the folder in which evidence is stored.
", + "AssessmentFramework$id": "The unique identifier for the framework.
", + "AssessmentFrameworkMetadata$id": "The unique identified for the specified framework.
", + "AssessmentMetadata$id": "The unique identifier for the assessment.
", + "AssessmentMetadataItem$id": "The unique identifier for the assessment.
", + "AssessmentReport$id": "The unique identifier for the specified assessment report.
", + "AssessmentReport$assessmentId": "The identifier for the specified assessment.
", + "AssessmentReportEvidenceError$evidenceId": "The identifier for the evidence.
", + "AssessmentReportMetadata$id": "The unique identifier for the assessment report.
", + "AssessmentReportMetadata$assessmentId": "The unique identifier for the associated assessment.
", + "AssociateAssessmentReportEvidenceFolderRequest$assessmentId": "The identifier for the specified assessment.
", + "AssociateAssessmentReportEvidenceFolderRequest$evidenceFolderId": "The identifier for the folder in which evidence is stored.
", + "BatchAssociateAssessmentReportEvidenceRequest$assessmentId": "The unique identifier for the specified assessment.
", + "BatchAssociateAssessmentReportEvidenceRequest$evidenceFolderId": "The identifier for the folder in which the evidence is stored.
", + "BatchCreateDelegationByAssessmentRequest$assessmentId": "The identifier for the specified assessment.
", + "BatchDeleteDelegationByAssessmentError$delegationId": "The identifier for the specified delegation.
", + "BatchDeleteDelegationByAssessmentRequest$assessmentId": "The identifier for the specified assessment.
", + "BatchDisassociateAssessmentReportEvidenceRequest$assessmentId": "The identifier for the specified assessment.
", + "BatchDisassociateAssessmentReportEvidenceRequest$evidenceFolderId": "The identifier for the folder in which evidence is stored.
", + "BatchImportEvidenceToAssessmentControlRequest$assessmentId": "The identifier for the specified assessment.
", + "BatchImportEvidenceToAssessmentControlRequest$controlId": "The identifier for the specified control.
", + "Control$id": "The unique identifier for the control.
", + "ControlMappingSource$sourceId": "The unique identifier for the specified source.
", + "ControlMetadata$id": "The unique identifier for the specified control.
", + "ControlSet$id": "The identifier of the control set in the assessment. This is the control set name in a plain string format.
", + "CreateAssessmentFrameworkControl$id": "The unique identifier of the control.
", + "CreateAssessmentReportRequest$assessmentId": "The identifier for the specified assessment.
", + "CreateAssessmentRequest$frameworkId": "The identifier for the specified framework.
", + "Delegation$id": "The unique identifier for the delegation.
", + "Delegation$assessmentId": "The identifier for the associated assessment.
", + "DelegationIds$member": null, + "DelegationMetadata$id": "The unique identifier for the delegation.
", + "DelegationMetadata$assessmentId": "The unique identifier for the specified assessment.
", + "DeleteAssessmentFrameworkRequest$frameworkId": "The identifier for the specified framework.
", + "DeleteAssessmentReportRequest$assessmentId": "The identifier for the specified assessment.
", + "DeleteAssessmentReportRequest$assessmentReportId": "The unique identifier for the assessment report.
", + "DeleteAssessmentRequest$assessmentId": "The identifier for the specified assessment.
", + "DeleteControlRequest$controlId": "The identifier for the specified control.
", + "DisassociateAssessmentReportEvidenceFolderRequest$assessmentId": "The identifier for the specified assessment.
", + "DisassociateAssessmentReportEvidenceFolderRequest$evidenceFolderId": "The identifier for the folder in which evidence is stored.
", + "Evidence$evidenceFolderId": "The identifier for the folder in which the evidence is stored.
", + "Evidence$id": "The identifier for the evidence.
", + "EvidenceIds$member": null, + "Framework$id": "The unique identifier for the specified framework.
", + "GetAssessmentFrameworkRequest$frameworkId": "The identifier for the specified framework.
", + "GetAssessmentReportUrlRequest$assessmentReportId": "The identifier for the assessment report.
", + "GetAssessmentReportUrlRequest$assessmentId": "The identifier for the specified assessment.
", + "GetAssessmentRequest$assessmentId": "The identifier for the specified assessment.
", + "GetChangeLogsRequest$assessmentId": "The identifier for the specified assessment.
", + "GetChangeLogsRequest$controlId": "The identifier for the specified control.
", + "GetControlRequest$controlId": "The identifier for the specified control.
", + "GetEvidenceByEvidenceFolderRequest$assessmentId": "The identifier for the specified assessment.
", + "GetEvidenceByEvidenceFolderRequest$evidenceFolderId": "The unique identifier for the folder in which the evidence is stored.
", + "GetEvidenceFolderRequest$assessmentId": "The identifier for the specified assessment.
", + "GetEvidenceFolderRequest$evidenceFolderId": "The identifier for the folder in which the evidence is stored.
", + "GetEvidenceFoldersByAssessmentControlRequest$assessmentId": "The identifier for the specified assessment.
", + "GetEvidenceFoldersByAssessmentControlRequest$controlId": "The identifier for the specified control.
", + "GetEvidenceFoldersByAssessmentRequest$assessmentId": "The identifier for the specified assessment.
", + "GetEvidenceRequest$assessmentId": "The identifier for the specified assessment.
", + "GetEvidenceRequest$evidenceFolderId": "The identifier for the folder in which the evidence is stored.
", + "GetEvidenceRequest$evidenceId": "The identifier for the evidence.
", + "Notification$assessmentId": "The identifier for the specified assessment.
", + "UpdateAssessmentControlRequest$assessmentId": "The identifier for the specified assessment.
", + "UpdateAssessmentControlRequest$controlId": "The identifier for the specified control.
", + "UpdateAssessmentControlSetStatusRequest$assessmentId": "The identifier for the specified assessment.
", + "UpdateAssessmentFrameworkControlSet$id": "The unique identifier for the control set.
", + "UpdateAssessmentFrameworkRequest$frameworkId": "The identifier for the specified framework.
", + "UpdateAssessmentRequest$assessmentId": "The identifier for the specified assessment.
", + "UpdateAssessmentStatusRequest$assessmentId": "The identifier for the specified assessment.
", + "UpdateControlRequest$controlId": "The identifier for the specified control.
" + } + }, + "UntagResourceRequest": { + "base": null, + "refs": { + } + }, + "UntagResourceResponse": { + "base": null, + "refs": { + } + }, + "UpdateAssessmentControlRequest": { + "base": null, + "refs": { + } + }, + "UpdateAssessmentControlResponse": { + "base": null, + "refs": { + } + }, + "UpdateAssessmentControlSetStatusRequest": { + "base": null, + "refs": { + } + }, + "UpdateAssessmentControlSetStatusResponse": { + "base": null, + "refs": { + } + }, + "UpdateAssessmentFrameworkControlSet": { + "base": " A controlSet entity that represents a collection of controls in AWS Audit Manager. This does not contain the control set ID.
The control sets associated with the framework.
" + } + }, + "UpdateAssessmentFrameworkRequest": { + "base": null, + "refs": { + } + }, + "UpdateAssessmentFrameworkResponse": { + "base": null, + "refs": { + } + }, + "UpdateAssessmentRequest": { + "base": null, + "refs": { + } + }, + "UpdateAssessmentResponse": { + "base": null, + "refs": { + } + }, + "UpdateAssessmentStatusRequest": { + "base": null, + "refs": { + } + }, + "UpdateAssessmentStatusResponse": { + "base": null, + "refs": { + } + }, + "UpdateControlRequest": { + "base": null, + "refs": { + } + }, + "UpdateControlResponse": { + "base": null, + "refs": { + } + }, + "UpdateSettingsRequest": { + "base": null, + "refs": { + } + }, + "UpdateSettingsResponse": { + "base": null, + "refs": { + } + }, + "UrlLink": { + "base": null, + "refs": { + "URL$link": "The unique identifier for the internet resource.
" + } + }, + "Username": { + "base": null, + "refs": { + "AssessmentReport$author": "The name of the user who created the assessment report.
", + "AssessmentReportMetadata$author": "The name of the user who created the assessment report.
", + "ControlComment$authorName": "The name of the user who authored the comment.
" + } + }, + "ValidateAssessmentReportIntegrityRequest": { + "base": null, + "refs": { + } + }, + "ValidateAssessmentReportIntegrityResponse": { + "base": null, + "refs": { + } + }, + "ValidationErrors": { + "base": null, + "refs": { + "ValidateAssessmentReportIntegrityResponse$validationErrors": "Represents any errors that occurred when validating the assessment report.
" + } + }, + "ValidationException": { + "base": "The request has invalid or missing parameters.
", + "refs": { + } + }, + "ValidationExceptionField": { + "base": "Indicates that the request has invalid or missing parameters for the specified field.
", + "refs": { + "ValidationExceptionFieldList$member": null + } + }, + "ValidationExceptionFieldList": { + "base": null, + "refs": { + "ValidationException$fields": "The fields that caused the error, if applicable.
" + } + }, + "ValidationExceptionReason": { + "base": null, + "refs": { + "ValidationException$reason": "The reason the request failed validation.
" + } + }, + "organizationId": { + "base": null, + "refs": { + "GetOrganizationAdminAccountResponse$organizationId": "The identifier for the specified organization.
", + "RegisterOrganizationAdminAccountResponse$organizationId": "The identifier for the specified AWS organization.
" + } + } + } +} diff --git a/models/apis/auditmanager/2017-07-25/examples-1.json b/models/apis/auditmanager/2017-07-25/examples-1.json new file mode 100644 index 00000000000..0ea7e3b0bbe --- /dev/null +++ b/models/apis/auditmanager/2017-07-25/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/models/apis/auditmanager/2017-07-25/paginators-1.json b/models/apis/auditmanager/2017-07-25/paginators-1.json new file mode 100644 index 00000000000..33fc6b66d95 --- /dev/null +++ b/models/apis/auditmanager/2017-07-25/paginators-1.json @@ -0,0 +1,59 @@ +{ + "pagination": { + "GetChangeLogs": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults" + }, + "GetDelegations": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults" + }, + "GetEvidenceByEvidenceFolder": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults" + }, + "GetEvidenceFoldersByAssessment": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults" + }, + "GetEvidenceFoldersByAssessmentControl": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults" + }, + "ListAssessmentFrameworks": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults" + }, + "ListAssessmentReports": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults" + }, + "ListAssessments": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults" + }, + "ListControls": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults" + }, + "ListKeywordsForDataSource": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults" + }, + "ListNotifications": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults" + } + } +} diff --git a/models/apis/ecr/2015-09-21/api-2.json b/models/apis/ecr/2015-09-21/api-2.json index f39c59a2d83..c9a509eab2e 100644 --- a/models/apis/ecr/2015-09-21/api-2.json +++ b/models/apis/ecr/2015-09-21/api-2.json @@ -109,6 +109,20 @@ {"shape":"LifecyclePolicyNotFoundException"} ] }, + "DeleteRegistryPolicy":{ + "name":"DeleteRegistryPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteRegistryPolicyRequest"}, + "output":{"shape":"DeleteRegistryPolicyResponse"}, + "errors":[ + {"shape":"ServerException"}, + {"shape":"InvalidParameterException"}, + {"shape":"RegistryPolicyNotFoundException"} + ] + }, "DeleteRepository":{ "name":"DeleteRepository", "http":{ @@ -171,6 +185,20 @@ {"shape":"ImageNotFoundException"} ] }, + "DescribeRegistry":{ + "name":"DescribeRegistry", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeRegistryRequest"}, + "output":{"shape":"DescribeRegistryResponse"}, + "errors":[ + {"shape":"ServerException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ValidationException"} + ] + }, "DescribeRepositories":{ "name":"DescribeRepositories", "http":{ @@ -244,6 +272,20 @@ {"shape":"LifecyclePolicyPreviewNotFoundException"} ] }, + "GetRegistryPolicy":{ + "name":"GetRegistryPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetRegistryPolicyRequest"}, + "output":{"shape":"GetRegistryPolicyResponse"}, + "errors":[ + {"shape":"ServerException"}, + {"shape":"InvalidParameterException"}, + {"shape":"RegistryPolicyNotFoundException"} + ] + }, "GetRepositoryPolicy":{ "name":"GetRepositoryPolicy", "http":{ @@ -365,6 +407,33 @@ {"shape":"RepositoryNotFoundException"} ] }, + "PutRegistryPolicy":{ + "name":"PutRegistryPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutRegistryPolicyRequest"}, + "output":{"shape":"PutRegistryPolicyResponse"}, + "errors":[ + {"shape":"ServerException"}, + {"shape":"InvalidParameterException"} + ] + }, + "PutReplicationConfiguration":{ + "name":"PutReplicationConfiguration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutReplicationConfigurationRequest"}, + "output":{"shape":"PutReplicationConfigurationResponse"}, + "errors":[ + {"shape":"ServerException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ValidationException"} + ] + }, "SetRepositoryPolicy":{ "name":"SetRepositoryPolicy", "http":{ @@ -632,6 +701,18 @@ "lastEvaluatedAt":{"shape":"EvaluationTimestamp"} } }, + "DeleteRegistryPolicyRequest":{ + "type":"structure", + "members":{ + } + }, + "DeleteRegistryPolicyResponse":{ + "type":"structure", + "members":{ + "registryId":{"shape":"RegistryId"}, + "policyText":{"shape":"RegistryPolicyText"} + } + }, "DeleteRepositoryPolicyRequest":{ "type":"structure", "required":["repositoryName"], @@ -713,6 +794,18 @@ "nextToken":{"shape":"NextToken"} } }, + "DescribeRegistryRequest":{ + "type":"structure", + "members":{ + } + }, + "DescribeRegistryResponse":{ + "type":"structure", + "members":{ + "registryId":{"shape":"RegistryId"}, + "replicationConfiguration":{"shape":"ReplicationConfiguration"} + } + }, "DescribeRepositoriesRequest":{ "type":"structure", "members":{ @@ -782,7 +875,11 @@ "GetAuthorizationTokenRequest":{ "type":"structure", "members":{ - "registryIds":{"shape":"GetAuthorizationTokenRegistryIdList"} + "registryIds":{ + "shape":"GetAuthorizationTokenRegistryIdList", + "deprecated":true, + "deprecatedMessage":"This field is deprecated. The returned authorization token can be used to access any Amazon ECR registry that the IAM principal has access to, specifying a registry ID doesn't change the permissions scope of the authorization token." + } } }, "GetAuthorizationTokenResponse":{ @@ -851,6 +948,18 @@ "lastEvaluatedAt":{"shape":"EvaluationTimestamp"} } }, + "GetRegistryPolicyRequest":{ + "type":"structure", + "members":{ + } + }, + "GetRegistryPolicyResponse":{ + "type":"structure", + "members":{ + "registryId":{"shape":"RegistryId"}, + "policyText":{"shape":"RegistryPolicyText"} + } + }, "GetRepositoryPolicyRequest":{ "type":"structure", "required":["repositoryName"], @@ -1406,6 +1515,33 @@ "lifecyclePolicyText":{"shape":"LifecyclePolicyText"} } }, + "PutRegistryPolicyRequest":{ + "type":"structure", + "required":["policyText"], + "members":{ + "policyText":{"shape":"RegistryPolicyText"} + } + }, + "PutRegistryPolicyResponse":{ + "type":"structure", + "members":{ + "registryId":{"shape":"RegistryId"}, + "policyText":{"shape":"RegistryPolicyText"} + } + }, + "PutReplicationConfigurationRequest":{ + "type":"structure", + "required":["replicationConfiguration"], + "members":{ + "replicationConfiguration":{"shape":"ReplicationConfiguration"} + } + }, + "PutReplicationConfigurationResponse":{ + "type":"structure", + "members":{ + "replicationConfiguration":{"shape":"ReplicationConfiguration"} + } + }, "ReferencedImagesNotFoundException":{ "type":"structure", "members":{ @@ -1413,10 +1549,65 @@ }, "exception":true }, + "Region":{ + "type":"string", + "max":25, + "min":2, + "pattern":"[0-9a-z-]{2,25}" + }, "RegistryId":{ "type":"string", "pattern":"[0-9]{12}" }, + "RegistryPolicyNotFoundException":{ + "type":"structure", + "members":{ + "message":{"shape":"ExceptionMessage"} + }, + "exception":true + }, + "RegistryPolicyText":{ + "type":"string", + "max":10240, + "min":0 + }, + "ReplicationConfiguration":{ + "type":"structure", + "required":["rules"], + "members":{ + "rules":{"shape":"ReplicationRuleList"} + } + }, + "ReplicationDestination":{ + "type":"structure", + "required":[ + "region", + "registryId" + ], + "members":{ + "region":{"shape":"Region"}, + "registryId":{"shape":"RegistryId"} + } + }, + "ReplicationDestinationList":{ + "type":"list", + "member":{"shape":"ReplicationDestination"}, + "max":25, + "min":0 + }, + "ReplicationRule":{ + "type":"structure", + "required":["destinations"], + "members":{ + "destinations":{"shape":"ReplicationDestinationList"} + } + }, + "ReplicationRuleList":{ + "type":"list", + "member":{"shape":"ReplicationRule"}, + "max":1, + "min":0 + }, "Repository":{ "type":"structure", "members":{ @@ -1679,6 +1870,13 @@ "exception":true }, "Url":{"type":"string"}, + "ValidationException":{ + "type":"structure", + "members":{ + "message":{"shape":"ExceptionMessage"} + }, + "exception":true + }, "VulnerabilitySourceUpdateTimestamp":{"type":"timestamp"} } } diff --git a/models/apis/ecr/2015-09-21/docs-2.json b/models/apis/ecr/2015-09-21/docs-2.json index 83395037bbe..f258f1ae199 100644 --- a/models/apis/ecr/2015-09-21/docs-2.json +++ b/models/apis/ecr/2015-09-21/docs-2.json @@ -8,15 +8,18 @@ "CompleteLayerUpload": "Informs Amazon ECR that the image layer upload has completed for a specified registry, repository name, and upload ID. You can optionally provide a sha256 digest of the image layer for data validation purposes.
When an image is pushed, the CompleteLayerUpload API is called once per each new image layer to verify that the upload has completed.
This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.
Creates a repository. For more information, see Amazon ECR Repositories in the Amazon Elastic Container Registry User Guide.
", "DeleteLifecyclePolicy": "Deletes the lifecycle policy associated with the specified repository.
", + "DeleteRegistryPolicy": "Deletes the registry permissions policy.
", "DeleteRepository": "Deletes a repository. If the repository contains images, you must either delete all images in the repository or use the force option to delete the repository.
Deletes the repository policy associated with the specified repository.
", "DescribeImageScanFindings": "Returns the scan findings for the specified image.
", "DescribeImages": "Returns metadata about the images in a repository.
Beginning with Docker version 1.9, the Docker client compresses image layers before pushing them to a V2 Docker registry. The output of the docker images command shows the uncompressed image size, so it may return a larger image size than the image sizes returned by DescribeImages.
Describes the settings for a registry. The replication configuration for a repository can be created or updated with the PutReplicationConfiguration API action.
", "DescribeRepositories": "Describes image repositories in a registry.
", "GetAuthorizationToken": "Retrieves an authorization token. An authorization token represents your IAM authentication credentials and can be used to access any Amazon ECR registry that your IAM principal has access to. The authorization token is valid for 12 hours.
The authorizationToken returned is a base64 encoded string that can be decoded and used in a docker login command to authenticate to a registry. The AWS CLI offers an get-login-password command that simplifies the login process. For more information, see Registry Authentication in the Amazon Elastic Container Registry User Guide.
Retrieves the pre-signed Amazon S3 download URL corresponding to an image layer. You can only get URLs for image layers that are referenced in an image.
When an image is pulled, the GetDownloadUrlForLayer API is called once per image layer that is not already cached.
This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.
Retrieves the lifecycle policy for the specified repository.
", "GetLifecyclePolicyPreview": "Retrieves the results of the lifecycle policy preview request for the specified repository.
", + "GetRegistryPolicy": "Retrieves the permissions policy for a registry.
", "GetRepositoryPolicy": "Retrieves the repository policy for the specified repository.
", "InitiateLayerUpload": "Notifies Amazon ECR that you intend to upload an image layer.
When an image is pushed, the InitiateLayerUpload API is called once per image layer that has not already been uploaded. Whether or not an image layer has been uploaded is determined by the BatchCheckLayerAvailability API action.
This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.
Lists all the image IDs for the specified repository.
You can filter images based on whether or not they are tagged by using the tagStatus filter and specifying either TAGGED, UNTAGGED or ANY. For example, you can filter your results to return only UNTAGGED images and then pipe that result to a BatchDeleteImage operation to delete them. Or, you can filter your results to return only TAGGED images to list all of the tags in your repository.
Updates the image scanning configuration for the specified repository.
", "PutImageTagMutability": "Updates the image tag mutability settings for the specified repository. For more information, see Image Tag Mutability in the Amazon Elastic Container Registry User Guide.
", "PutLifecyclePolicy": "Creates or updates the lifecycle policy for the specified repository. For more information, see Lifecycle Policy Template.
", + "PutRegistryPolicy": "Creates or updates the permissions policy for your registry.
A registry policy is used to specify permissions for another AWS account and is used when configuring cross-account replication. For more information, see Registry permissions in the Amazon Elastic Container Registry User Guide.
", + "PutReplicationConfiguration": "Creates or updates the replication configuration for a registry. The existing replication configuration for a repository can be retrieved with the DescribeRegistry API action. The first time the PutReplicationConfiguration API is called, a service-linked IAM role is created in your account for the replication process. For more information, see Using Service-Linked Roles for Amazon ECR in the Amazon Elastic Container Registry User Guide.
When configuring cross-account replication, the destination account must grant the source account permission to replicate. This permission is controlled using a registry permissions policy. For more information, see PutRegistryPolicy.
Applies a repository policy to the specified repository to control access permissions. For more information, see Amazon ECR Repository Policies in the Amazon Elastic Container Registry User Guide.
", "StartImageScan": "Starts an image vulnerability scan. An image scan can only be started once per day on an individual image. This limit includes if an image was scanned on initial push. For more information, see Image Scanning in the Amazon Elastic Container Registry User Guide.
", "StartLifecyclePolicyPreview": "Starts a preview of a lifecycle policy for the specified repository. This allows you to see the results before associating the lifecycle policy with the repository.
", @@ -163,6 +168,16 @@ "refs": { } }, + "DeleteRegistryPolicyRequest": { + "base": null, + "refs": { + } + }, + "DeleteRegistryPolicyResponse": { + "base": null, + "refs": { + } + }, "DeleteRepositoryPolicyRequest": { "base": null, "refs": { @@ -209,6 +224,16 @@ "refs": { } }, + "DescribeRegistryRequest": { + "base": null, + "refs": { + } + }, + "DescribeRegistryResponse": { + "base": null, + "refs": { + } + }, "DescribeRepositoriesRequest": { "base": null, "refs": { @@ -266,6 +291,7 @@ "LifecyclePolicyPreviewNotFoundException$message": null, "LimitExceededException$message": "The error message associated with the exception.
", "ReferencedImagesNotFoundException$message": null, + "RegistryPolicyNotFoundException$message": null, "RepositoryAlreadyExistsException$message": "The error message associated with the exception.
", "RepositoryNotEmptyException$message": "The error message associated with the exception.
", "RepositoryNotFoundException$message": "The error message associated with the exception.
", @@ -274,7 +300,8 @@ "ServerException$message": "The error message associated with the exception.
", "TooManyTagsException$message": null, "UnsupportedImageTypeException$message": null, - "UploadNotFoundException$message": "The error message associated with the exception.
" + "UploadNotFoundException$message": "The error message associated with the exception.
", + "ValidationException$message": null } }, "ExpirationTimestamp": { @@ -362,6 +389,16 @@ "refs": { } }, + "GetRegistryPolicyRequest": { + "base": null, + "refs": { + } + }, + "GetRegistryPolicyResponse": { + "base": null, + "refs": { + } + }, "GetRepositoryPolicyRequest": { "base": null, "refs": { @@ -912,11 +949,37 @@ "refs": { } }, + "PutRegistryPolicyRequest": { + "base": null, + "refs": { + } + }, + "PutRegistryPolicyResponse": { + "base": null, + "refs": { + } + }, + "PutReplicationConfigurationRequest": { + "base": null, + "refs": { + } + }, + "PutReplicationConfigurationResponse": { + "base": null, + "refs": { + } + }, "ReferencedImagesNotFoundException": { "base": "The manifest list is referencing an image that does not exist.
", "refs": { } }, + "Region": { + "base": null, + "refs": { + "ReplicationDestination$region": "A Region to replicate to.
" + } + }, "RegistryId": { "base": null, "refs": { @@ -927,12 +990,14 @@ "CompleteLayerUploadResponse$registryId": "The registry ID associated with the request.
", "DeleteLifecyclePolicyRequest$registryId": "The AWS account ID associated with the registry that contains the repository. If you do not specify a registry, the default registry is assumed.
", "DeleteLifecyclePolicyResponse$registryId": "The registry ID associated with the request.
", + "DeleteRegistryPolicyResponse$registryId": "The registry ID associated with the request.
", "DeleteRepositoryPolicyRequest$registryId": "The AWS account ID associated with the registry that contains the repository policy to delete. If you do not specify a registry, the default registry is assumed.
", "DeleteRepositoryPolicyResponse$registryId": "The registry ID associated with the request.
", "DeleteRepositoryRequest$registryId": "The AWS account ID associated with the registry that contains the repository to delete. If you do not specify a registry, the default registry is assumed.
", "DescribeImageScanFindingsRequest$registryId": "The AWS account ID associated with the registry that contains the repository in which to describe the image scan findings for. If you do not specify a registry, the default registry is assumed.
", "DescribeImageScanFindingsResponse$registryId": "The registry ID associated with the request.
", "DescribeImagesRequest$registryId": "The AWS account ID associated with the registry that contains the repository in which to describe images. If you do not specify a registry, the default registry is assumed.
", + "DescribeRegistryResponse$registryId": "The ID of the registry.
", "DescribeRepositoriesRequest$registryId": "The AWS account ID associated with the registry that contains the repositories to be described. If you do not specify a registry, the default registry is assumed.
", "GetAuthorizationTokenRegistryIdList$member": null, "GetDownloadUrlForLayerRequest$registryId": "The AWS account ID associated with the registry that contains the image layer to download. If you do not specify a registry, the default registry is assumed.
", @@ -940,6 +1005,7 @@ "GetLifecyclePolicyPreviewResponse$registryId": "The registry ID associated with the request.
", "GetLifecyclePolicyRequest$registryId": "The AWS account ID associated with the registry that contains the repository. If you do not specify a registry, the default registry is assumed.
", "GetLifecyclePolicyResponse$registryId": "The registry ID associated with the request.
", + "GetRegistryPolicyResponse$registryId": "The ID of the registry.
", "GetRepositoryPolicyRequest$registryId": "The AWS account ID associated with the registry that contains the repository. If you do not specify a registry, the default registry is assumed.
", "GetRepositoryPolicyResponse$registryId": "The registry ID associated with the request.
", "Image$registryId": "The AWS account ID associated with the registry containing the image.
", @@ -954,6 +1020,8 @@ "PutImageTagMutabilityResponse$registryId": "The registry ID associated with the request.
", "PutLifecyclePolicyRequest$registryId": "The AWS account ID associated with the registry that contains the repository. If you do not specify a registry, the default registry is assumed.
", "PutLifecyclePolicyResponse$registryId": "The registry ID associated with the request.
", + "PutRegistryPolicyResponse$registryId": "The registry ID.
", + "ReplicationDestination$registryId": "The account ID of the destination registry to replicate to.
", "Repository$registryId": "The AWS account ID associated with the registry that contains the repository.
", "SetRepositoryPolicyRequest$registryId": "The AWS account ID associated with the registry that contains the repository. If you do not specify a registry, the default registry is assumed.
", "SetRepositoryPolicyResponse$registryId": "The registry ID associated with the request.
", @@ -965,6 +1033,52 @@ "UploadLayerPartResponse$registryId": "The registry ID associated with the request.
" } }, + "RegistryPolicyNotFoundException": { + "base": "The registry doesn't have an associated registry policy.
", + "refs": { + } + }, + "RegistryPolicyText": { + "base": null, + "refs": { + "DeleteRegistryPolicyResponse$policyText": "The contents of the registry permissions policy that was deleted.
", + "GetRegistryPolicyResponse$policyText": "The JSON text of the permissions policy for a registry.
", + "PutRegistryPolicyRequest$policyText": "The JSON policy text to apply to your registry. The policy text follows the same format as IAM policy text. For more information, see Registry permissions in the Amazon Elastic Container Registry User Guide.
", + "PutRegistryPolicyResponse$policyText": "The JSON policy text for your registry.
" + } + }, + "ReplicationConfiguration": { + "base": "The replication configuration for a registry.
", + "refs": { + "DescribeRegistryResponse$replicationConfiguration": "The replication configuration for the registry.
", + "PutReplicationConfigurationRequest$replicationConfiguration": "An object representing the replication configuration for a registry.
", + "PutReplicationConfigurationResponse$replicationConfiguration": "The contents of the replication configuration for the registry.
" + } + }, + "ReplicationDestination": { + "base": "An array of objects representing the details of a replication destination.
", + "refs": { + "ReplicationDestinationList$member": null + } + }, + "ReplicationDestinationList": { + "base": null, + "refs": { + "ReplicationRule$destinations": "An array of objects representing the details of a replication destination.
" + } + }, + "ReplicationRule": { + "base": "An array of objects representing the replication destinations for a replication configuration. A replication configuration may contain only one replication rule but the rule may contain one or more replication destinations.
", + "refs": { + "ReplicationRuleList$member": null + } + }, + "ReplicationRuleList": { + "base": null, + "refs": { + "ReplicationConfiguration$rules": "An array of objects representing the replication rules for a replication configuration. A replication configuration may contain only one replication rule but the rule may contain one or more replication destinations.
" + } + }, "Repository": { "base": "An object representing a repository.
", "refs": { @@ -1238,6 +1352,11 @@ "Repository$repositoryUri": "The URI for the repository. You can use this URI for container image push and pull operations.
There was an exception validating this request.
", + "refs": { + } + }, "VulnerabilitySourceUpdateTimestamp": { "base": null, "refs": { diff --git a/models/apis/emr-containers/2020-10-01/api-2.json b/models/apis/emr-containers/2020-10-01/api-2.json new file mode 100644 index 00000000000..836ace7cc2f --- /dev/null +++ b/models/apis/emr-containers/2020-10-01/api-2.json @@ -0,0 +1,1071 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2020-10-01", + "endpointPrefix":"emr-containers", + "jsonVersion":"1.1", + "protocol":"rest-json", + "serviceFullName":"Amazon EMR Containers", + "serviceId":"EMR containers", + "signatureVersion":"v4", + "signingName":"emr-containers", + "uid":"emr-containers-2020-10-01" + }, + "operations":{ + "CancelJobRun":{ + "name":"CancelJobRun", + "http":{ + "method":"DELETE", + "requestUri":"/virtualclusters/{virtualClusterId}/jobruns/{jobRunId}" + }, + "input":{"shape":"CancelJobRunRequest"}, + "output":{"shape":"CancelJobRunResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ] + }, + "CreateManagedEndpoint":{ + "name":"CreateManagedEndpoint", + "http":{ + "method":"POST", + "requestUri":"/virtualclusters/{virtualClusterId}/endpoints" + }, + "input":{"shape":"CreateManagedEndpointRequest"}, + "output":{"shape":"CreateManagedEndpointResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"} + ] + }, + "CreateVirtualCluster":{ + "name":"CreateVirtualCluster", + "http":{ + "method":"POST", + "requestUri":"/virtualclusters" + }, + "input":{"shape":"CreateVirtualClusterRequest"}, + "output":{"shape":"CreateVirtualClusterResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"} + ] + }, + "DeleteManagedEndpoint":{ + "name":"DeleteManagedEndpoint", + "http":{ + "method":"DELETE", + "requestUri":"/virtualclusters/{virtualClusterId}/endpoints/{endpointId}" + }, + "input":{"shape":"DeleteManagedEndpointRequest"}, + "output":{"shape":"DeleteManagedEndpointResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ] + }, + "DeleteVirtualCluster":{ + "name":"DeleteVirtualCluster", + "http":{ + "method":"DELETE", + "requestUri":"/virtualclusters/{virtualClusterId}" + }, + "input":{"shape":"DeleteVirtualClusterRequest"}, + "output":{"shape":"DeleteVirtualClusterResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ] + }, + "DescribeJobRun":{ + "name":"DescribeJobRun", + "http":{ + "method":"GET", + "requestUri":"/virtualclusters/{virtualClusterId}/jobruns/{jobRunId}" + }, + "input":{"shape":"DescribeJobRunRequest"}, + "output":{"shape":"DescribeJobRunResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"} + ] + }, + "DescribeManagedEndpoint":{ + "name":"DescribeManagedEndpoint", + "http":{ + "method":"GET", + "requestUri":"/virtualclusters/{virtualClusterId}/endpoints/{endpointId}" + }, + "input":{"shape":"DescribeManagedEndpointRequest"}, + "output":{"shape":"DescribeManagedEndpointResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"} + ] + }, + "DescribeVirtualCluster":{ + "name":"DescribeVirtualCluster", + "http":{ + "method":"GET", + "requestUri":"/virtualclusters/{virtualClusterId}" + }, + "input":{"shape":"DescribeVirtualClusterRequest"}, + "output":{"shape":"DescribeVirtualClusterResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"} + ] + }, + "ListJobRuns":{ + "name":"ListJobRuns", + "http":{ + "method":"GET", + "requestUri":"/virtualclusters/{virtualClusterId}/jobruns" + }, + "input":{"shape":"ListJobRunsRequest"}, + "output":{"shape":"ListJobRunsResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ] + }, + "ListManagedEndpoints":{ + "name":"ListManagedEndpoints", + "http":{ + "method":"GET", + "requestUri":"/virtualclusters/{virtualClusterId}/endpoints" + }, + "input":{"shape":"ListManagedEndpointsRequest"}, + "output":{"shape":"ListManagedEndpointsResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ] + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"GET", + "requestUri":"/tags/{resourceArn}" + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "ListVirtualClusters":{ + "name":"ListVirtualClusters", + "http":{ + "method":"GET", + "requestUri":"/virtualclusters" + }, + "input":{"shape":"ListVirtualClustersRequest"}, + "output":{"shape":"ListVirtualClustersResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ] + }, + "StartJobRun":{ + "name":"StartJobRun", + "http":{ + "method":"POST", + "requestUri":"/virtualclusters/{virtualClusterId}/jobruns" + }, + "input":{"shape":"StartJobRunRequest"}, + "output":{"shape":"StartJobRunResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"} + ] + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/tags/{resourceArn}" + }, + "input":{"shape":"TagResourceRequest"}, + "output":{"shape":"TagResourceResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"DELETE", + "requestUri":"/tags/{resourceArn}" + }, + "input":{"shape":"UntagResourceRequest"}, + "output":{"shape":"UntagResourceResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ] + } + }, + "shapes":{ + "ACMCertArn":{ + "type":"string", + "max":2048, + "min":44, + "pattern":"^arn:(aws[a-zA-Z0-9-]*):acm:.+:(\\d{12}):certificate/.+$" + }, + "CancelJobRunRequest":{ + "type":"structure", + "required":[ + "id", + "virtualClusterId" + ], + "members":{ + "id":{ + "shape":"ResourceIdString", + "location":"uri", + "locationName":"jobRunId" + }, + "virtualClusterId":{ + "shape":"ResourceIdString", + "location":"uri", + "locationName":"virtualClusterId" + } + } + }, + "CancelJobRunResponse":{ + "type":"structure", + "members":{ + "id":{"shape":"ResourceIdString"}, + "virtualClusterId":{"shape":"ResourceIdString"} + } + }, + "ClientToken":{ + "type":"string", + "max":64, + "min":1, + "pattern":".*\\S.*" + }, + "CloudWatchMonitoringConfiguration":{ + "type":"structure", + "required":["logGroupName"], + "members":{ + "logGroupName":{"shape":"LogGroupName"}, + "logStreamNamePrefix":{"shape":"String256"} + } + }, + "Configuration":{ + "type":"structure", + "required":["classification"], + "members":{ + "classification":{"shape":"String1024"}, + "properties":{"shape":"SensitivePropertiesMap"}, + "configurations":{"shape":"ConfigurationList"} + } + }, + "ConfigurationList":{ + "type":"list", + "member":{"shape":"Configuration"}, + "max":100 + }, + "ConfigurationOverrides":{ + "type":"structure", + "members":{ + "applicationConfiguration":{"shape":"ConfigurationList"}, + "monitoringConfiguration":{"shape":"MonitoringConfiguration"} + } + }, + "ContainerInfo":{ + "type":"structure", + "members":{ + "eksInfo":{"shape":"EksInfo"} + }, + "union":true + }, + "ContainerProvider":{ + "type":"structure", + "required":[ + "type", + "id" + ], + "members":{ + "type":{"shape":"ContainerProviderType"}, + "id":{"shape":"String256"}, + "info":{"shape":"ContainerInfo"} + } + }, + "ContainerProviderType":{ + "type":"string", + "enum":["EKS"] + }, + "CreateManagedEndpointRequest":{ + "type":"structure", + "required":[ + "name", + "virtualClusterId", + "type", + "releaseLabel", + "executionRoleArn", + "certificateArn", + "clientToken" + ], + "members":{ + "name":{"shape":"ResourceNameString"}, + "virtualClusterId":{ + "shape":"ResourceIdString", + "location":"uri", + "locationName":"virtualClusterId" + }, + "type":{"shape":"EndpointType"}, + "releaseLabel":{"shape":"ReleaseLabel"}, + "executionRoleArn":{"shape":"IAMRoleArn"}, + "certificateArn":{"shape":"ACMCertArn"}, + "configurationOverrides":{"shape":"ConfigurationOverrides"}, + "clientToken":{ + "shape":"ClientToken", + "idempotencyToken":true + }, + "tags":{"shape":"TagMap"} + } + }, + "CreateManagedEndpointResponse":{ + "type":"structure", + "members":{ + "id":{"shape":"ResourceIdString"}, + "name":{"shape":"ResourceNameString"}, + "arn":{"shape":"EndpointArn"}, + "virtualClusterId":{"shape":"ResourceIdString"} + } + }, + "CreateVirtualClusterRequest":{ + "type":"structure", + "required":[ + "name", + "containerProvider", + "clientToken" + ], + "members":{ + "name":{"shape":"ResourceNameString"}, + "containerProvider":{"shape":"ContainerProvider"}, + "clientToken":{ + "shape":"ClientToken", + "idempotencyToken":true + }, + "tags":{"shape":"TagMap"} + } + }, + "CreateVirtualClusterResponse":{ + "type":"structure", + "members":{ + "id":{"shape":"ResourceIdString"}, + "name":{"shape":"ResourceNameString"}, + "arn":{"shape":"VirtualClusterArn"} + } + }, + "Date":{"type":"timestamp"}, + "DeleteManagedEndpointRequest":{ + "type":"structure", + "required":[ + "id", + "virtualClusterId" + ], + "members":{ + "id":{ + "shape":"ResourceIdString", + "location":"uri", + "locationName":"endpointId" + }, + "virtualClusterId":{ + "shape":"ResourceIdString", + "location":"uri", + "locationName":"virtualClusterId" + } + } + }, + "DeleteManagedEndpointResponse":{ + "type":"structure", + "members":{ + "id":{"shape":"ResourceIdString"}, + "virtualClusterId":{"shape":"ResourceIdString"} + } + }, + "DeleteVirtualClusterRequest":{ + "type":"structure", + "required":["id"], + "members":{ + "id":{ + "shape":"ResourceIdString", + "location":"uri", + "locationName":"virtualClusterId" + } + } + }, + "DeleteVirtualClusterResponse":{ + "type":"structure", + "members":{ + "id":{"shape":"ResourceIdString"} + } + }, + "DescribeJobRunRequest":{ + "type":"structure", + "required":[ + "id", + "virtualClusterId" + ], + "members":{ + "id":{ + "shape":"ResourceIdString", + "location":"uri", + "locationName":"jobRunId" + }, + "virtualClusterId":{ + "shape":"ResourceIdString", + "location":"uri", + "locationName":"virtualClusterId" + } + } + }, + "DescribeJobRunResponse":{ + "type":"structure", + "members":{ + "jobRun":{"shape":"JobRun"} + } + }, + "DescribeManagedEndpointRequest":{ + "type":"structure", + "required":[ + "id", + "virtualClusterId" + ], + "members":{ + "id":{ + "shape":"ResourceIdString", + "location":"uri", + "locationName":"endpointId" + }, + "virtualClusterId":{ + "shape":"ResourceIdString", + "location":"uri", + "locationName":"virtualClusterId" + } + } + }, + "DescribeManagedEndpointResponse":{ + "type":"structure", + "members":{ + "endpoint":{"shape":"Endpoint"} + } + }, + "DescribeVirtualClusterRequest":{ + "type":"structure", + "required":["id"], + "members":{ + "id":{ + "shape":"ResourceIdString", + "location":"uri", + "locationName":"virtualClusterId" + } + } + }, + "DescribeVirtualClusterResponse":{ + "type":"structure", + "members":{ + "virtualCluster":{"shape":"VirtualCluster"} + } + }, + "EksInfo":{ + "type":"structure", + "members":{ + "namespace":{"shape":"String256"} + } + }, + "Endpoint":{ + "type":"structure", + "members":{ + "id":{"shape":"ResourceIdString"}, + "name":{"shape":"ResourceNameString"}, + "arn":{"shape":"EndpointArn"}, + "virtualClusterId":{"shape":"ResourceIdString"}, + "type":{"shape":"EndpointType"}, + "state":{"shape":"EndpointState"}, + "releaseLabel":{"shape":"ReleaseLabel"}, + "executionRoleArn":{"shape":"IAMRoleArn"}, + "certificateArn":{"shape":"ACMCertArn"}, + "configurationOverrides":{"shape":"ConfigurationOverrides"}, + "serverUrl":{"shape":"UriString"}, + "createdAt":{"shape":"Date"}, + "securityGroup":{"shape":"String256"}, + "subnetIds":{"shape":"SubnetIds"}, + "tags":{"shape":"TagMap"} + } + }, + "EndpointArn":{ + "type":"string", + "max":1024, + "min":60, + "pattern":"^arn:(aws[a-zA-Z0-9-]*):emr-containers:.+:(\\d{12}):\\/virtualclusters\\/[0-9a-zA-Z]+\\/endpoints\\/[0-9a-zA-Z]+$" + }, + "EndpointState":{ + "type":"string", + "enum":[ + "CREATING", + "ACTIVE", + "TERMINATING", + "TERMINATED", + "TERMINATED_WITH_ERRORS" + ] + }, + "EndpointStates":{ + "type":"list", + "member":{"shape":"EndpointState"}, + "max":10 + }, + "EndpointType":{ + "type":"string", + "max":64, + "min":1, + "pattern":".*\\S.*" + }, + "EndpointTypes":{ + "type":"list", + "member":{"shape":"EndpointType"}, + "max":10 + }, + "Endpoints":{ + "type":"list", + "member":{"shape":"Endpoint"} + }, + "EntryPointArgument":{ + "type":"string", + "max":10280, + "min":1, + "pattern":"(?!\\s*$)(^[^';|\\u0026\\u003C\\u003E*?`$(){}\\[\\]!#\\\\]*$)", + "sensitive":true + }, + "EntryPointArguments":{ + "type":"list", + "member":{"shape":"EntryPointArgument"} + }, + "EntryPointPath":{ + "type":"string", + "max":256, + "min":1, + "pattern":"(?!\\s*$)(^[^';|\\u0026\\u003C\\u003E*?`$(){}\\[\\]!#\\\\]*$)", + "sensitive":true + }, + "FailureReason":{ + "type":"string", + "enum":[ + "INTERNAL_ERROR", + "USER_ERROR", + "VALIDATION_ERROR", + "CLUSTER_UNAVAILABLE" + ] + }, + "IAMRoleArn":{ + "type":"string", + "max":2048, + "min":20, + "pattern":"^arn:(aws[a-zA-Z0-9-]*):iam::(\\d{12})?:(role((\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F))[\\w+=,.@-]+)$" + }, + "InternalServerException":{ + "type":"structure", + "members":{ + "message":{"shape":"String1024"} + }, + "error":{"httpStatusCode":500}, + "exception":true + }, + "JavaInteger":{"type":"integer"}, + "JobArn":{ + "type":"string", + "max":1024, + "min":60, + "pattern":"^arn:(aws[a-zA-Z0-9-]*):emr-containers:.+:(\\d{12}):\\/virtualclusters\\/[0-9a-zA-Z]+\\/jobruns\\/[0-9a-zA-Z]+$" + }, + "JobDriver":{ + "type":"structure", + "members":{ + "sparkSubmitJobDriver":{"shape":"SparkSubmitJobDriver"} + } + }, + "JobRun":{ + "type":"structure", + "members":{ + "id":{"shape":"ResourceIdString"}, + "name":{"shape":"ResourceNameString"}, + "virtualClusterId":{"shape":"ResourceIdString"}, + "arn":{"shape":"JobArn"}, + "state":{"shape":"JobRunState"}, + "clientToken":{"shape":"ClientToken"}, + "executionRoleArn":{"shape":"IAMRoleArn"}, + "releaseLabel":{"shape":"ReleaseLabel"}, + "configurationOverrides":{"shape":"ConfigurationOverrides"}, + "jobDriver":{"shape":"JobDriver"}, + "createdAt":{"shape":"Date"}, + "createdBy":{"shape":"RequestIdentityUserArn"}, + "finishedAt":{"shape":"Date"}, + "stateDetails":{"shape":"String256"}, + "failureReason":{"shape":"FailureReason"}, + "tags":{"shape":"TagMap"} + } + }, + "JobRunState":{ + "type":"string", + "enum":[ + "PENDING", + "SUBMITTED", + "RUNNING", + "FAILED", + "CANCELLED", + "CANCEL_PENDING", + "COMPLETED" + ] + }, + "JobRunStates":{ + "type":"list", + "member":{"shape":"JobRunState"}, + "max":10 + }, + "JobRuns":{ + "type":"list", + "member":{"shape":"JobRun"} + }, + "ListJobRunsRequest":{ + "type":"structure", + "required":["virtualClusterId"], + "members":{ + "virtualClusterId":{ + "shape":"ResourceIdString", + "location":"uri", + "locationName":"virtualClusterId" + }, + "createdBefore":{ + "shape":"Date", + "location":"querystring", + "locationName":"createdBefore" + }, + "createdAfter":{ + "shape":"Date", + "location":"querystring", + "locationName":"createdAfter" + }, + "name":{ + "shape":"ResourceNameString", + "location":"querystring", + "locationName":"name" + }, + "states":{ + "shape":"JobRunStates", + "location":"querystring", + "locationName":"states" + }, + "maxResults":{ + "shape":"JavaInteger", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"NextToken", + "location":"querystring", + "locationName":"nextToken" + } + } + }, + "ListJobRunsResponse":{ + "type":"structure", + "members":{ + "jobRuns":{"shape":"JobRuns"}, + "nextToken":{"shape":"NextToken"} + } + }, + "ListManagedEndpointsRequest":{ + "type":"structure", + "required":["virtualClusterId"], + "members":{ + "virtualClusterId":{ + "shape":"ResourceIdString", + "location":"uri", + "locationName":"virtualClusterId" + }, + "createdBefore":{ + "shape":"Date", + "location":"querystring", + "locationName":"createdBefore" + }, + "createdAfter":{ + "shape":"Date", + "location":"querystring", + "locationName":"createdAfter" + }, + "types":{ + "shape":"EndpointTypes", + "location":"querystring", + "locationName":"types" + }, + "states":{ + "shape":"EndpointStates", + "location":"querystring", + "locationName":"states" + }, + "maxResults":{ + "shape":"JavaInteger", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"NextToken", + "location":"querystring", + "locationName":"nextToken" + } + } + }, + "ListManagedEndpointsResponse":{ + "type":"structure", + "members":{ + "endpoints":{"shape":"Endpoints"}, + "nextToken":{"shape":"NextToken"} + } + }, + "ListTagsForResourceRequest":{ + "type":"structure", + "required":["resourceArn"], + "members":{ + "resourceArn":{ + "shape":"RsiArn", + "location":"uri", + "locationName":"resourceArn" + } + } + }, + "ListTagsForResourceResponse":{ + "type":"structure", + "members":{ + "tags":{"shape":"TagMap"} + } + }, + "ListVirtualClustersRequest":{ + "type":"structure", + "members":{ + "containerProviderId":{ + "shape":"String1024", + "location":"querystring", + "locationName":"containerProviderId" + }, + "containerProviderType":{ + "shape":"ContainerProviderType", + "location":"querystring", + "locationName":"containerProviderType" + }, + "createdAfter":{ + "shape":"Date", + "location":"querystring", + "locationName":"createdAfter" + }, + "createdBefore":{ + "shape":"Date", + "location":"querystring", + "locationName":"createdBefore" + }, + "states":{ + "shape":"VirtualClusterStates", + "location":"querystring", + "locationName":"states" + }, + "maxResults":{ + "shape":"JavaInteger", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"NextToken", + "location":"querystring", + "locationName":"nextToken" + } + } + }, + "ListVirtualClustersResponse":{ + "type":"structure", + "members":{ + "virtualClusters":{"shape":"VirtualClusters"}, + "nextToken":{"shape":"NextToken"} + } + }, + "LogGroupName":{ + "type":"string", + "max":512, + "min":1, + "pattern":"[\\.\\-_/#A-Za-z0-9]+" + }, + "MonitoringConfiguration":{ + "type":"structure", + "members":{ + "persistentAppUI":{"shape":"PersistentAppUI"}, + "cloudWatchMonitoringConfiguration":{"shape":"CloudWatchMonitoringConfiguration"}, + "s3MonitoringConfiguration":{"shape":"S3MonitoringConfiguration"} + } + }, + "NextToken":{ + "type":"string", + "max":1024, + "min":1, + "pattern":".*\\S.*" + }, + "PersistentAppUI":{ + "type":"string", + "enum":[ + "ENABLED", + "DISABLED" + ] + }, + "ReleaseLabel":{ + "type":"string", + "max":64, + "min":1, + "pattern":"[\\.\\-_/A-Za-z0-9]+" + }, + "RequestIdentityUserArn":{ + "type":"string", + "max":2048, + "min":20, + "pattern":"^arn:(aws[a-zA-Z0-9-]*):(iam|sts)::(\\d{12})?:[\\w/+=,.@-]+$" + }, + "ResourceIdString":{ + "type":"string", + "max":64, + "min":1, + "pattern":"[0-9a-z]+" + }, + "ResourceNameString":{ + "type":"string", + "max":64, + "min":1, + "pattern":"[\\.\\-_/#A-Za-z0-9]+" + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "message":{"shape":"String1024"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "RsiArn":{ + "type":"string", + "max":500, + "min":60, + "pattern":"^arn:(aws[a-zA-Z0-9-]*):emr-containers:.+:(\\d{12}):/virtualclusters/.+$" + }, + "S3MonitoringConfiguration":{ + "type":"structure", + "required":["logUri"], + "members":{ + "logUri":{"shape":"UriString"} + } + }, + "SensitivePropertiesMap":{ + "type":"map", + "key":{"shape":"String1024"}, + "value":{"shape":"String1024"}, + "max":100, + "sensitive":true + }, + "SparkSubmitJobDriver":{ + "type":"structure", + "required":["entryPoint"], + "members":{ + "entryPoint":{"shape":"EntryPointPath"}, + "entryPointArguments":{"shape":"EntryPointArguments"}, + "sparkSubmitParameters":{"shape":"SparkSubmitParameters"} + } + }, + "SparkSubmitParameters":{ + "type":"string", + "max":1024, + "min":1, + "pattern":"(?!\\s*$)(^[^';|\\u0026\\u003C\\u003E*?`$(){}\\[\\]!#\\\\]*$)", + "sensitive":true + }, + "StartJobRunRequest":{ + "type":"structure", + "required":[ + "virtualClusterId", + "clientToken", + "executionRoleArn", + "releaseLabel", + "jobDriver" + ], + "members":{ + "name":{"shape":"ResourceNameString"}, + "virtualClusterId":{ + "shape":"ResourceIdString", + "location":"uri", + "locationName":"virtualClusterId" + }, + "clientToken":{ + "shape":"ClientToken", + "idempotencyToken":true + }, + "executionRoleArn":{"shape":"IAMRoleArn"}, + "releaseLabel":{"shape":"ReleaseLabel"}, + "jobDriver":{"shape":"JobDriver"}, + "configurationOverrides":{"shape":"ConfigurationOverrides"}, + "tags":{"shape":"TagMap"} + } + }, + "StartJobRunResponse":{ + "type":"structure", + "members":{ + "id":{"shape":"ResourceIdString"}, + "name":{"shape":"ResourceNameString"}, + "arn":{"shape":"JobArn"}, + "virtualClusterId":{"shape":"ResourceIdString"} + } + }, + "String1024":{ + "type":"string", + "max":1024, + "min":1, + "pattern":".*\\S.*" + }, + "String128":{ + "type":"string", + "max":128, + "min":1, + "pattern":".*\\S.*" + }, + "String256":{ + "type":"string", + "max":256, + "min":1, + "pattern":".*\\S.*" + }, + "StringEmpty256":{ + "type":"string", + "max":256, + "min":0, + "pattern":".*\\S.*" + }, + "SubnetIds":{ + "type":"list", + "member":{"shape":"String256"} + }, + "TagKeyList":{ + "type":"list", + "member":{"shape":"String128"}, + "max":50, + "min":0 + }, + "TagMap":{ + "type":"map", + "key":{"shape":"String128"}, + "value":{"shape":"StringEmpty256"}, + "max":50, + "min":0 + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "resourceArn", + "tags" + ], + "members":{ + "resourceArn":{ + "shape":"RsiArn", + "location":"uri", + "locationName":"resourceArn" + }, + "tags":{"shape":"TagMap"} + } + }, + "TagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "resourceArn", + "tagKeys" + ], + "members":{ + "resourceArn":{ + "shape":"RsiArn", + "location":"uri", + "locationName":"resourceArn" + }, + "tagKeys":{ + "shape":"TagKeyList", + "location":"querystring", + "locationName":"tagKeys" + } + } + }, + "UntagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "UriString":{ + "type":"string", + "max":10280, + "min":1, + "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDBFF-\\uDC00\\uDFFF\\r\\n\\t]*" + }, + "ValidationException":{ + "type":"structure", + "members":{ + "message":{"shape":"String1024"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "VirtualCluster":{ + "type":"structure", + "members":{ + "id":{"shape":"ResourceIdString"}, + "name":{"shape":"ResourceNameString"}, + "arn":{"shape":"VirtualClusterArn"}, + "state":{"shape":"VirtualClusterState"}, + "containerProvider":{"shape":"ContainerProvider"}, + "createdAt":{"shape":"Date"}, + "tags":{"shape":"TagMap"} + } + }, + "VirtualClusterArn":{ + "type":"string", + "max":1024, + "min":60, + "pattern":"^arn:(aws[a-zA-Z0-9-]*):emr-containers:.+:(\\d{12}):\\/virtualclusters\\/[0-9a-zA-Z]+$" + }, + "VirtualClusterState":{ + "type":"string", + "enum":[ + "RUNNING", + "TERMINATING", + "TERMINATED", + "ARRESTED" + ] + }, + "VirtualClusterStates":{ + "type":"list", + "member":{"shape":"VirtualClusterState"}, + "max":10 + }, + "VirtualClusters":{ + "type":"list", + "member":{"shape":"VirtualCluster"} + } + } +} diff --git a/models/apis/emr-containers/2020-10-01/docs-2.json b/models/apis/emr-containers/2020-10-01/docs-2.json new file mode 100644 index 00000000000..e4348a88ec2 --- /dev/null +++ b/models/apis/emr-containers/2020-10-01/docs-2.json @@ -0,0 +1,627 @@ +{ + "version": "2.0", + "service": "Amazon EMR on EKS provides a deployment option for Amazon EMR that allows you to run open-source big data frameworks on Amazon Elastic Kubernetes Service (Amazon EKS). With this deployment option, you can focus on running analytics workloads while Amazon EMR on EKS builds, configures, and manages containers for open-source applications. For more information about Amazon EMR on EKS concepts and tasks, see What is Amazon EMR on EKS.
Amazon EMR containers is the API name for Amazon EMR on EKS. The emr-containers prefix is used in the following scenarios:
It is the prefix in the CLI commands for Amazon EMR on EKS. For example, aws emr-containers start-job-run.
It is the prefix before IAM policy actions for Amazon EMR on EKS. For example, \"Action\": [ \"emr-containers:StartJobRun\"]. For more information, see Policy actions for Amazon EMR on EKS.
It is the prefix used in Amazon EMR on EKS service endpoints. For example, emr-containers.us-east-2.amazonaws.com. For more information, see Amazon EMR on EKS Service Endpoints.
Cancels a job run. A job run is a unit of work, such as a Spark jar, PySpark script, or SparkSQL query, that you submit to Amazon EMR on EKS.
", + "CreateManagedEndpoint": "Creates a managed endpoint. A managed endpoint is a gateway that connects EMR Studio to Amazon EMR on EKS so that EMR Studio can communicate with your virtual cluster.
", + "CreateVirtualCluster": "Creates a virtual cluster. Virtual cluster is a managed entity on Amazon EMR on EKS. You can create, describe, list and delete virtual clusters. They do not consume any additional resource in your system. A single virtual cluster maps to a single Kubernetes namespace. Given this relationship, you can model virtual clusters the same way you model Kubernetes namespaces to meet your requirements.
", + "DeleteManagedEndpoint": "Deletes a managed endpoint. A managed endpoint is a gateway that connects EMR Studio to Amazon EMR on EKS so that EMR Studio can communicate with your virtual cluster.
", + "DeleteVirtualCluster": "Deletes a virtual cluster. Virtual cluster is a managed entity on Amazon EMR on EKS. You can create, describe, list and delete virtual clusters. They do not consume any additional resource in your system. A single virtual cluster maps to a single Kubernetes namespace. Given this relationship, you can model virtual clusters the same way you model Kubernetes namespaces to meet your requirements.
", + "DescribeJobRun": "Displays detailed information about a job run. A job run is a unit of work, such as a Spark jar, PySpark script, or SparkSQL query, that you submit to Amazon EMR on EKS.
", + "DescribeManagedEndpoint": "Displays detailed information about a managed endpoint. A managed endpoint is a gateway that connects EMR Studio to Amazon EMR on EKS so that EMR Studio can communicate with your virtual cluster.
", + "DescribeVirtualCluster": "Displays detailed information about a specified virtual cluster. Virtual cluster is a managed entity on Amazon EMR on EKS. You can create, describe, list and delete virtual clusters. They do not consume any additional resource in your system. A single virtual cluster maps to a single Kubernetes namespace. Given this relationship, you can model virtual clusters the same way you model Kubernetes namespaces to meet your requirements.
", + "ListJobRuns": "Lists job runs based on a set of parameters. A job run is a unit of work, such as a Spark jar, PySpark script, or SparkSQL query, that you submit to Amazon EMR on EKS.
", + "ListManagedEndpoints": "Lists managed endpoints based on a set of parameters. A managed endpoint is a gateway that connects EMR Studio to Amazon EMR on EKS so that EMR Studio can communicate with your virtual cluster.
", + "ListTagsForResource": "Lists the tags assigned to the resources.
", + "ListVirtualClusters": "Lists information about the specified virtual cluster. Virtual cluster is a managed entity on Amazon EMR on EKS. You can create, describe, list and delete virtual clusters. They do not consume any additional resource in your system. A single virtual cluster maps to a single Kubernetes namespace. Given this relationship, you can model virtual clusters the same way you model Kubernetes namespaces to meet your requirements.
", + "StartJobRun": "Starts a job run. A job run is a unit of work, such as a Spark jar, PySpark script, or SparkSQL query, that you submit to Amazon EMR on EKS.
", + "TagResource": "Assigns tags to resources. A tag is a label that you assign to an AWS resource. Each tag consists of a key and an optional value, both of which you define. Tags enable you to categorize your AWS resources by attributes such as purpose, owner, or environment. When you have many resources of the same type, you can quickly identify a specific resource based on the tags you've assigned to it. For example, you can define a set of tags for your Amazon EMR on EKS clusters to help you track each cluster's owner and stack level. We recommend that you devise a consistent set of tag keys for each resource type. You can then search and filter the resources based on the tags that you add.
", + "UntagResource": "Removes tags from resources.
" + }, + "shapes": { + "ACMCertArn": { + "base": null, + "refs": { + "CreateManagedEndpointRequest$certificateArn": "The certificate ARN of the managed endpoint.
", + "Endpoint$certificateArn": "The certificate ARN of the endpoint.
" + } + }, + "CancelJobRunRequest": { + "base": null, + "refs": { + } + }, + "CancelJobRunResponse": { + "base": null, + "refs": { + } + }, + "ClientToken": { + "base": null, + "refs": { + "CreateManagedEndpointRequest$clientToken": "The client idempotency token for this create call.
", + "CreateVirtualClusterRequest$clientToken": "The client token of the virtual cluster.
", + "JobRun$clientToken": "The client token used to start a job run.
", + "StartJobRunRequest$clientToken": "The client idempotency token of the job run request.
" + } + }, + "CloudWatchMonitoringConfiguration": { + "base": "A configuration for CloudWatch monitoring. You can configure your jobs to send log information to CloudWatch Logs.
", + "refs": { + "MonitoringConfiguration$cloudWatchMonitoringConfiguration": "Monitoring configurations for CloudWatch.
" + } + }, + "Configuration": { + "base": "A configuration specification to be used when provisioning virtual clusters, which can include configurations for applications and software bundled with Amazon EMR on EKS. A configuration consists of a classification, properties, and optional nested configurations. A classification refers to an application-specific configuration file. Properties are the settings you want to change in that file.
", + "refs": { + "ConfigurationList$member": null + } + }, + "ConfigurationList": { + "base": null, + "refs": { + "Configuration$configurations": "A list of additional configurations to apply within a configuration object.
", + "ConfigurationOverrides$applicationConfiguration": "The configurations for the application running by the job run.
" + } + }, + "ConfigurationOverrides": { + "base": "A configuration specification to be used to override existing configurations.
", + "refs": { + "CreateManagedEndpointRequest$configurationOverrides": "The configuration settings that will be used to override existing configurations.
", + "Endpoint$configurationOverrides": "The configuration settings that are used to override existing configurations for endpoints.
", + "JobRun$configurationOverrides": "The configuration settings that are used to override default configuration.
", + "StartJobRunRequest$configurationOverrides": "The configuration overrides for the job run.
" + } + }, + "ContainerInfo": { + "base": "The information about the container used for a job run or a managed endpoint.
", + "refs": { + "ContainerProvider$info": "The information about the container cluster.
" + } + }, + "ContainerProvider": { + "base": "The information about the container provider.
", + "refs": { + "CreateVirtualClusterRequest$containerProvider": "The container provider of the virtual cluster.
", + "VirtualCluster$containerProvider": "The container provider of the virtual cluster.
" + } + }, + "ContainerProviderType": { + "base": null, + "refs": { + "ContainerProvider$type": "The type of the container provider. EKS is the only supported type as of now.
", + "ListVirtualClustersRequest$containerProviderType": "The container provider type of the virtual cluster. EKS is the only supported type as of now.
" + } + }, + "CreateManagedEndpointRequest": { + "base": null, + "refs": { + } + }, + "CreateManagedEndpointResponse": { + "base": null, + "refs": { + } + }, + "CreateVirtualClusterRequest": { + "base": null, + "refs": { + } + }, + "CreateVirtualClusterResponse": { + "base": null, + "refs": { + } + }, + "Date": { + "base": null, + "refs": { + "Endpoint$createdAt": "The date and time when the endpoint was created.
", + "JobRun$createdAt": "The date and time when the job run was created.
", + "JobRun$finishedAt": "The date and time when the job run has finished.
", + "ListJobRunsRequest$createdBefore": "The date and time before which the job runs were submitted.
", + "ListJobRunsRequest$createdAfter": "The date and time after which the job runs were submitted.
", + "ListManagedEndpointsRequest$createdBefore": "The date and time before which the endpoints are created.
", + "ListManagedEndpointsRequest$createdAfter": "The date and time after which the endpoints are created.
", + "ListVirtualClustersRequest$createdAfter": "The date and time after which the virtual clusters are created.
", + "ListVirtualClustersRequest$createdBefore": "The date and time before which the virtual clusters are created.
", + "VirtualCluster$createdAt": "The date and time when the virtual cluster is created.
" + } + }, + "DeleteManagedEndpointRequest": { + "base": null, + "refs": { + } + }, + "DeleteManagedEndpointResponse": { + "base": null, + "refs": { + } + }, + "DeleteVirtualClusterRequest": { + "base": null, + "refs": { + } + }, + "DeleteVirtualClusterResponse": { + "base": null, + "refs": { + } + }, + "DescribeJobRunRequest": { + "base": null, + "refs": { + } + }, + "DescribeJobRunResponse": { + "base": null, + "refs": { + } + }, + "DescribeManagedEndpointRequest": { + "base": null, + "refs": { + } + }, + "DescribeManagedEndpointResponse": { + "base": null, + "refs": { + } + }, + "DescribeVirtualClusterRequest": { + "base": null, + "refs": { + } + }, + "DescribeVirtualClusterResponse": { + "base": null, + "refs": { + } + }, + "EksInfo": { + "base": "The information about the EKS cluster.
", + "refs": { + "ContainerInfo$eksInfo": "The information about the EKS cluster.
" + } + }, + "Endpoint": { + "base": "This entity represents the endpoint that is managed by Amazon EMR on EKS.
", + "refs": { + "DescribeManagedEndpointResponse$endpoint": "This output displays information about a managed endpoint.
", + "Endpoints$member": null + } + }, + "EndpointArn": { + "base": null, + "refs": { + "CreateManagedEndpointResponse$arn": "The output contains the ARN of the managed endpoint.
", + "Endpoint$arn": "The ARN of the endpoint.
" + } + }, + "EndpointState": { + "base": null, + "refs": { + "Endpoint$state": "The state of the endpoint.
", + "EndpointStates$member": null + } + }, + "EndpointStates": { + "base": null, + "refs": { + "ListManagedEndpointsRequest$states": "The states of the managed endpoints.
" + } + }, + "EndpointType": { + "base": null, + "refs": { + "CreateManagedEndpointRequest$type": "The type of the managed endpoint.
", + "Endpoint$type": "The type of the endpoint.
", + "EndpointTypes$member": null + } + }, + "EndpointTypes": { + "base": null, + "refs": { + "ListManagedEndpointsRequest$types": "The types of the managed endpoints.
" + } + }, + "Endpoints": { + "base": null, + "refs": { + "ListManagedEndpointsResponse$endpoints": "The managed endpoints to be listed.
" + } + }, + "EntryPointArgument": { + "base": null, + "refs": { + "EntryPointArguments$member": null + } + }, + "EntryPointArguments": { + "base": null, + "refs": { + "SparkSubmitJobDriver$entryPointArguments": "The arguments for job application.
" + } + }, + "EntryPointPath": { + "base": null, + "refs": { + "SparkSubmitJobDriver$entryPoint": "The entry point of job application.
" + } + }, + "FailureReason": { + "base": null, + "refs": { + "JobRun$failureReason": "The reasons why the job run has failed.
" + } + }, + "IAMRoleArn": { + "base": null, + "refs": { + "CreateManagedEndpointRequest$executionRoleArn": "The ARN of the execution role.
", + "Endpoint$executionRoleArn": "The execution role ARN of the endpoint.
", + "JobRun$executionRoleArn": "The execution role ARN of the job run.
", + "StartJobRunRequest$executionRoleArn": "The execution role ARN for the job run.
" + } + }, + "InternalServerException": { + "base": "This is an internal server exception.
", + "refs": { + } + }, + "JavaInteger": { + "base": null, + "refs": { + "ListJobRunsRequest$maxResults": "The maximum number of job runs that can be listed.
", + "ListManagedEndpointsRequest$maxResults": "The maximum number of managed endpoints that can be listed.
", + "ListVirtualClustersRequest$maxResults": "The maximum number of virtual clusters that can be listed.
" + } + }, + "JobArn": { + "base": null, + "refs": { + "JobRun$arn": "The ARN of job run.
", + "StartJobRunResponse$arn": "This output lists the ARN of job run.
" + } + }, + "JobDriver": { + "base": "Specify the driver that the job runs on.
", + "refs": { + "JobRun$jobDriver": "Parameters of job driver for the job run.
", + "StartJobRunRequest$jobDriver": "The job driver for the job run.
" + } + }, + "JobRun": { + "base": "This entity describes a job run. A job run is a unit of work, such as a Spark jar, PySpark script, or SparkSQL query, that you submit to Amazon EMR on EKS.
", + "refs": { + "DescribeJobRunResponse$jobRun": "The output displays information about a job run.
", + "JobRuns$member": null + } + }, + "JobRunState": { + "base": null, + "refs": { + "JobRun$state": "The state of the job run.
", + "JobRunStates$member": null + } + }, + "JobRunStates": { + "base": null, + "refs": { + "ListJobRunsRequest$states": "The states of the job run.
" + } + }, + "JobRuns": { + "base": null, + "refs": { + "ListJobRunsResponse$jobRuns": "This output lists information about the specified job runs.
" + } + }, + "ListJobRunsRequest": { + "base": null, + "refs": { + } + }, + "ListJobRunsResponse": { + "base": null, + "refs": { + } + }, + "ListManagedEndpointsRequest": { + "base": null, + "refs": { + } + }, + "ListManagedEndpointsResponse": { + "base": null, + "refs": { + } + }, + "ListTagsForResourceRequest": { + "base": null, + "refs": { + } + }, + "ListTagsForResourceResponse": { + "base": null, + "refs": { + } + }, + "ListVirtualClustersRequest": { + "base": null, + "refs": { + } + }, + "ListVirtualClustersResponse": { + "base": null, + "refs": { + } + }, + "LogGroupName": { + "base": null, + "refs": { + "CloudWatchMonitoringConfiguration$logGroupName": "The name of the log group for log publishing.
" + } + }, + "MonitoringConfiguration": { + "base": "Configuration setting for monitoring.
", + "refs": { + "ConfigurationOverrides$monitoringConfiguration": "The configurations for monitoring.
" + } + }, + "NextToken": { + "base": null, + "refs": { + "ListJobRunsRequest$nextToken": "The token for the next set of job runs to return.
", + "ListJobRunsResponse$nextToken": "This output displays the token for the next set of job runs.
", + "ListManagedEndpointsRequest$nextToken": "The token for the next set of managed endpoints to return.
", + "ListManagedEndpointsResponse$nextToken": "The token for the next set of endpoints to return.
", + "ListVirtualClustersRequest$nextToken": "The token for the next set of virtual clusters to return.
", + "ListVirtualClustersResponse$nextToken": "This output displays the token for the next set of virtual clusters.
" + } + }, + "PersistentAppUI": { + "base": null, + "refs": { + "MonitoringConfiguration$persistentAppUI": "Monitoring configurations for the persistent application UI.
" + } + }, + "ReleaseLabel": { + "base": null, + "refs": { + "CreateManagedEndpointRequest$releaseLabel": "The Amazon EMR release version.
", + "Endpoint$releaseLabel": "The EMR release version to be used for the endpoint.
", + "JobRun$releaseLabel": "The release version of Amazon EMR.
", + "StartJobRunRequest$releaseLabel": "The Amazon EMR release version to use for the job run.
" + } + }, + "RequestIdentityUserArn": { + "base": null, + "refs": { + "JobRun$createdBy": "The user who created the job run.
" + } + }, + "ResourceIdString": { + "base": null, + "refs": { + "CancelJobRunRequest$id": "The ID of the job run to cancel.
", + "CancelJobRunRequest$virtualClusterId": "The ID of the virtual cluster for which the job run will be canceled.
", + "CancelJobRunResponse$id": "The output contains the ID of the cancelled job run.
", + "CancelJobRunResponse$virtualClusterId": "The output contains the virtual cluster ID for which the job run is cancelled.
", + "CreateManagedEndpointRequest$virtualClusterId": "The ID of the virtual cluster for which a managed endpoint is created.
", + "CreateManagedEndpointResponse$id": "The output contains the ID of the managed endpoint.
", + "CreateManagedEndpointResponse$virtualClusterId": "The output contains the ID of the virtual cluster.
", + "CreateVirtualClusterResponse$id": "This output contains the virtual cluster ID.
", + "DeleteManagedEndpointRequest$id": "The ID of the managed endpoint.
", + "DeleteManagedEndpointRequest$virtualClusterId": "The ID of the endpoint's virtual cluster.
", + "DeleteManagedEndpointResponse$id": "The output displays the ID of the managed endpoint.
", + "DeleteManagedEndpointResponse$virtualClusterId": "The output displays the ID of the endpoint's virtual cluster.
", + "DeleteVirtualClusterRequest$id": "The ID of the virtual cluster that will be deleted.
", + "DeleteVirtualClusterResponse$id": "This output contains the ID of the virtual cluster that will be deleted.
", + "DescribeJobRunRequest$id": "The ID of the job run request.
", + "DescribeJobRunRequest$virtualClusterId": "The ID of the virtual cluster for which the job run is submitted.
", + "DescribeManagedEndpointRequest$id": "This output displays ID of the managed endpoint.
", + "DescribeManagedEndpointRequest$virtualClusterId": "The ID of the endpoint's virtual cluster.
", + "DescribeVirtualClusterRequest$id": "The ID of the virtual cluster that will be described.
", + "Endpoint$id": "The ID of the endpoint.
", + "Endpoint$virtualClusterId": "The ID of the endpoint's virtual cluster.
", + "JobRun$id": "The ID of the job run.
", + "JobRun$virtualClusterId": "The ID of the job run's virtual cluster.
", + "ListJobRunsRequest$virtualClusterId": "The ID of the virtual cluster for which to list the job run.
", + "ListManagedEndpointsRequest$virtualClusterId": "The ID of the virtual cluster.
", + "StartJobRunRequest$virtualClusterId": "The virtual cluster ID for which the job run request is submitted.
", + "StartJobRunResponse$id": "This output displays the started job run ID.
", + "StartJobRunResponse$virtualClusterId": "This output displays the virtual cluster ID for which the job run was submitted.
", + "VirtualCluster$id": "The ID of the virtual cluster.
" + } + }, + "ResourceNameString": { + "base": null, + "refs": { + "CreateManagedEndpointRequest$name": "The name of the managed endpoint.
", + "CreateManagedEndpointResponse$name": "The output contains the name of the managed endpoint.
", + "CreateVirtualClusterRequest$name": "The specified name of the virtual cluster.
", + "CreateVirtualClusterResponse$name": "This output contains the name of the virtual cluster.
", + "Endpoint$name": "The name of the endpoint.
", + "JobRun$name": "The name of the job run.
", + "ListJobRunsRequest$name": "The name of the job run.
", + "StartJobRunRequest$name": "The name of the job run.
", + "StartJobRunResponse$name": "This output displays the name of the started job run.
", + "VirtualCluster$name": "The name of the virtual cluster.
" + } + }, + "ResourceNotFoundException": { + "base": "The specified resource was not found.
", + "refs": { + } + }, + "RsiArn": { + "base": null, + "refs": { + "ListTagsForResourceRequest$resourceArn": "The ARN of tagged resources.
", + "TagResourceRequest$resourceArn": "The ARN of resources.
", + "UntagResourceRequest$resourceArn": "The ARN of resources.
" + } + }, + "S3MonitoringConfiguration": { + "base": "Amazon S3 configuration for monitoring log publishing. You can configure your jobs to send log information to Amazon S3.
", + "refs": { + "MonitoringConfiguration$s3MonitoringConfiguration": "Amazon S3 configuration for monitoring log publishing.
" + } + }, + "SensitivePropertiesMap": { + "base": null, + "refs": { + "Configuration$properties": "A set of properties specified within a configuration classification.
" + } + }, + "SparkSubmitJobDriver": { + "base": "The information about job driver for Spark submit.
", + "refs": { + "JobDriver$sparkSubmitJobDriver": "The job driver parameters specified for spark submit.
" + } + }, + "SparkSubmitParameters": { + "base": null, + "refs": { + "SparkSubmitJobDriver$sparkSubmitParameters": "The Spark submit parameters that are used for job runs.
" + } + }, + "StartJobRunRequest": { + "base": null, + "refs": { + } + }, + "StartJobRunResponse": { + "base": null, + "refs": { + } + }, + "String1024": { + "base": null, + "refs": { + "Configuration$classification": "The classification within a configuration.
", + "InternalServerException$message": null, + "ListVirtualClustersRequest$containerProviderId": "The container provider ID of the virtual cluster.
", + "ResourceNotFoundException$message": null, + "SensitivePropertiesMap$key": null, + "SensitivePropertiesMap$value": null, + "ValidationException$message": null + } + }, + "String128": { + "base": null, + "refs": { + "TagKeyList$member": null, + "TagMap$key": null + } + }, + "String256": { + "base": null, + "refs": { + "CloudWatchMonitoringConfiguration$logStreamNamePrefix": "The specified name prefix for log streams.
", + "ContainerProvider$id": "The ID of the container cluster.
", + "EksInfo$namespace": "The namespaces of the EKS cluster.
", + "Endpoint$securityGroup": "The security group configuration of the endpoint.
", + "JobRun$stateDetails": "Additional details of the job run state.
", + "SubnetIds$member": null + } + }, + "StringEmpty256": { + "base": null, + "refs": { + "TagMap$value": null + } + }, + "SubnetIds": { + "base": null, + "refs": { + "Endpoint$subnetIds": "The subnet IDs of the endpoint.
" + } + }, + "TagKeyList": { + "base": null, + "refs": { + "UntagResourceRequest$tagKeys": "The tag keys of the resources.
" + } + }, + "TagMap": { + "base": null, + "refs": { + "CreateManagedEndpointRequest$tags": "The tags of the managed endpoint.
", + "CreateVirtualClusterRequest$tags": "The tags assigned to the virtual cluster.
", + "Endpoint$tags": "The tags of the endpoint.
", + "JobRun$tags": "The assigned tags of the job run.
", + "ListTagsForResourceResponse$tags": "The tags assigned to resources.
", + "StartJobRunRequest$tags": "The tags assigned to job runs.
", + "TagResourceRequest$tags": "The tags assigned to resources.
", + "VirtualCluster$tags": "The assigned tags of the virtual cluster.
" + } + }, + "TagResourceRequest": { + "base": null, + "refs": { + } + }, + "TagResourceResponse": { + "base": null, + "refs": { + } + }, + "UntagResourceRequest": { + "base": null, + "refs": { + } + }, + "UntagResourceResponse": { + "base": null, + "refs": { + } + }, + "UriString": { + "base": null, + "refs": { + "Endpoint$serverUrl": "The server URL of the endpoint.
", + "S3MonitoringConfiguration$logUri": "Amazon S3 destination URI for log publishing.
" + } + }, + "ValidationException": { + "base": "There are invalid parameters in the client request.
", + "refs": { + } + }, + "VirtualCluster": { + "base": "This entity describes a virtual cluster. A virtual cluster is a Kubernetes namespace that Amazon EMR is registered with. Amazon EMR uses virtual clusters to run jobs and host endpoints. Multiple virtual clusters can be backed by the same physical cluster. However, each virtual cluster maps to one namespace on an EKS cluster. Virtual clusters do not create any active resources that contribute to your bill or that require lifecycle management outside the service.
", + "refs": { + "DescribeVirtualClusterResponse$virtualCluster": "This output displays information about the specified virtual cluster.
", + "VirtualClusters$member": null + } + }, + "VirtualClusterArn": { + "base": null, + "refs": { + "CreateVirtualClusterResponse$arn": "This output contains the ARN of virtual cluster.
", + "VirtualCluster$arn": "The ARN of the virtual cluster.
" + } + }, + "VirtualClusterState": { + "base": null, + "refs": { + "VirtualCluster$state": "The state of the virtual cluster.
", + "VirtualClusterStates$member": null + } + }, + "VirtualClusterStates": { + "base": null, + "refs": { + "ListVirtualClustersRequest$states": "The states of the requested virtual clusters.
" + } + }, + "VirtualClusters": { + "base": null, + "refs": { + "ListVirtualClustersResponse$virtualClusters": "This output lists the specified virtual clusters.
" + } + } + } +} diff --git a/models/apis/emr-containers/2020-10-01/examples-1.json b/models/apis/emr-containers/2020-10-01/examples-1.json new file mode 100644 index 00000000000..0ea7e3b0bbe --- /dev/null +++ b/models/apis/emr-containers/2020-10-01/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/models/apis/emr-containers/2020-10-01/paginators-1.json b/models/apis/emr-containers/2020-10-01/paginators-1.json new file mode 100644 index 00000000000..48c53c8f286 --- /dev/null +++ b/models/apis/emr-containers/2020-10-01/paginators-1.json @@ -0,0 +1,22 @@ +{ + "pagination": { + "ListJobRuns": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "jobRuns" + }, + "ListManagedEndpoints": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "endpoints" + }, + "ListVirtualClusters": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "virtualClusters" + } + } +} diff --git a/models/apis/forecast/2018-06-26/api-2.json b/models/apis/forecast/2018-06-26/api-2.json index 2f128228372..78f7678d4ac 100644 --- a/models/apis/forecast/2018-06-26/api-2.json +++ b/models/apis/forecast/2018-06-26/api-2.json @@ -502,7 +502,8 @@ "string", "integer", "float", - "timestamp" + "timestamp", + "geolocation" ] }, "Boolean":{"type":"boolean"}, @@ -574,6 +575,9 @@ "DatasetArn":{"shape":"Arn"}, "DataSource":{"shape":"DataSource"}, "TimestampFormat":{"shape":"TimestampFormat"}, + "TimeZone":{"shape":"TimeZone"}, + "UseGeolocationForTimeZone":{"shape":"UseGeolocationForTimeZone"}, + "GeolocationFormat":{"shape":"GeolocationFormat"}, "Tags":{"shape":"Tags"} } }, @@ -844,6 +848,9 @@ "DatasetImportJobArn":{"shape":"Arn"}, "DatasetArn":{"shape":"Arn"}, "TimestampFormat":{"shape":"TimestampFormat"}, + "TimeZone":{"shape":"TimeZone"}, + "UseGeolocationForTimeZone":{"shape":"UseGeolocationForTimeZone"}, + "GeolocationFormat":{"shape":"GeolocationFormat"}, "DataSource":{"shape":"DataSource"}, "FieldStatistics":{"shape":"FieldStatistics"}, "DataSize":{"shape":"Double"}, @@ -1156,6 +1163,11 @@ "type":"string", "pattern":"^Y|M|W|D|H|30min|15min|10min|5min|1min$" }, + "GeolocationFormat":{ + "type":"string", + "max":256, + "pattern":"^[a-zA-Z0-9_]+$" + }, "GetAccuracyMetricsRequest":{ "type":"structure", "required":["PredictorArn"], @@ -1549,7 +1561,7 @@ "SupplementaryFeatures":{ "type":"list", "member":{"shape":"SupplementaryFeature"}, - "max":1, + "max":2, "min":1 }, "Tag":{ @@ -1567,7 +1579,8 @@ "type":"string", "max":128, "min":1, - "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$", + "sensitive":true }, "TagKeys":{ "type":"list", @@ -1595,7 +1608,8 @@ "type":"string", "max":256, "min":0, - "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$", + "sensitive":true }, "Tags":{ "type":"list", @@ -1620,6 +1634,11 @@ "type":"list", "member":{"shape":"WindowSummary"} }, + "TimeZone":{ + "type":"string", + "max":256, + "pattern":"^[a-zA-Z0-9\\/\\+\\-\\_]+$" + }, "Timestamp":{"type":"timestamp"}, "TimestampFormat":{ "type":"string", @@ -1665,6 +1684,7 @@ "members":{ } }, + "UseGeolocationForTimeZone":{"type":"boolean"}, "Value":{ "type":"string", "max":256, diff --git a/models/apis/forecast/2018-06-26/docs-2.json b/models/apis/forecast/2018-06-26/docs-2.json index 8d44ce1aef1..ffd910bc182 100644 --- a/models/apis/forecast/2018-06-26/docs-2.json +++ b/models/apis/forecast/2018-06-26/docs-2.json @@ -8,7 +8,7 @@ "CreateForecast": "Creates a forecast for each item in the TARGET_TIME_SERIES dataset that was used to train the predictor. This is known as inference. To retrieve the forecast for a single item at low latency, use the operation. To export the complete forecast into your Amazon Simple Storage Service (Amazon S3) bucket, use the CreateForecastExportJob operation.
The range of the forecast is determined by the ForecastHorizon value, which you specify in the CreatePredictor request. When you query a forecast, you can request a specific date range within the forecast.
To get a list of all your forecasts, use the ListForecasts operation.
The forecasts generated by Amazon Forecast are in the same time zone as the dataset that was used to create the predictor.
For more information, see howitworks-forecast.
The Status of the forecast must be ACTIVE before you can query or export the forecast. Use the DescribeForecast operation to get the status.
Exports a forecast created by the CreateForecast operation to your Amazon Simple Storage Service (Amazon S3) bucket. The forecast file name will match the following conventions:
<ForecastExportJobName>_<ExportTimestamp>_<PartNumber>
where the <ExportTimestamp> component is in Java SimpleDateFormat (yyyy-MM-ddTHH-mm-ssZ).
You must specify a DataDestination object that includes an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket. For more information, see aws-forecast-iam-roles.
For more information, see howitworks-forecast.
To get a list of all your forecast export jobs, use the ListForecastExportJobs operation.
The Status of the forecast export job must be ACTIVE before you can access the forecast in your Amazon S3 bucket. To get the status, use the DescribeForecastExportJob operation.
Creates an Amazon Forecast predictor.
In the request, provide a dataset group and either specify an algorithm or let Amazon Forecast choose an algorithm for you using AutoML. If you specify an algorithm, you also can override algorithm-specific hyperparameters.
Amazon Forecast uses the algorithm to train a predictor using the latest version of the datasets in the specified dataset group. You can then generate a forecast using the CreateForecast operation.
To see the evaluation metrics, use the GetAccuracyMetrics operation.
You can specify a featurization configuration to fill and aggregate the data fields in the TARGET_TIME_SERIES dataset to improve model training. For more information, see FeaturizationConfig.
For RELATED_TIME_SERIES datasets, CreatePredictor verifies that the DataFrequency specified when the dataset was created matches the ForecastFrequency. TARGET_TIME_SERIES datasets don't have this restriction. Amazon Forecast also verifies the delimiter and timestamp format. For more information, see howitworks-datasets-groups.
By default, predictors are trained and evaluated at the 0.1 (P10), 0.5 (P50), and 0.9 (P90) quantiles. You can choose custom forecast types to train and evaluate your predictor by setting the ForecastTypes.
AutoML
If you want Amazon Forecast to evaluate each algorithm and choose the one that minimizes the objective function, set PerformAutoML to true. The objective function is defined as the mean of the weighted losses over the forecast types. By default, these are the p10, p50, and p90 quantile losses. For more information, see EvaluationResult.
When AutoML is enabled, the following properties are disallowed:
AlgorithmArn
HPOConfig
PerformHPO
TrainingParameters
To get a list of all of your predictors, use the ListPredictors operation.
Before you can use the predictor to create a forecast, the Status of the predictor must be ACTIVE, signifying that training has completed. To get the status, use the DescribePredictor operation.
Exports backtest forecasts and accuracy metrics generated by the CreatePredictor operation. Two CSV files are exported to a specified S3 bucket.
You must specify a DataDestination object that includes an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket. For more information, see aws-forecast-iam-roles.
", + "CreatePredictorBacktestExportJob": "Exports backtest forecasts and accuracy metrics generated by the CreatePredictor operation. Two folders containing CSV files are exported to your specified S3 bucket.
The export file names will match the following conventions:
<ExportJobName>_<ExportTimestamp>_<PartNumber>.csv
The <ExportTimestamp> component is in Java SimpleDate format (yyyy-MM-ddTHH-mm-ssZ).
You must specify a DataDestination object that includes an Amazon S3 bucket and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket. For more information, see aws-forecast-iam-roles.
The Status of the export job must be ACTIVE before you can access the export in your Amazon S3 bucket. To get the status, use the DescribePredictorBacktestExportJob operation.
Deletes an Amazon Forecast dataset that was created using the CreateDataset operation. You can only delete datasets that have a status of ACTIVE or CREATE_FAILED. To get the status use the DescribeDataset operation.
Forecast does not automatically update any dataset groups that contain the deleted dataset. In order to update the dataset group, use the operation, omitting the deleted dataset's ARN.
Deletes a dataset group created using the CreateDatasetGroup operation. You can only delete dataset groups that have a status of ACTIVE, CREATE_FAILED, or UPDATE_FAILED. To get the status, use the DescribeDatasetGroup operation.
This operation deletes only the dataset group, not the datasets in the group.
", "DeleteDatasetImportJob": "Deletes a dataset import job created using the CreateDatasetImportJob operation. You can delete only dataset import jobs that have a status of ACTIVE or CREATE_FAILED. To get the status, use the DescribeDatasetImportJob operation.
The destination for an export job, an AWS Identity and Access Management (IAM) role that allows Amazon Forecast to access the location and, optionally, an AWS Key Management Service (KMS) key.
", + "base": "The destination for an export job. Provide an S3 path, an AWS Identity and Access Management (IAM) role that allows Amazon Forecast to access the location, and an AWS Key Management Service (KMS) key (optional).
", "refs": { "CreateForecastExportJobRequest$Destination": "The location where you want to save the forecast and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the location. The forecast must be exported to an Amazon S3 bucket.
If encryption is used, Destination must include an AWS Key Management Service (KMS) key. The IAM role must allow Amazon Forecast permission to access the key.
The frequency of predictions in a forecast.
Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min (30 minutes), 15min (15 minutes), 10min (10 minutes), 5min (5 minutes), and 1min (1 minute). For example, \"Y\" indicates every year and \"5min\" indicates every five minutes.
The frequency must be greater than or equal to the TARGET_TIME_SERIES dataset frequency.
When a RELATED_TIME_SERIES dataset is provided, the frequency must be equal to the RELATED_TIME_SERIES dataset frequency.
" } }, + "GeolocationFormat": { + "base": null, + "refs": { + "CreateDatasetImportJobRequest$GeolocationFormat": "The format of the geolocation attribute. The geolocation attribute can be formatted in one of two ways:
LAT_LONG - the latitude and longitude in decimal format (Example: 47.61_-122.33).
CC_POSTALCODE (US Only) - the country code (US), followed by the 5-digit ZIP code (Example: US_98121).
The format of the geolocation attribute. Valid Values:\"LAT_LONG\" and \"CC_POSTALCODE\".
The name of the predictor backtest export job.
", "PredictorSummary$PredictorName": "The name of the predictor.
", "SchemaAttribute$AttributeName": "The name of the dataset field.
", - "SupplementaryFeature$Name": "The name of the feature. This must be \"holiday\".
" + "SupplementaryFeature$Name": "The name of the feature. Valid values: \"holiday\" and \"weather\".
Describes a supplementary feature of a dataset group. This object is part of the InputDataConfig object.
The only supported feature is Holidays. If you use the calendar, all data in the datasets should belong to the same country as the calendar. For the holiday calendar data, see the Jollyday website.
", + "base": "Describes a supplementary feature of a dataset group. This object is part of the InputDataConfig object. Forecast supports the Weather Index and Holidays built-in featurizations.
Weather Index
The Amazon Forecast Weather Index is a built-in featurization that incorporates historical and projected weather information into your model. The Weather Index supplements your datasets with over two years of historical weather data and up to 14 days of projected weather data. For more information, see Amazon Forecast Weather Index.
Holidays
Holidays is a built-in featurization that incorporates a feature-engineered dataset of national holiday information into your model. It provides native support for the holiday calendars of 66 countries. To view the holiday calendars, refer to the Jollyday library. For more information, see Holidays Featurization.
", "refs": { "SupplementaryFeatures$member": null } @@ -1065,6 +1072,13 @@ "EvaluationResult$TestWindows": "The array of test windows used for evaluating the algorithm. The NumberOfBacktestWindows from the EvaluationParameters object determines the number of windows in the array.
A single time zone for every item in your dataset. This option is ideal for datasets with all timestamps within a single time zone, or if all timestamps are normalized to a single time zone.
Refer to the Joda-Time API for a complete list of valid time zone names.
", + "DescribeDatasetImportJobResponse$TimeZone": "The single time zone applied to every item in the dataset
" + } + }, "Timestamp": { "base": null, "refs": { @@ -1136,10 +1150,17 @@ "refs": { } }, + "UseGeolocationForTimeZone": { + "base": null, + "refs": { + "CreateDatasetImportJobRequest$UseGeolocationForTimeZone": "Automatically derive time zone information from the geolocation attribute. This option is ideal for datasets that contain timestamps in multiple time zones and those timestamps are expressed in local time.
", + "DescribeDatasetImportJobResponse$UseGeolocationForTimeZone": "Whether TimeZone is automatically derived from the geolocation attribute.
One of the following 2 letter country codes:
\"AL\" - ALBANIA
\"AR\" - ARGENTINA
\"AT\" - AUSTRIA
\"AU\" - AUSTRALIA
\"BA\" - BOSNIA HERZEGOVINA
\"BE\" - BELGIUM
\"BG\" - BULGARIA
\"BO\" - BOLIVIA
\"BR\" - BRAZIL
\"BY\" - BELARUS
\"CA\" - CANADA
\"CL\" - CHILE
\"CO\" - COLOMBIA
\"CR\" - COSTA RICA
\"HR\" - CROATIA
\"CZ\" - CZECH REPUBLIC
\"DK\" - DENMARK
\"EC\" - ECUADOR
\"EE\" - ESTONIA
\"ET\" - ETHIOPIA
\"FI\" - FINLAND
\"FR\" - FRANCE
\"DE\" - GERMANY
\"GR\" - GREECE
\"HU\" - HUNGARY
\"IS\" - ICELAND
\"IN\" - INDIA
\"IE\" - IRELAND
\"IT\" - ITALY
\"JP\" - JAPAN
\"KZ\" - KAZAKHSTAN
\"KR\" - KOREA
\"LV\" - LATVIA
\"LI\" - LIECHTENSTEIN
\"LT\" - LITHUANIA
\"LU\" - LUXEMBOURG
\"MK\" - MACEDONIA
\"MT\" - MALTA
\"MX\" - MEXICO
\"MD\" - MOLDOVA
\"ME\" - MONTENEGRO
\"NL\" - NETHERLANDS
\"NZ\" - NEW ZEALAND
\"NI\" - NICARAGUA
\"NG\" - NIGERIA
\"NO\" - NORWAY
\"PA\" - PANAMA
\"PY\" - PARAGUAY
\"PE\" - PERU
\"PL\" - POLAND
\"PT\" - PORTUGAL
\"RO\" - ROMANIA
\"RU\" - RUSSIA
\"RS\" - SERBIA
\"SK\" - SLOVAKIA
\"SI\" - SLOVENIA
\"ZA\" - SOUTH AFRICA
\"ES\" - SPAIN
\"SE\" - SWEDEN
\"CH\" - SWITZERLAND
\"UA\" - UKRAINE
\"AE\" - UNITED ARAB EMIRATES
\"US\" - UNITED STATES
\"UK\" - UNITED KINGDOM
\"UY\" - URUGUAY
\"VE\" - VENEZUELA
Weather Index
To enable the Weather Index, set the value to \"true\"
Holidays
To enable Holidays, specify a country with one of the following two-letter country codes:
\"AL\" - ALBANIA
\"AR\" - ARGENTINA
\"AT\" - AUSTRIA
\"AU\" - AUSTRALIA
\"BA\" - BOSNIA HERZEGOVINA
\"BE\" - BELGIUM
\"BG\" - BULGARIA
\"BO\" - BOLIVIA
\"BR\" - BRAZIL
\"BY\" - BELARUS
\"CA\" - CANADA
\"CL\" - CHILE
\"CO\" - COLOMBIA
\"CR\" - COSTA RICA
\"HR\" - CROATIA
\"CZ\" - CZECH REPUBLIC
\"DK\" - DENMARK
\"EC\" - ECUADOR
\"EE\" - ESTONIA
\"ET\" - ETHIOPIA
\"FI\" - FINLAND
\"FR\" - FRANCE
\"DE\" - GERMANY
\"GR\" - GREECE
\"HU\" - HUNGARY
\"IS\" - ICELAND
\"IN\" - INDIA
\"IE\" - IRELAND
\"IT\" - ITALY
\"JP\" - JAPAN
\"KZ\" - KAZAKHSTAN
\"KR\" - KOREA
\"LV\" - LATVIA
\"LI\" - LIECHTENSTEIN
\"LT\" - LITHUANIA
\"LU\" - LUXEMBOURG
\"MK\" - MACEDONIA
\"MT\" - MALTA
\"MX\" - MEXICO
\"MD\" - MOLDOVA
\"ME\" - MONTENEGRO
\"NL\" - NETHERLANDS
\"NZ\" - NEW ZEALAND
\"NI\" - NICARAGUA
\"NG\" - NIGERIA
\"NO\" - NORWAY
\"PA\" - PANAMA
\"PY\" - PARAGUAY
\"PE\" - PERU
\"PL\" - POLAND
\"PT\" - PORTUGAL
\"RO\" - ROMANIA
\"RU\" - RUSSIA
\"RS\" - SERBIA
\"SK\" - SLOVAKIA
\"SI\" - SLOVENIA
\"ZA\" - SOUTH AFRICA
\"ES\" - SPAIN
\"SE\" - SWEDEN
\"CH\" - SWITZERLAND
\"UA\" - UKRAINE
\"AE\" - UNITED ARAB EMIRATES
\"US\" - UNITED STATES
\"UK\" - UNITED KINGDOM
\"UY\" - URUGUAY
\"VE\" - VENEZUELA
Amazon HealthLake is a HIPAA eligibile service that allows customers to store, transform, query, and analyze their data in a consistent fashion in the cloud.
", + "operations": { + "CreateFHIRDatastore": "Creates a datastore that can ingest and export FHIR data.
", + "DeleteFHIRDatastore": "Deletes a datastore.
", + "DescribeFHIRDatastore": "Gets the properties associated with the FHIR datastore, including the datastore ID, datastore ARN, datastore name, datastore status, created at, datastore type version, and datastore endpoint.
", + "DescribeFHIRImportJob": "Displays the properties of a FHIR import job, including the ID, ARN, name, and the status of the datastore.
", + "ListFHIRDatastores": "Lists all FHIR datastores that are in the user’s account, regardless of datastore status.
", + "StartFHIRImportJob": "Begins a FHIR Import job.
" + }, + "shapes": { + "AccessDeniedException": { + "base": "Access is denied. Your account is not authorized to perform this operation.
", + "refs": { + } + }, + "BoundedLengthString": { + "base": null, + "refs": { + "CreateFHIRDatastoreResponse$DatastoreEndpoint": "The AWS endpoint for the created datastore. For preview, only US-east-1 endpoints are supported.
", + "DeleteFHIRDatastoreResponse$DatastoreEndpoint": "The AWS endpoint for the datastore the user has requested to be deleted.
" + } + }, + "ClientTokenString": { + "base": null, + "refs": { + "CreateFHIRDatastoreRequest$ClientToken": "Optional user provided token used for ensuring idempotency.
", + "StartFHIRImportJobRequest$ClientToken": "Optional user provided token used for ensuring idempotency.
" + } + }, + "ConflictException": { + "base": "The datastore is in a transition state and the user requested action can not be performed.
", + "refs": { + } + }, + "CreateFHIRDatastoreRequest": { + "base": null, + "refs": { + } + }, + "CreateFHIRDatastoreResponse": { + "base": null, + "refs": { + } + }, + "DatastoreArn": { + "base": null, + "refs": { + "CreateFHIRDatastoreResponse$DatastoreArn": "The datastore ARN is generated during the creation of the datastore and can be found in the output from the initial datastore creation call.
", + "DatastoreProperties$DatastoreArn": "The Amazon Resource Name used in the creation of the datastore.
", + "DeleteFHIRDatastoreResponse$DatastoreArn": "The Amazon Resource Name (ARN) that gives Amazon HealthLake access permission.
" + } + }, + "DatastoreFilter": { + "base": "The filters applied to datastore query.
", + "refs": { + "ListFHIRDatastoresRequest$Filter": "Lists all filters associated with a FHIR datastore request.
" + } + }, + "DatastoreId": { + "base": null, + "refs": { + "CreateFHIRDatastoreResponse$DatastoreId": "The AWS-generated datastore id. This id is in the output from the initial datastore creation call.
", + "DatastoreProperties$DatastoreId": "The AWS-generated ID number for the datastore.
", + "DeleteFHIRDatastoreRequest$DatastoreId": "The AWS-generated ID for the datastore to be deleted.
", + "DeleteFHIRDatastoreResponse$DatastoreId": "The AWS-generated ID for the datastore to be deleted.
", + "DescribeFHIRDatastoreRequest$DatastoreId": "The AWS-generated datastore id. This is part of the ‘CreateFHIRDatastore’ output.
", + "DescribeFHIRImportJobRequest$DatastoreId": "The AWS-generated ID of the datastore.
", + "ImportJobProperties$DatastoreId": "The datastore id used when the Import job was created.
", + "StartFHIRImportJobRequest$DatastoreId": "The AWS-generated datastore ID.
", + "StartFHIRImportJobResponse$DatastoreId": "The AWS-generated datastore ID.
" + } + }, + "DatastoreName": { + "base": null, + "refs": { + "CreateFHIRDatastoreRequest$DatastoreName": "The user generated name for the datastore.
", + "DatastoreFilter$DatastoreName": "Allows the user to filter datastore results by name.
", + "DatastoreProperties$DatastoreName": "The user-generated name for the datastore.
" + } + }, + "DatastoreProperties": { + "base": "Displays the properties of the datastore, including the ID, Arn, name, and the status of the datastore.
", + "refs": { + "DatastorePropertiesList$member": null, + "DescribeFHIRDatastoreResponse$DatastoreProperties": "All properties associated with a datastore, including the datastore ID, datastore ARN, datastore name, datastore status, created at, datastore type version, and datastore endpoint.
" + } + }, + "DatastorePropertiesList": { + "base": null, + "refs": { + "ListFHIRDatastoresResponse$DatastorePropertiesList": "All properties associated with the listed datastores.
" + } + }, + "DatastoreStatus": { + "base": null, + "refs": { + "CreateFHIRDatastoreResponse$DatastoreStatus": "The status of the FHIR datastore. Possible statuses are ‘CREATING’, ‘ACTIVE’, ‘DELETING’, ‘DELETED’.
", + "DatastoreFilter$DatastoreStatus": "Allows the user to filter datastore results by status.
", + "DatastoreProperties$DatastoreStatus": "The status of the datastore. Possible statuses are 'CREATING', 'ACTIVE', 'DELETING', or 'DELETED'.
", + "DeleteFHIRDatastoreResponse$DatastoreStatus": "The status of the datastore that the user has requested to be deleted.
" + } + }, + "DeleteFHIRDatastoreRequest": { + "base": null, + "refs": { + } + }, + "DeleteFHIRDatastoreResponse": { + "base": null, + "refs": { + } + }, + "DescribeFHIRDatastoreRequest": { + "base": null, + "refs": { + } + }, + "DescribeFHIRDatastoreResponse": { + "base": null, + "refs": { + } + }, + "DescribeFHIRImportJobRequest": { + "base": null, + "refs": { + } + }, + "DescribeFHIRImportJobResponse": { + "base": null, + "refs": { + } + }, + "FHIRVersion": { + "base": null, + "refs": { + "CreateFHIRDatastoreRequest$DatastoreTypeVersion": "The FHIR version of the datastore. The only supported version is R4.
", + "DatastoreProperties$DatastoreTypeVersion": "The FHIR version. Only R4 version data is supported.
" + } + }, + "IamRoleArn": { + "base": null, + "refs": { + "ImportJobProperties$DataAccessRoleArn": "The Amazon Resource Name (ARN) that gives Amazon HealthLake access to your input data.
", + "StartFHIRImportJobRequest$DataAccessRoleArn": "The Amazon Resource Name (ARN) that gives Amazon HealthLake access permission.
" + } + }, + "ImportJobProperties": { + "base": "Displays the properties of the import job, including the ID, Arn, Name, and the status of the datastore.
", + "refs": { + "DescribeFHIRImportJobResponse$ImportJobProperties": "The properties of the Import job request, including the ID, ARN, name, and the status of the datastore.
" + } + }, + "InputDataConfig": { + "base": "The input properties for an import job.
", + "refs": { + "ImportJobProperties$InputDataConfig": "The input data configuration that was supplied when the Import job was created.
", + "StartFHIRImportJobRequest$InputDataConfig": "The input properties of the FHIR Import job in the StartFHIRImport job request.
" + } + }, + "InternalServerException": { + "base": "Unknown error occurs in the service.
", + "refs": { + } + }, + "JobId": { + "base": null, + "refs": { + "DescribeFHIRImportJobRequest$JobId": "The AWS-generated job ID.
", + "ImportJobProperties$JobId": "The AWS-generated id number for the Import job.
", + "StartFHIRImportJobResponse$JobId": "The AWS-generated job ID.
" + } + }, + "JobName": { + "base": null, + "refs": { + "ImportJobProperties$JobName": "The user-generated name for an Import job.
", + "StartFHIRImportJobRequest$JobName": "The name of the FHIR Import job in the StartFHIRImport job request.
" + } + }, + "JobStatus": { + "base": null, + "refs": { + "ImportJobProperties$JobStatus": "The job status for an Import job. Possible statuses are SUBMITTED, IN_PROGRESS, COMPLETED, FAILED.
", + "StartFHIRImportJobResponse$JobStatus": "The status of an import job.
" + } + }, + "ListFHIRDatastoresRequest": { + "base": null, + "refs": { + } + }, + "ListFHIRDatastoresResponse": { + "base": null, + "refs": { + } + }, + "MaxResultsInteger": { + "base": null, + "refs": { + "ListFHIRDatastoresRequest$MaxResults": "The maximum number of datastores returned in a single page of a ListFHIRDatastoresRequest call.
" + } + }, + "Message": { + "base": null, + "refs": { + "ImportJobProperties$Message": "An explanation of any errors that may have occurred during the FHIR import job.
" + } + }, + "NextToken": { + "base": null, + "refs": { + "ListFHIRDatastoresRequest$NextToken": "Fetches the next page of datastores when results are paginated.
", + "ListFHIRDatastoresResponse$NextToken": "Pagination token that can be used to retrieve the next page of results.
" + } + }, + "PreloadDataConfig": { + "base": "The input properties for the preloaded datastore. Only data preloaded from Synthea is supported.
", + "refs": { + "CreateFHIRDatastoreRequest$PreloadDataConfig": "Optional parameter to preload data upon creation of the datastore. Currently, the only supported preloaded data is synthetic data generated from Synthea.
", + "DatastoreProperties$PreloadDataConfig": "The preloaded data configuration for the datastore. Only data preloaded from Synthea is supported.
" + } + }, + "PreloadDataType": { + "base": null, + "refs": { + "PreloadDataConfig$PreloadDataType": "The type of preloaded data. Only Synthea preloaded data is supported.
" + } + }, + "ResourceNotFoundException": { + "base": "The requested datastore was not found.
", + "refs": { + } + }, + "S3Uri": { + "base": null, + "refs": { + "InputDataConfig$S3Uri": "The S3Uri is the user specified S3 location of the FHIR data to be imported into Amazon HealthLake.
" + } + }, + "StartFHIRImportJobRequest": { + "base": null, + "refs": { + } + }, + "StartFHIRImportJobResponse": { + "base": null, + "refs": { + } + }, + "String": { + "base": null, + "refs": { + "AccessDeniedException$Message": null, + "ConflictException$Message": null, + "DatastoreProperties$DatastoreEndpoint": "The AWS endpoint for the datastore. Each datastore will have it's own endpoint with datastore ID in the endpoint URL.
", + "InternalServerException$Message": null, + "ResourceNotFoundException$Message": null, + "ThrottlingException$Message": null, + "ValidationException$Message": null + } + }, + "ThrottlingException": { + "base": "The user has exceeded their maximum number of allowed calls to the given API.
", + "refs": { + } + }, + "Timestamp": { + "base": null, + "refs": { + "DatastoreFilter$CreatedBefore": "A filter that allows the user to set cutoff dates for records. All datastores created before the specified date will be included in the results.
", + "DatastoreFilter$CreatedAfter": "A filter that allows the user to set cutoff dates for records. All datastores created after the specified date will be included in the results.
", + "DatastoreProperties$CreatedAt": "The time that a datastore was created.
", + "ImportJobProperties$SubmitTime": "The time that the Import job was submitted for processing.
", + "ImportJobProperties$EndTime": "The time that the Import job was completed.
" + } + }, + "ValidationException": { + "base": "The user input parameter was invalid.
", + "refs": { + } + } + } +} diff --git a/models/apis/healthlake/2017-07-01/examples-1.json b/models/apis/healthlake/2017-07-01/examples-1.json new file mode 100644 index 00000000000..0ea7e3b0bbe --- /dev/null +++ b/models/apis/healthlake/2017-07-01/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/models/apis/healthlake/2017-07-01/paginators-1.json b/models/apis/healthlake/2017-07-01/paginators-1.json new file mode 100644 index 00000000000..c134891ac25 --- /dev/null +++ b/models/apis/healthlake/2017-07-01/paginators-1.json @@ -0,0 +1,9 @@ +{ + "pagination": { + "ListFHIRDatastores": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + } + } +} diff --git a/models/apis/kendra/2019-02-03/api-2.json b/models/apis/kendra/2019-02-03/api-2.json index 92188a7652e..7572918443a 100644 --- a/models/apis/kendra/2019-02-03/api-2.json +++ b/models/apis/kendra/2019-02-03/api-2.json @@ -917,7 +917,8 @@ "SalesforceConfiguration":{"shape":"SalesforceConfiguration"}, "OneDriveConfiguration":{"shape":"OneDriveConfiguration"}, "ServiceNowConfiguration":{"shape":"ServiceNowConfiguration"}, - "ConfluenceConfiguration":{"shape":"ConfluenceConfiguration"} + "ConfluenceConfiguration":{"shape":"ConfluenceConfiguration"}, + "GoogleDriveConfiguration":{"shape":"GoogleDriveConfiguration"} } }, "DataSourceDateFieldFormat":{ @@ -1064,7 +1065,8 @@ "ONEDRIVE", "SERVICENOW", "CUSTOM", - "CONFLUENCE" + "CONFLUENCE", + "GOOGLEDRIVE" ] }, "DataSourceVpcConfiguration":{ @@ -1381,6 +1383,24 @@ "min":1, "pattern":"^\\P{C}*$" }, + "ExcludeMimeTypesList":{ + "type":"list", + "member":{"shape":"MimeType"}, + "max":30, + "min":0 + }, + "ExcludeSharedDrivesList":{ + "type":"list", + "member":{"shape":"SharedDriveId"}, + "max":100, + "min":0 + }, + "ExcludeUserAccountsList":{ + "type":"list", + "member":{"shape":"UserAccount"}, + "max":100, + "min":0 + }, "Facet":{ "type":"structure", "members":{ @@ -1455,6 +1475,25 @@ "type":"list", "member":{"shape":"FaqSummary"} }, + "FeedbackToken":{ + "type":"string", + "max":2048, + "min":1, + "pattern":"^\\P{C}*.\\P{C}*$" + }, + "GoogleDriveConfiguration":{ + "type":"structure", + "required":["SecretArn"], + "members":{ + "SecretArn":{"shape":"SecretArn"}, + "InclusionPatterns":{"shape":"DataSourceInclusionsExclusionsStrings"}, + "ExclusionPatterns":{"shape":"DataSourceInclusionsExclusionsStrings"}, + "FieldMappings":{"shape":"DataSourceToIndexFieldMappingList"}, + "ExcludeMimeTypes":{"shape":"ExcludeMimeTypesList"}, + "ExcludeUserAccounts":{"shape":"ExcludeUserAccountsList"}, + "ExcludeSharedDrives":{"shape":"ExcludeSharedDrivesList"} + } + }, "GroupAttributeField":{ "type":"string", "max":100, @@ -1719,6 +1758,12 @@ "type":"string", "pattern":"(([1-9][0-9]*)|0)" }, + "MimeType":{ + "type":"string", + "max":256, + "min":1, + "pattern":"^\\P{C}*$" + }, "NextToken":{ "type":"string", "max":800, @@ -1829,7 +1874,8 @@ "PageNumber":{"shape":"Integer"}, "PageSize":{"shape":"Integer"}, "SortingConfiguration":{"shape":"SortingConfiguration"}, - "UserContext":{"shape":"UserContext"} + "UserContext":{"shape":"UserContext"}, + "VisitorId":{"shape":"VisitorId"} } }, "QueryResult":{ @@ -1852,7 +1898,8 @@ "DocumentExcerpt":{"shape":"TextWithHighlights"}, "DocumentURI":{"shape":"Url"}, "DocumentAttributes":{"shape":"DocumentAttributeList"}, - "ScoreAttributes":{"shape":"ScoreAttributes"} + "ScoreAttributes":{"shape":"ScoreAttributes"}, + "FeedbackToken":{"shape":"FeedbackToken"} } }, "QueryResultItemList":{ @@ -2264,6 +2311,12 @@ "type":"string", "enum":["SHAREPOINT_ONLINE"] }, + "SharedDriveId":{ + "type":"string", + "max":256, + "min":1, + "pattern":"^\\P{C}*$" + }, "SortOrder":{ "type":"string", "enum":[ @@ -2503,6 +2556,12 @@ "min":1, "pattern":"^(https?|ftp|file):\\/\\/([^\\s]*)" }, + "UserAccount":{ + "type":"string", + "max":256, + "min":1, + "pattern":"^\\P{C}*$" + }, "UserContext":{ "type":"structure", "members":{ @@ -2551,6 +2610,12 @@ "max":50, "min":1 }, + "VisitorId":{ + "type":"string", + "max":256, + "min":1, + "pattern":"[a-zA-Z0-9][a-zA-Z0-9_-]*" + }, "VpcSecurityGroupId":{ "type":"string", "max":200, diff --git a/models/apis/kendra/2019-02-03/docs-2.json b/models/apis/kendra/2019-02-03/docs-2.json index e711f27c003..3d00edc27a3 100644 --- a/models/apis/kendra/2019-02-03/docs-2.json +++ b/models/apis/kendra/2019-02-03/docs-2.json @@ -29,9 +29,9 @@ }, "shapes": { "AccessControlListConfiguration": { - "base": "Access Control List files for the documents in a data source.
", + "base": "Access Control List files for the documents in a data source. For the format of the file, see Access control for S3 data sources.
", "refs": { - "S3DataSourceConfiguration$AccessControlListConfiguration": "Provides the path to the S3 bucket that contains the user context filtering files for the data source.
" + "S3DataSourceConfiguration$AccessControlListConfiguration": "Provides the path to the S3 bucket that contains the user context filtering files for the data source. For the format of the file, see Access control for S3 data sources.
" } }, "AccessDeniedException": { @@ -443,6 +443,8 @@ "refs": { "ConfluenceConfiguration$InclusionPatterns": "A list of regular expression patterns that apply to a URL on the Confluence server. An inclusion pattern can apply to a blog post, a page, a space, or an attachment. Items that match the patterns are included in the index. Items that don't match the pattern are excluded from the index. If an item matches both an inclusion pattern and an exclusion pattern, the item isn't included in the index.
", "ConfluenceConfiguration$ExclusionPatterns": "A list of regular expression patterns that apply to a URL on the Confluence server. An exclusion pattern can apply to a blog post, a page, a space, or an attachment. Items that match the pattern are excluded from the index. Items that don't match the pattern are included in the index. If a item matches both an exclusion pattern and an inclusion pattern, the item isn't included in the index.
", + "GoogleDriveConfiguration$InclusionPatterns": "A list of regular expression patterns that apply to path on Google Drive. Items that match the pattern are included in the index from both shared drives and users' My Drives. Items that don't match the pattern are excluded from the index. If an item matches both an inclusion pattern and an exclusion pattern, it is excluded from the index.
", + "GoogleDriveConfiguration$ExclusionPatterns": "A list of regular expression patterns that apply to the path on Google Drive. Items that match the pattern are excluded from the index from both shared drives and users' My Drives. Items that don't match the pattern are included in the index. If an item matches both an exclusion pattern and an inclusion pattern, it is excluded from the index.
", "OneDriveConfiguration$InclusionPatterns": "A list of regular expression patterns. Documents that match the pattern are included in the index. Documents that don't match the pattern are excluded from the index. If a document matches both an inclusion pattern and an exclusion pattern, the document is not included in the index.
The exclusion pattern is applied to the file name.
", "OneDriveConfiguration$ExclusionPatterns": "List of regular expressions applied to documents. Items that match the exclusion pattern are not indexed. If you provide both an inclusion pattern and an exclusion pattern, any item that matches the exclusion pattern isn't indexed.
The exclusion pattern is applied to the file name.
", "S3DataSourceConfiguration$InclusionPrefixes": "A list of S3 prefixes for the documents that should be included in the index.
", @@ -539,6 +541,7 @@ "base": null, "refs": { "ColumnConfiguration$FieldMappings": "An array of objects that map database column names to the corresponding fields in an index. You must first create the fields in the index using the UpdateIndex operation.
", + "GoogleDriveConfiguration$FieldMappings": "Defines mapping between a field in the Google Drive and a Amazon Kendra index field.
If you are using the console, you can define index fields when creating the mapping. If you are using the API, you must first create the field using the UpdateIndex operation.
", "OneDriveConfiguration$FieldMappings": "A list of DataSourceToIndexFieldMapping objects that map Microsoft OneDrive fields to custom fields in the Amazon Kendra index. You must first create the index fields before you map OneDrive fields.
Maps fields from a Salesforce chatter feed into Amazon Kendra index fields.
", "SalesforceCustomKnowledgeArticleTypeConfiguration$FieldMappings": "One or more objects that map fields in the custom knowledge article to fields in the Amazon Kendra index.
", @@ -822,6 +825,24 @@ "ValidationException$Message": null } }, + "ExcludeMimeTypesList": { + "base": null, + "refs": { + "GoogleDriveConfiguration$ExcludeMimeTypes": "A list of MIME types to exclude from the index. All documents matching the specified MIME type are excluded.
For a list of MIME types, see Using a Google Workspace Drive data source.
" + } + }, + "ExcludeSharedDrivesList": { + "base": null, + "refs": { + "GoogleDriveConfiguration$ExcludeSharedDrives": "A list of identifiers or shared drives to exclude from the index. All files and folders stored on the shared drive are excluded.
" + } + }, + "ExcludeUserAccountsList": { + "base": null, + "refs": { + "GoogleDriveConfiguration$ExcludeUserAccounts": "A list of email addresses of the users. Documents owned by these users are excluded from the index. Documents shared with excluded users are indexed unless they are excluded in another way.
" + } + }, "Facet": { "base": "Information about a document attribute
", "refs": { @@ -897,6 +918,18 @@ "ListFaqsResponse$FaqSummaryItems": "information about the FAQs associated with the specified index.
" } }, + "FeedbackToken": { + "base": null, + "refs": { + "QueryResultItem$FeedbackToken": "A token that identifies a particular result from a particular query. Use this token to provide click-through feedback for the result. For more information, see Submitting feedback .
" + } + }, + "GoogleDriveConfiguration": { + "base": "Provides configuration information for data sources that connect to Google Drive.
", + "refs": { + "DataSourceConfiguration$GoogleDriveConfiguration": "Provides configuration for data sources that connect to Google Drive.
" + } + }, "GroupAttributeField": { "base": null, "refs": { @@ -1157,6 +1190,12 @@ "DataSourceSyncJobMetrics$DocumentsScanned": "The current number of documents crawled by the current sync job in the data source.
" } }, + "MimeType": { + "base": null, + "refs": { + "ExcludeMimeTypesList$member": null + } + }, "NextToken": { "base": null, "refs": { @@ -1173,7 +1212,7 @@ "OneDriveConfiguration": { "base": "Provides configuration information for data sources that connect to OneDrive.
", "refs": { - "DataSourceConfiguration$OneDriveConfiguration": "Provided configuration for data sources that connect to Microsoft OneDrive.
" + "DataSourceConfiguration$OneDriveConfiguration": "Provides configuration for data sources that connect to Microsoft OneDrive.
" } }, "OneDriveUser": { @@ -1502,6 +1541,7 @@ "refs": { "ConfluenceConfiguration$SecretArn": "The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that contains the key/value pairs required to connect to your Confluence server. The secret must contain a JSON structure with the following keys:
username - The user name or email address of a user with administrative privileges for the Confluence server.
password - The password associated with the user logging in to the Confluence server.
The Amazon Resource Name (ARN) of credentials stored in AWS Secrets Manager. The credentials should be a user/password pair. For more information, see Using a Database Data Source. For more information about AWS Secrets Manager, see What Is AWS Secrets Manager in the AWS Secrets Manager user guide.
", + "GoogleDriveConfiguration$SecretArn": "The Amazon Resource Name (ARN) of a AWS Secrets Manager secret that contains the credentials required to connect to Google Drive. For more information, see Using a Google Workspace Drive data source.
", "OneDriveConfiguration$SecretArn": "The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that contains the user name and password to connect to OneDrive. The user namd should be the application ID for the OneDrive application, and the password is the application key for the OneDrive application.
", "SalesforceConfiguration$SecretArn": "The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that contains the key/value pairs required to connect to your Salesforce instance. The secret must contain a JSON structure with the following keys:
authenticationUrl - The OAUTH endpoint that Amazon Kendra connects to get an OAUTH token.
consumerKey - The application public key generated when you created your Salesforce application.
consumerSecret - The application private key generated when you created your Salesforce application.
password - The password associated with the user logging in to the Salesforce instance.
securityToken - The token associated with the user account logging in to the Salesforce instance.
username - The user name of the user logging in to the Salesforce instance.
The Amazon Resource Name (ARN) of the AWS Secret Manager secret that contains the user name and password required to connect to the ServiceNow instance.
", @@ -1574,6 +1614,12 @@ "SharePointConfiguration$SharePointVersion": "The version of Microsoft SharePoint that you are using as a data source.
" } }, + "SharedDriveId": { + "base": null, + "refs": { + "ExcludeSharedDrivesList$member": null + } + }, "SortOrder": { "base": null, "refs": { @@ -1697,7 +1743,7 @@ "TenantDomain": { "base": null, "refs": { - "OneDriveConfiguration$TenantDomain": "Tha Azure Active Directory domain of the organization.
" + "OneDriveConfiguration$TenantDomain": "The Azure Active Directory domain of the organization.
" } }, "TextDocumentStatistics": { @@ -1790,6 +1836,12 @@ "SharePointUrlList$member": null } }, + "UserAccount": { + "base": null, + "refs": { + "ExcludeUserAccountsList$member": null + } + }, "UserContext": { "base": "Provides information about the user context for a Amazon Kendra index.
", "refs": { @@ -1841,6 +1893,12 @@ "ValueImportanceMap$key": null } }, + "VisitorId": { + "base": null, + "refs": { + "QueryRequest$VisitorId": "Provides an identifier for a specific user. The VisitorId should be a unique identifier, such as a GUID. Don't use personally identifiable information, such as the user's email address, as the VisitorId.
A list of one or more dashboard ids that you want to add to a session that includes anonymous authorizations. IdentityType must be set to ANONYMOUS for this to work, because other other identity types authenticate as QuickSight users. For example, if you set \"--dashboard-id dash_id1 --dashboard-id dash_id2 dash_id3 identity-type ANONYMOUS\", the session can access all three dashboards.
A list of one or more dashboard ids that you want to add to a session that includes anonymous authorizations. IdentityType must be set to ANONYMOUS for this to work, because other identity types authenticate as QuickSight users. For example, if you set \"--dashboard-id dash_id1 --dashboard-id dash_id2 dash_id3 identity-type ANONYMOUS\", the session can access all three dashboards.
Remove the undo/redo button on the embedded dashboard. The default is FALSE, which enables the undo/redo button.
", "GetDashboardEmbedUrlRequest$ResetDisabled": "Remove the reset button on the embedded dashboard. The default is FALSE, which enables the reset button.
", "GetDashboardEmbedUrlRequest$StatePersistenceEnabled": "Adds persistence of state for the user session in an embedded dashboard. Persistence applies to the sheet and the parameter settings. These are control settings that the dashboard subscriber (QuickSight reader) chooses while viewing the dashboard. If this is set to TRUE, the settings are the same when the the subscriber reopens the same dashboard URL. The state is stored in QuickSight, not in a browser cookie. If this is set to FALSE, the state of the user session is not persisted. The default is FALSE.
Indicates that a row in a table is uniquely identified by the columns in a join key. This is used by QuickSight to optimize query performance.
", "SslProperties$DisableSsl": "A Boolean option to control whether SSL should be disabled.
", "UpdateUserRequest$UnapplyCustomPermissions": "A flag that you use to indicate that you want to remove all custom permissions from this user. Using this parameter resets the user to the state it was in before a custom permissions profile was applied. This parameter defaults to NULL and it doesn't accept any other value.
", "UploadSettings$ContainsHeader": "Whether the file has a header row, or the files each have a header row.
", @@ -1972,15 +1973,22 @@ } }, "JoinInstruction": { - "base": "Join instruction.
", + "base": "The instructions associated with a join.
", "refs": { "LogicalTableSource$JoinInstruction": "Specifies the result of a join of two logical tables.
" } }, + "JoinKeyProperties": { + "base": "Properties associated with the columns participating in a join.
", + "refs": { + "JoinInstruction$LeftJoinKeyProperties": "Join key properties of the left operand.
", + "JoinInstruction$RightJoinKeyProperties": "Join key properties of the right operand.
" + } + }, "JoinType": { "base": null, "refs": { - "JoinInstruction$Type": "Type.
" + "JoinInstruction$Type": "The type of join that it is.
" } }, "LimitExceededException": { @@ -2203,8 +2211,8 @@ "LogicalTableId": { "base": null, "refs": { - "JoinInstruction$LeftOperand": "Left operand.
", - "JoinInstruction$RightOperand": "Right operand.
", + "JoinInstruction$LeftOperand": "The operand on the left side of a join.
", + "JoinInstruction$RightOperand": "The operand on the right side of a join.
", "LogicalTableMap$key": null } }, @@ -2376,7 +2384,7 @@ "OnClause": { "base": null, "refs": { - "JoinInstruction$OnClause": "On Clause.
" + "JoinInstruction$OnClause": "The join instructions provided in the ON clause of a join.
The Amazon SageMaker runtime API.
", "operations": { - "InvokeEndpoint": "After you deploy a model into production using Amazon SageMaker hosting services, your client applications use this API to get inferences from the model hosted at the specified endpoint.
For an overview of Amazon SageMaker, see How It Works.
Amazon SageMaker strips all POST headers except those supported by the API. Amazon SageMaker might add additional headers. You should not rely on the behavior of headers outside those enumerated in the request syntax.
Calls to InvokeEndpoint are authenticated by using AWS Signature Version 4. For information, see Authenticating Requests (AWS Signature Version 4) in the Amazon S3 API Reference.
A customer's model containers must respond to requests within 60 seconds. The model itself can have a maximum processing time of 60 seconds before responding to the /invocations. If your model is going to take 50-60 seconds of processing time, the SDK socket timeout should be set to be 70 seconds.
Endpoints are scoped to an individual account, and are not public. The URL does not contain the account ID, but Amazon SageMaker determines the account ID from the authentication token that is supplied by the caller.
After you deploy a model into production using Amazon SageMaker hosting services, your client applications use this API to get inferences from the model hosted at the specified endpoint.
For an overview of Amazon SageMaker, see How It Works.
Amazon SageMaker strips all POST headers except those supported by the API. Amazon SageMaker might add additional headers. You should not rely on the behavior of headers outside those enumerated in the request syntax.
Calls to InvokeEndpoint are authenticated by using AWS Signature Version 4. For information, see Authenticating Requests (AWS Signature Version 4) in the Amazon S3 API Reference.
A customer's model containers must respond to requests within 60 seconds. The model itself can have a maximum processing time of 60 seconds before responding to invocations. If your model is going to take 50-60 seconds of processing time, the SDK socket timeout should be set to be 70 seconds.
Endpoints are scoped to an individual account, and are not public. The URL does not contain the account ID, but Amazon SageMaker determines the account ID from the authentication token that is supplied by the caller.
Provides additional information about a request for an inference submitted to a model hosted at an Amazon SageMaker endpoint. The information is an opaque value that is forwarded verbatim. You could use this value, for example, to provide an ID that you can use to track a request or to provide other metadata that a service endpoint was programmed to process. The value must consist of no more than 1024 visible US-ASCII characters as specified in Section 3.3.6. Field Value Components of the Hypertext Transfer Protocol (HTTP/1.1). This feature is currently supported in the AWS SDKs but not in the Amazon SageMaker Python SDK.
", - "InvokeEndpointOutput$CustomAttributes": "Provides additional information in the response about the inference returned by a model hosted at an Amazon SageMaker endpoint. The information is an opaque value that is forwarded verbatim. You could use this value, for example, to return an ID received in the CustomAttributes header of a request or other metadata that a service endpoint was programmed to produce. The value must consist of no more than 1024 visible US-ASCII characters as specified in Section 3.3.6. Field Value Components of the Hypertext Transfer Protocol (HTTP/1.1). If the customer wants the custom attribute returned, the model must set the custom attribute to be included on the way back.
This feature is currently supported in the AWS SDKs but not in the Amazon SageMaker Python SDK.
" + "InvokeEndpointInput$CustomAttributes": "Provides additional information about a request for an inference submitted to a model hosted at an Amazon SageMaker endpoint. The information is an opaque value that is forwarded verbatim. You could use this value, for example, to provide an ID that you can use to track a request or to provide other metadata that a service endpoint was programmed to process. The value must consist of no more than 1024 visible US-ASCII characters as specified in Section 3.3.6. Field Value Components of the Hypertext Transfer Protocol (HTTP/1.1).
The code in your model is responsible for setting or updating any custom attributes in the response. If your code does not set this value in the response, an empty value is returned. For example, if a custom attribute represents the trace ID, your model can prepend the custom attribute with Trace ID: in your post-processing function.
This feature is currently supported in the AWS SDKs but not in the Amazon SageMaker Python SDK.
", + "InvokeEndpointOutput$CustomAttributes": "Provides additional information in the response about the inference returned by a model hosted at an Amazon SageMaker endpoint. The information is an opaque value that is forwarded verbatim. You could use this value, for example, to return an ID received in the CustomAttributes header of a request or other metadata that a service endpoint was programmed to produce. The value must consist of no more than 1024 visible US-ASCII characters as specified in Section 3.3.6. Field Value Components of the Hypertext Transfer Protocol (HTTP/1.1). If the customer wants the custom attribute returned, the model must set the custom attribute to be included on the way back.
The code in your model is responsible for setting or updating any custom attributes in the response. If your code does not set this value in the response, an empty value is returned. For example, if a custom attribute represents the trace ID, your model can prepend the custom attribute with Trace ID: in your post-processing function.
This feature is currently supported in the AWS SDKs but not in the Amazon SageMaker Python SDK.
" } }, "EndpointName": { @@ -34,6 +34,12 @@ "InvokeEndpointOutput$InvokedProductionVariant": "Identifies the production variant that was invoked.
" } }, + "InferenceId": { + "base": null, + "refs": { + "InvokeEndpointInput$InferenceId": "If you provide a value, it is added to the captured data when you enable data capture on the endpoint. For information about data capture, see Capture Data.
" + } + }, "InternalFailure": { "base": "An internal failure occurred.
", "refs": { @@ -84,13 +90,13 @@ "TargetModelHeader": { "base": null, "refs": { - "InvokeEndpointInput$TargetModel": "The model to request for inference when invoking a multi-model endpoint.
" + "InvokeEndpointInput$TargetModel": "The model to request for inference when invoking a multi-model endpoint.
" } }, "TargetVariantHeader": { "base": null, "refs": { - "InvokeEndpointInput$TargetVariant": "Specify the production variant to send the inference request to when invoking an endpoint that is running two or more variants. Note that this parameter overrides the default behavior for the endpoint, which is to distribute the invocation traffic based on the variant weights.
" + "InvokeEndpointInput$TargetVariant": "Specify the production variant to send the inference request to when invoking an endpoint that is running two or more variants. Note that this parameter overrides the default behavior for the endpoint, which is to distribute the invocation traffic based on the variant weights.
For information about how to use variant targeting to perform a/b testing, see Test models in production
" } }, "ValidationError": { diff --git a/models/apis/sagemaker-edge/2020-09-23/api-2.json b/models/apis/sagemaker-edge/2020-09-23/api-2.json new file mode 100644 index 00000000000..388b0f2a94d --- /dev/null +++ b/models/apis/sagemaker-edge/2020-09-23/api-2.json @@ -0,0 +1,157 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2020-09-23", + "endpointPrefix":"edge.sagemaker", + "jsonVersion":"1.1", + "protocol":"rest-json", + "serviceFullName":"Amazon Sagemaker Edge Manager", + "serviceId":"Sagemaker Edge", + "signatureVersion":"v4", + "signingName":"sagemaker", + "uid":"sagemaker-edge-2020-09-23" + }, + "operations":{ + "GetDeviceRegistration":{ + "name":"GetDeviceRegistration", + "http":{ + "method":"POST", + "requestUri":"/GetDeviceRegistration" + }, + "input":{"shape":"GetDeviceRegistrationRequest"}, + "output":{"shape":"GetDeviceRegistrationResult"}, + "errors":[ + {"shape":"InternalServiceException"} + ] + }, + "SendHeartbeat":{ + "name":"SendHeartbeat", + "http":{ + "method":"POST", + "requestUri":"/SendHeartbeat" + }, + "input":{"shape":"SendHeartbeatRequest"}, + "errors":[ + {"shape":"InternalServiceException"} + ] + } + }, + "shapes":{ + "CacheTTLSeconds":{ + "type":"string", + "max":1000, + "min":1 + }, + "DeviceFleetName":{ + "type":"string", + "max":63, + "min":1, + "pattern":"^[a-zA-Z0-9](-*_*[a-zA-Z0-9])*$" + }, + "DeviceName":{ + "type":"string", + "max":63, + "min":1, + "pattern":"^[a-zA-Z0-9](-*_*[a-zA-Z0-9])*$" + }, + "DeviceRegistration":{ + "type":"string", + "max":1000, + "min":1 + }, + "Dimension":{ + "type":"string", + "max":1000, + "min":1, + "pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9\\/])*$" + }, + "EdgeMetric":{ + "type":"structure", + "members":{ + "Dimension":{"shape":"Dimension"}, + "MetricName":{"shape":"Metric"}, + "Value":{"shape":"Value"}, + "Timestamp":{"shape":"Timestamp"} + } + }, + "EdgeMetrics":{ + "type":"list", + "member":{"shape":"EdgeMetric"} + }, + "ErrorMessage":{"type":"string"}, + "GetDeviceRegistrationRequest":{ + "type":"structure", + "required":[ + "DeviceName", + "DeviceFleetName" + ], + "members":{ + "DeviceName":{"shape":"DeviceName"}, + "DeviceFleetName":{"shape":"DeviceFleetName"} + } + }, + "GetDeviceRegistrationResult":{ + "type":"structure", + "members":{ + "DeviceRegistration":{"shape":"DeviceRegistration"}, + "CacheTTL":{"shape":"CacheTTLSeconds"} + } + }, + "InternalServiceException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "exception":true + }, + "Metric":{ + "type":"string", + "max":100, + "min":4, + "pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9])*$" + }, + "Model":{ + "type":"structure", + "members":{ + "ModelName":{"shape":"ModelName"}, + "ModelVersion":{"shape":"Version"}, + "LatestSampleTime":{"shape":"Timestamp"}, + "LatestInference":{"shape":"Timestamp"}, + "ModelMetrics":{"shape":"EdgeMetrics"} + } + }, + "ModelName":{ + "type":"string", + "max":255, + "min":4, + "pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9])*$" + }, + "Models":{ + "type":"list", + "member":{"shape":"Model"} + }, + "SendHeartbeatRequest":{ + "type":"structure", + "required":[ + "AgentVersion", + "DeviceName", + "DeviceFleetName" + ], + "members":{ + "AgentMetrics":{"shape":"EdgeMetrics"}, + "Models":{"shape":"Models"}, + "AgentVersion":{"shape":"Version"}, + "DeviceName":{"shape":"DeviceName"}, + "DeviceFleetName":{"shape":"DeviceFleetName"} + } + }, + "Timestamp":{"type":"timestamp"}, + "Value":{"type":"double"}, + "Version":{ + "type":"string", + "max":64, + "min":1, + "pattern":"[a-zA-Z0-9\\ \\_\\.]+" + } + } +} diff --git a/models/apis/sagemaker-edge/2020-09-23/docs-2.json b/models/apis/sagemaker-edge/2020-09-23/docs-2.json new file mode 100644 index 00000000000..5fb96c8930a --- /dev/null +++ b/models/apis/sagemaker-edge/2020-09-23/docs-2.json @@ -0,0 +1,126 @@ +{ + "version": "2.0", + "service": "SageMaker Edge Manager dataplane service for communicating with active agents.
", + "operations": { + "GetDeviceRegistration": "Use to check if a device is registered with SageMaker Edge Manager.
", + "SendHeartbeat": "Use to get the current status of devices registered on SageMaker Edge Manager.
" + }, + "shapes": { + "CacheTTLSeconds": { + "base": null, + "refs": { + "GetDeviceRegistrationResult$CacheTTL": "The amount of time, in seconds, that the registration status is stored on the device’s cache before it is refreshed.
" + } + }, + "DeviceFleetName": { + "base": null, + "refs": { + "GetDeviceRegistrationRequest$DeviceFleetName": "The name of the fleet that the device belongs to.
", + "SendHeartbeatRequest$DeviceFleetName": "The name of the fleet that the device belongs to.
" + } + }, + "DeviceName": { + "base": null, + "refs": { + "GetDeviceRegistrationRequest$DeviceName": "The unique name of the device you want to get the registration status from.
", + "SendHeartbeatRequest$DeviceName": "The unique name of the device.
" + } + }, + "DeviceRegistration": { + "base": null, + "refs": { + "GetDeviceRegistrationResult$DeviceRegistration": "Describes if the device is currently registered with SageMaker Edge Manager.
" + } + }, + "Dimension": { + "base": null, + "refs": { + "EdgeMetric$Dimension": "The dimension of metrics published.
" + } + }, + "EdgeMetric": { + "base": "Information required for edge device metrics.
", + "refs": { + "EdgeMetrics$member": null + } + }, + "EdgeMetrics": { + "base": null, + "refs": { + "Model$ModelMetrics": "Information required for model metrics.
", + "SendHeartbeatRequest$AgentMetrics": "For internal use. Returns a list of SageMaker Edge Manager agent operating metrics.
" + } + }, + "ErrorMessage": { + "base": null, + "refs": { + "InternalServiceException$Message": null + } + }, + "GetDeviceRegistrationRequest": { + "base": null, + "refs": { + } + }, + "GetDeviceRegistrationResult": { + "base": null, + "refs": { + } + }, + "InternalServiceException": { + "base": "An internal failure occurred. Try your request again. If the problem persists, contact AWS customer support.
", + "refs": { + } + }, + "Metric": { + "base": null, + "refs": { + "EdgeMetric$MetricName": "Returns the name of the metric.
" + } + }, + "Model": { + "base": "Information about a model deployed on an edge device that is registered with SageMaker Edge Manager.
", + "refs": { + "Models$member": null + } + }, + "ModelName": { + "base": null, + "refs": { + "Model$ModelName": "The name of the model.
" + } + }, + "Models": { + "base": null, + "refs": { + "SendHeartbeatRequest$Models": "Returns a list of models deployed on the the device.
" + } + }, + "SendHeartbeatRequest": { + "base": null, + "refs": { + } + }, + "Timestamp": { + "base": null, + "refs": { + "EdgeMetric$Timestamp": "Timestamp of when the metric was requested.
", + "Model$LatestSampleTime": "The timestamp of the last data sample taken.
", + "Model$LatestInference": "The timestamp of the last inference that was made.
" + } + }, + "Value": { + "base": null, + "refs": { + "EdgeMetric$Value": "Returns the value of the metric.
" + } + }, + "Version": { + "base": null, + "refs": { + "Model$ModelVersion": "The version of the model.
", + "SendHeartbeatRequest$AgentVersion": "Returns the version of the agent.
" + } + } + } +} diff --git a/models/apis/sagemaker-edge/2020-09-23/examples-1.json b/models/apis/sagemaker-edge/2020-09-23/examples-1.json new file mode 100644 index 00000000000..0ea7e3b0bbe --- /dev/null +++ b/models/apis/sagemaker-edge/2020-09-23/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/models/apis/sagemaker-edge/2020-09-23/paginators-1.json b/models/apis/sagemaker-edge/2020-09-23/paginators-1.json new file mode 100644 index 00000000000..5677bd8e4a2 --- /dev/null +++ b/models/apis/sagemaker-edge/2020-09-23/paginators-1.json @@ -0,0 +1,4 @@ +{ + "pagination": { + } +} diff --git a/models/apis/sagemaker/2017-07-24/api-2.json b/models/apis/sagemaker/2017-07-24/api-2.json index e01f6ca4993..e932e6d55cf 100644 --- a/models/apis/sagemaker/2017-07-24/api-2.json +++ b/models/apis/sagemaker/2017-07-24/api-2.json @@ -154,6 +154,31 @@ {"shape":"ResourceLimitExceeded"} ] }, + "CreateDataQualityJobDefinition":{ + "name":"CreateDataQualityJobDefinition", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateDataQualityJobDefinitionRequest"}, + "output":{"shape":"CreateDataQualityJobDefinitionResponse"}, + "errors":[ + {"shape":"ResourceLimitExceeded"}, + {"shape":"ResourceInUse"} + ] + }, + "CreateDeviceFleet":{ + "name":"CreateDeviceFleet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateDeviceFleetRequest"}, + "errors":[ + {"shape":"ResourceInUse"}, + {"shape":"ResourceLimitExceeded"} + ] + }, "CreateDomain":{ "name":"CreateDomain", "http":{ @@ -167,6 +192,17 @@ {"shape":"ResourceInUse"} ] }, + "CreateEdgePackagingJob":{ + "name":"CreateEdgePackagingJob", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateEdgePackagingJobRequest"}, + "errors":[ + {"shape":"ResourceLimitExceeded"} + ] + }, "CreateEndpoint":{ "name":"CreateEndpoint", "http":{ @@ -307,6 +343,32 @@ {"shape":"ResourceLimitExceeded"} ] }, + "CreateModelBiasJobDefinition":{ + "name":"CreateModelBiasJobDefinition", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateModelBiasJobDefinitionRequest"}, + "output":{"shape":"CreateModelBiasJobDefinitionResponse"}, + "errors":[ + {"shape":"ResourceLimitExceeded"}, + {"shape":"ResourceInUse"} + ] + }, + "CreateModelExplainabilityJobDefinition":{ + "name":"CreateModelExplainabilityJobDefinition", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateModelExplainabilityJobDefinitionRequest"}, + "output":{"shape":"CreateModelExplainabilityJobDefinitionResponse"}, + "errors":[ + {"shape":"ResourceLimitExceeded"}, + {"shape":"ResourceInUse"} + ] + }, "CreateModelPackage":{ "name":"CreateModelPackage", "http":{ @@ -332,6 +394,19 @@ {"shape":"ResourceLimitExceeded"} ] }, + "CreateModelQualityJobDefinition":{ + "name":"CreateModelQualityJobDefinition", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateModelQualityJobDefinitionRequest"}, + "output":{"shape":"CreateModelQualityJobDefinitionResponse"}, + "errors":[ + {"shape":"ResourceLimitExceeded"}, + {"shape":"ResourceInUse"} + ] + }, "CreateMonitoringSchedule":{ "name":"CreateMonitoringSchedule", "http":{ @@ -604,6 +679,28 @@ {"shape":"ResourceNotFound"} ] }, + "DeleteDataQualityJobDefinition":{ + "name":"DeleteDataQualityJobDefinition", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteDataQualityJobDefinitionRequest"}, + "errors":[ + {"shape":"ResourceNotFound"} + ] + }, + "DeleteDeviceFleet":{ + "name":"DeleteDeviceFleet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteDeviceFleetRequest"}, + "errors":[ + {"shape":"ResourceInUse"} + ] + }, "DeleteDomain":{ "name":"DeleteDomain", "http":{ @@ -714,6 +811,28 @@ }, "input":{"shape":"DeleteModelInput"} }, + "DeleteModelBiasJobDefinition":{ + "name":"DeleteModelBiasJobDefinition", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteModelBiasJobDefinitionRequest"}, + "errors":[ + {"shape":"ResourceNotFound"} + ] + }, + "DeleteModelExplainabilityJobDefinition":{ + "name":"DeleteModelExplainabilityJobDefinition", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteModelExplainabilityJobDefinitionRequest"}, + "errors":[ + {"shape":"ResourceNotFound"} + ] + }, "DeleteModelPackage":{ "name":"DeleteModelPackage", "http":{ @@ -741,6 +860,17 @@ }, "input":{"shape":"DeleteModelPackageGroupPolicyInput"} }, + "DeleteModelQualityJobDefinition":{ + "name":"DeleteModelQualityJobDefinition", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteModelQualityJobDefinitionRequest"}, + "errors":[ + {"shape":"ResourceNotFound"} + ] + }, "DeleteMonitoringSchedule":{ "name":"DeleteMonitoringSchedule", "http":{ @@ -854,6 +984,14 @@ {"shape":"ResourceLimitExceeded"} ] }, + "DeregisterDevices":{ + "name":"DeregisterDevices", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeregisterDevicesRequest"} + }, "DescribeAction":{ "name":"DescribeAction", "http":{ @@ -956,6 +1094,42 @@ {"shape":"ResourceNotFound"} ] }, + "DescribeDataQualityJobDefinition":{ + "name":"DescribeDataQualityJobDefinition", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDataQualityJobDefinitionRequest"}, + "output":{"shape":"DescribeDataQualityJobDefinitionResponse"}, + "errors":[ + {"shape":"ResourceNotFound"} + ] + }, + "DescribeDevice":{ + "name":"DescribeDevice", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDeviceRequest"}, + "output":{"shape":"DescribeDeviceResponse"}, + "errors":[ + {"shape":"ResourceNotFound"} + ] + }, + "DescribeDeviceFleet":{ + "name":"DescribeDeviceFleet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDeviceFleetRequest"}, + "output":{"shape":"DescribeDeviceFleetResponse"}, + "errors":[ + {"shape":"ResourceNotFound"} + ] + }, "DescribeDomain":{ "name":"DescribeDomain", "http":{ @@ -968,6 +1142,18 @@ {"shape":"ResourceNotFound"} ] }, + "DescribeEdgePackagingJob":{ + "name":"DescribeEdgePackagingJob", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeEdgePackagingJobRequest"}, + "output":{"shape":"DescribeEdgePackagingJobResponse"}, + "errors":[ + {"shape":"ResourceNotFound"} + ] + }, "DescribeEndpoint":{ "name":"DescribeEndpoint", "http":{ @@ -1091,6 +1277,30 @@ "input":{"shape":"DescribeModelInput"}, "output":{"shape":"DescribeModelOutput"} }, + "DescribeModelBiasJobDefinition":{ + "name":"DescribeModelBiasJobDefinition", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeModelBiasJobDefinitionRequest"}, + "output":{"shape":"DescribeModelBiasJobDefinitionResponse"}, + "errors":[ + {"shape":"ResourceNotFound"} + ] + }, + "DescribeModelExplainabilityJobDefinition":{ + "name":"DescribeModelExplainabilityJobDefinition", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeModelExplainabilityJobDefinitionRequest"}, + "output":{"shape":"DescribeModelExplainabilityJobDefinitionResponse"}, + "errors":[ + {"shape":"ResourceNotFound"} + ] + }, "DescribeModelPackage":{ "name":"DescribeModelPackage", "http":{ @@ -1109,6 +1319,18 @@ "input":{"shape":"DescribeModelPackageGroupInput"}, "output":{"shape":"DescribeModelPackageGroupOutput"} }, + "DescribeModelQualityJobDefinition":{ + "name":"DescribeModelQualityJobDefinition", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeModelQualityJobDefinitionRequest"}, + "output":{"shape":"DescribeModelQualityJobDefinitionResponse"}, + "errors":[ + {"shape":"ResourceNotFound"} + ] + }, "DescribeMonitoringSchedule":{ "name":"DescribeMonitoringSchedule", "http":{ @@ -1313,6 +1535,15 @@ "input":{"shape":"EnableSagemakerServicecatalogPortfolioInput"}, "output":{"shape":"EnableSagemakerServicecatalogPortfolioOutput"} }, + "GetDeviceFleetReport":{ + "name":"GetDeviceFleetReport", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetDeviceFleetReportRequest"}, + "output":{"shape":"GetDeviceFleetReportResponse"} + }, "GetModelPackageGroupPolicy":{ "name":"GetModelPackageGroupPolicy", "http":{ @@ -1454,6 +1685,33 @@ {"shape":"ResourceNotFound"} ] }, + "ListDataQualityJobDefinitions":{ + "name":"ListDataQualityJobDefinitions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListDataQualityJobDefinitionsRequest"}, + "output":{"shape":"ListDataQualityJobDefinitionsResponse"} + }, + "ListDeviceFleets":{ + "name":"ListDeviceFleets", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListDeviceFleetsRequest"}, + "output":{"shape":"ListDeviceFleetsResponse"} + }, + "ListDevices":{ + "name":"ListDevices", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListDevicesRequest"}, + "output":{"shape":"ListDevicesResponse"} + }, "ListDomains":{ "name":"ListDomains", "http":{ @@ -1463,6 +1721,15 @@ "input":{"shape":"ListDomainsRequest"}, "output":{"shape":"ListDomainsResponse"} }, + "ListEdgePackagingJobs":{ + "name":"ListEdgePackagingJobs", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListEdgePackagingJobsRequest"}, + "output":{"shape":"ListEdgePackagingJobsResponse"} + }, "ListEndpointConfigs":{ "name":"ListEndpointConfigs", "http":{ @@ -1568,6 +1835,24 @@ {"shape":"ResourceNotFound"} ] }, + "ListModelBiasJobDefinitions":{ + "name":"ListModelBiasJobDefinitions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListModelBiasJobDefinitionsRequest"}, + "output":{"shape":"ListModelBiasJobDefinitionsResponse"} + }, + "ListModelExplainabilityJobDefinitions":{ + "name":"ListModelExplainabilityJobDefinitions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListModelExplainabilityJobDefinitionsRequest"}, + "output":{"shape":"ListModelExplainabilityJobDefinitionsResponse"} + }, "ListModelPackageGroups":{ "name":"ListModelPackageGroups", "http":{ @@ -1586,6 +1871,15 @@ "input":{"shape":"ListModelPackagesInput"}, "output":{"shape":"ListModelPackagesOutput"} }, + "ListModelQualityJobDefinitions":{ + "name":"ListModelQualityJobDefinitions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListModelQualityJobDefinitionsRequest"}, + "output":{"shape":"ListModelQualityJobDefinitionsResponse"} + }, "ListModels":{ "name":"ListModels", "http":{ @@ -1802,6 +2096,17 @@ "input":{"shape":"PutModelPackageGroupPolicyInput"}, "output":{"shape":"PutModelPackageGroupPolicyOutput"} }, + "RegisterDevices":{ + "name":"RegisterDevices", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RegisterDevicesRequest"}, + "errors":[ + {"shape":"ResourceLimitExceeded"} + ] + }, "RenderUiTemplate":{ "name":"RenderUiTemplate", "http":{ @@ -1880,6 +2185,14 @@ {"shape":"ResourceNotFound"} ] }, + "StopEdgePackagingJob":{ + "name":"StopEdgePackagingJob", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StopEdgePackagingJobRequest"} + }, "StopHyperParameterTuningJob":{ "name":"StopHyperParameterTuningJob", "http":{ @@ -2026,6 +2339,25 @@ {"shape":"ResourceNotFound"} ] }, + "UpdateDeviceFleet":{ + "name":"UpdateDeviceFleet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateDeviceFleetRequest"}, + "errors":[ + {"shape":"ResourceInUse"} + ] + }, + "UpdateDevices":{ + "name":"UpdateDevices", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateDevicesRequest"} + }, "UpdateDomain":{ "name":"UpdateDomain", "http":{ @@ -2160,6 +2492,18 @@ {"shape":"ResourceNotFound"} ] }, + "UpdateTrainingJob":{ + "name":"UpdateTrainingJob", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateTrainingJobRequest"}, + "output":{"shape":"UpdateTrainingJobResponse"}, + "errors":[ + {"shape":"ResourceNotFound"} + ] + }, "UpdateTrial":{ "name":"UpdateTrial", "http":{ @@ -2314,6 +2658,21 @@ "member":{"shape":"CodeRepositoryNameOrUrl"}, "max":3 }, + "AgentVersion":{ + "type":"structure", + "required":[ + "Version", + "AgentCount" + ], + "members":{ + "Version":{"shape":"EdgeVersion"}, + "AgentCount":{"shape":"Long"} + } + }, + "AgentVersions":{ + "type":"list", + "member":{"shape":"AgentVersion"} + }, "Alarm":{ "type":"structure", "members":{ @@ -3876,29 +4235,73 @@ "ContextArn":{"shape":"ContextArn"} } }, - "CreateDomainRequest":{ + "CreateDataQualityJobDefinitionRequest":{ "type":"structure", "required":[ - "DomainName", - "AuthMode", - "DefaultUserSettings", - "SubnetIds", - "VpcId" + "JobDefinitionName", + "DataQualityAppSpecification", + "DataQualityJobInput", + "DataQualityJobOutputConfig", + "JobResources", + "RoleArn" ], "members":{ - "DomainName":{"shape":"DomainName"}, - "AuthMode":{"shape":"AuthMode"}, - "DefaultUserSettings":{"shape":"UserSettings"}, - "SubnetIds":{"shape":"Subnets"}, - "VpcId":{"shape":"VpcId"}, - "Tags":{"shape":"TagList"}, - "AppNetworkAccessType":{"shape":"AppNetworkAccessType"}, - "HomeEfsFileSystemKmsKeyId":{ - "shape":"KmsKeyId", - "deprecated":true, - "deprecatedMessage":"This property is deprecated, use KmsKeyId instead." - }, - "KmsKeyId":{"shape":"KmsKeyId"} + "JobDefinitionName":{"shape":"MonitoringJobDefinitionName"}, + "DataQualityBaselineConfig":{"shape":"DataQualityBaselineConfig"}, + "DataQualityAppSpecification":{"shape":"DataQualityAppSpecification"}, + "DataQualityJobInput":{"shape":"DataQualityJobInput"}, + "DataQualityJobOutputConfig":{"shape":"MonitoringOutputConfig"}, + "JobResources":{"shape":"MonitoringResources"}, + "NetworkConfig":{"shape":"MonitoringNetworkConfig"}, + "RoleArn":{"shape":"RoleArn"}, + "StoppingCondition":{"shape":"MonitoringStoppingCondition"}, + "Tags":{"shape":"TagList"} + } + }, + "CreateDataQualityJobDefinitionResponse":{ + "type":"structure", + "required":["JobDefinitionArn"], + "members":{ + "JobDefinitionArn":{"shape":"MonitoringJobDefinitionArn"} + } + }, + "CreateDeviceFleetRequest":{ + "type":"structure", + "required":[ + "DeviceFleetName", + "OutputConfig" + ], + "members":{ + "DeviceFleetName":{"shape":"EntityName"}, + "RoleArn":{"shape":"RoleArn"}, + "Description":{"shape":"DeviceFleetDescription"}, + "OutputConfig":{"shape":"EdgeOutputConfig"}, + "Tags":{"shape":"TagList"} + } + }, + "CreateDomainRequest":{ + "type":"structure", + "required":[ + "DomainName", + "AuthMode", + "DefaultUserSettings", + "SubnetIds", + "VpcId" + ], + "members":{ + "DomainName":{"shape":"DomainName"}, + "AuthMode":{"shape":"AuthMode"}, + "DefaultUserSettings":{"shape":"UserSettings"}, + "SubnetIds":{"shape":"Subnets"}, + "VpcId":{"shape":"VpcId"}, + "Tags":{"shape":"TagList"}, + "AppNetworkAccessType":{"shape":"AppNetworkAccessType"}, + "HomeEfsFileSystemKmsKeyId":{ + "shape":"KmsKeyId", + "deprecated":true, + "deprecatedMessage":"This property is deprecated, use KmsKeyId instead." + }, + "KmsKeyId":{"shape":"KmsKeyId"} } }, "CreateDomainResponse":{ @@ -3908,6 +4311,27 @@ "Url":{"shape":"String1024"} } }, + "CreateEdgePackagingJobRequest":{ + "type":"structure", + "required":[ + "EdgePackagingJobName", + "CompilationJobName", + "ModelName", + "ModelVersion", + "RoleArn", + "OutputConfig" + ], + "members":{ + "EdgePackagingJobName":{"shape":"EntityName"}, + "CompilationJobName":{"shape":"EntityName"}, + "ModelName":{"shape":"EntityName"}, + "ModelVersion":{"shape":"EdgeVersion"}, + "RoleArn":{"shape":"RoleArn"}, + "OutputConfig":{"shape":"EdgeOutputConfig"}, + "ResourceKey":{"shape":"KmsKeyId"}, + "Tags":{"shape":"TagList"} + } + }, "CreateEndpointConfigInput":{ "type":"structure", "required":[ @@ -4129,6 +4553,66 @@ "LabelingJobArn":{"shape":"LabelingJobArn"} } }, + "CreateModelBiasJobDefinitionRequest":{ + "type":"structure", + "required":[ + "JobDefinitionName", + "ModelBiasAppSpecification", + "ModelBiasJobInput", + "ModelBiasJobOutputConfig", + "JobResources", + "RoleArn" + ], + "members":{ + "JobDefinitionName":{"shape":"MonitoringJobDefinitionName"}, + "ModelBiasBaselineConfig":{"shape":"ModelBiasBaselineConfig"}, + "ModelBiasAppSpecification":{"shape":"ModelBiasAppSpecification"}, + "ModelBiasJobInput":{"shape":"ModelBiasJobInput"}, + "ModelBiasJobOutputConfig":{"shape":"MonitoringOutputConfig"}, + "JobResources":{"shape":"MonitoringResources"}, + "NetworkConfig":{"shape":"MonitoringNetworkConfig"}, + "RoleArn":{"shape":"RoleArn"}, + "StoppingCondition":{"shape":"MonitoringStoppingCondition"}, + "Tags":{"shape":"TagList"} + } + }, + "CreateModelBiasJobDefinitionResponse":{ + "type":"structure", + "required":["JobDefinitionArn"], + "members":{ + "JobDefinitionArn":{"shape":"MonitoringJobDefinitionArn"} + } + }, + "CreateModelExplainabilityJobDefinitionRequest":{ + "type":"structure", + "required":[ + "JobDefinitionName", + "ModelExplainabilityAppSpecification", + "ModelExplainabilityJobInput", + "ModelExplainabilityJobOutputConfig", + "JobResources", + "RoleArn" + ], + "members":{ + "JobDefinitionName":{"shape":"MonitoringJobDefinitionName"}, + "ModelExplainabilityBaselineConfig":{"shape":"ModelExplainabilityBaselineConfig"}, + "ModelExplainabilityAppSpecification":{"shape":"ModelExplainabilityAppSpecification"}, + "ModelExplainabilityJobInput":{"shape":"ModelExplainabilityJobInput"}, + "ModelExplainabilityJobOutputConfig":{"shape":"MonitoringOutputConfig"}, + "JobResources":{"shape":"MonitoringResources"}, + "NetworkConfig":{"shape":"MonitoringNetworkConfig"}, + "RoleArn":{"shape":"RoleArn"}, + "StoppingCondition":{"shape":"MonitoringStoppingCondition"}, + "Tags":{"shape":"TagList"} + } + }, + "CreateModelExplainabilityJobDefinitionResponse":{ + "type":"structure", + "required":["JobDefinitionArn"], + "members":{ + "JobDefinitionArn":{"shape":"MonitoringJobDefinitionArn"} + } + }, "CreateModelInput":{ "type":"structure", "required":[ @@ -4195,6 +4679,36 @@ "ModelPackageArn":{"shape":"ModelPackageArn"} } }, + "CreateModelQualityJobDefinitionRequest":{ + "type":"structure", + "required":[ + "JobDefinitionName", + "ModelQualityAppSpecification", + "ModelQualityJobInput", + "ModelQualityJobOutputConfig", + "JobResources", + "RoleArn" + ], + "members":{ + "JobDefinitionName":{"shape":"MonitoringJobDefinitionName"}, + "ModelQualityBaselineConfig":{"shape":"ModelQualityBaselineConfig"}, + "ModelQualityAppSpecification":{"shape":"ModelQualityAppSpecification"}, + "ModelQualityJobInput":{"shape":"ModelQualityJobInput"}, + "ModelQualityJobOutputConfig":{"shape":"MonitoringOutputConfig"}, + "JobResources":{"shape":"MonitoringResources"}, + "NetworkConfig":{"shape":"MonitoringNetworkConfig"}, + "RoleArn":{"shape":"RoleArn"}, + "StoppingCondition":{"shape":"MonitoringStoppingCondition"}, + "Tags":{"shape":"TagList"} + } + }, + "CreateModelQualityJobDefinitionResponse":{ + "type":"structure", + "required":["JobDefinitionArn"], + "members":{ + "JobDefinitionArn":{"shape":"MonitoringJobDefinitionArn"} + } + }, "CreateMonitoringScheduleRequest":{ "type":"structure", "required":[ @@ -4399,7 +4913,9 @@ "DebugHookConfig":{"shape":"DebugHookConfig"}, "DebugRuleConfigurations":{"shape":"DebugRuleConfigurations"}, "TensorBoardOutputConfig":{"shape":"TensorBoardOutputConfig"}, - "ExperimentConfig":{"shape":"ExperimentConfig"} + "ExperimentConfig":{"shape":"ExperimentConfig"}, + "ProfilerConfig":{"shape":"ProfilerConfig"}, + "ProfilerRuleConfigurations":{"shape":"ProfilerRuleConfigurations"} } }, "CreateTrainingJobResponse":{ @@ -4648,6 +5164,33 @@ "JoinSource":{"shape":"JoinSource"} } }, + "DataQualityAppSpecification":{ + "type":"structure", + "required":["ImageUri"], + "members":{ + "ImageUri":{"shape":"ImageUri"}, + "ContainerEntrypoint":{"shape":"ContainerEntrypoint"}, + "ContainerArguments":{"shape":"MonitoringContainerArguments"}, + "RecordPreprocessorSourceUri":{"shape":"S3Uri"}, + "PostAnalyticsProcessorSourceUri":{"shape":"S3Uri"}, + "Environment":{"shape":"MonitoringEnvironmentMap"} + } + }, + "DataQualityBaselineConfig":{ + "type":"structure", + "members":{ + "BaseliningJobName":{"shape":"ProcessingJobName"}, + "ConstraintsResource":{"shape":"MonitoringConstraintsResource"}, + "StatisticsResource":{"shape":"MonitoringStatisticsResource"} + } + }, + "DataQualityJobInput":{ + "type":"structure", + "required":["EndpointInput"], + "members":{ + "EndpointInput":{"shape":"EndpointInput"} + } + }, "DataSource":{ "type":"structure", "members":{ @@ -4822,6 +5365,20 @@ "ContextArn":{"shape":"ContextArn"} } }, + "DeleteDataQualityJobDefinitionRequest":{ + "type":"structure", + "required":["JobDefinitionName"], + "members":{ + "JobDefinitionName":{"shape":"MonitoringJobDefinitionName"} + } + }, + "DeleteDeviceFleetRequest":{ + "type":"structure", + "required":["DeviceFleetName"], + "members":{ + "DeviceFleetName":{"shape":"EntityName"} + } + }, "DeleteDomainRequest":{ "type":"structure", "required":["DomainId"], @@ -4916,6 +5473,20 @@ "members":{ } }, + "DeleteModelBiasJobDefinitionRequest":{ + "type":"structure", + "required":["JobDefinitionName"], + "members":{ + "JobDefinitionName":{"shape":"MonitoringJobDefinitionName"} + } + }, + "DeleteModelExplainabilityJobDefinitionRequest":{ + "type":"structure", + "required":["JobDefinitionName"], + "members":{ + "JobDefinitionName":{"shape":"MonitoringJobDefinitionName"} + } + }, "DeleteModelInput":{ "type":"structure", "required":["ModelName"], @@ -4944,6 +5515,13 @@ "ModelPackageName":{"shape":"VersionedArnOrName"} } }, + "DeleteModelQualityJobDefinitionRequest":{ + "type":"structure", + "required":["JobDefinitionName"], + "members":{ + "JobDefinitionName":{"shape":"MonitoringJobDefinitionName"} + } + }, "DeleteMonitoringScheduleRequest":{ "type":"structure", "required":["MonitoringScheduleName"], @@ -5091,6 +5669,17 @@ "AutoRollbackConfiguration":{"shape":"AutoRollbackConfig"} } }, + "DeregisterDevicesRequest":{ + "type":"structure", + "required":[ + "DeviceFleetName", + "DeviceNames" + ], + "members":{ + "DeviceFleetName":{"shape":"EntityName"}, + "DeviceNames":{"shape":"DeviceNames"} + } + }, "DescribeActionRequest":{ "type":"structure", "required":["ActionName"], @@ -5341,6 +5930,98 @@ "LastModifiedBy":{"shape":"UserContext"} } }, + "DescribeDataQualityJobDefinitionRequest":{ + "type":"structure", + "required":["JobDefinitionName"], + "members":{ + "JobDefinitionName":{"shape":"MonitoringJobDefinitionName"} + } + }, + "DescribeDataQualityJobDefinitionResponse":{ + "type":"structure", + "required":[ + "JobDefinitionArn", + "JobDefinitionName", + "CreationTime", + "DataQualityAppSpecification", + "DataQualityJobInput", + "DataQualityJobOutputConfig", + "JobResources", + "RoleArn" + ], + "members":{ + "JobDefinitionArn":{"shape":"MonitoringJobDefinitionArn"}, + "JobDefinitionName":{"shape":"MonitoringJobDefinitionName"}, + "CreationTime":{"shape":"Timestamp"}, + "DataQualityBaselineConfig":{"shape":"DataQualityBaselineConfig"}, + "DataQualityAppSpecification":{"shape":"DataQualityAppSpecification"}, + "DataQualityJobInput":{"shape":"DataQualityJobInput"}, + "DataQualityJobOutputConfig":{"shape":"MonitoringOutputConfig"}, + "JobResources":{"shape":"MonitoringResources"}, + "NetworkConfig":{"shape":"MonitoringNetworkConfig"}, + "RoleArn":{"shape":"RoleArn"}, + "StoppingCondition":{"shape":"MonitoringStoppingCondition"} + } + }, + "DescribeDeviceFleetRequest":{ + "type":"structure", + "required":["DeviceFleetName"], + "members":{ + "DeviceFleetName":{"shape":"EntityName"} + } + }, + "DescribeDeviceFleetResponse":{ + "type":"structure", + "required":[ + "DeviceFleetName", + "DeviceFleetArn", + "OutputConfig", + "CreationTime", + "LastModifiedTime" + ], + "members":{ + "DeviceFleetName":{"shape":"EntityName"}, + "DeviceFleetArn":{"shape":"DeviceFleetArn"}, + "OutputConfig":{"shape":"EdgeOutputConfig"}, + "Description":{"shape":"DeviceFleetDescription"}, + "CreationTime":{"shape":"Timestamp"}, + "LastModifiedTime":{"shape":"Timestamp"}, + "RoleArn":{"shape":"RoleArn"}, + "IotRoleAlias":{"shape":"IotRoleAlias"} + } + }, + "DescribeDeviceRequest":{ + "type":"structure", + "required":[ + "DeviceName", + "DeviceFleetName" + ], + "members":{ + "NextToken":{"shape":"NextToken"}, + "DeviceName":{"shape":"EntityName"}, + "DeviceFleetName":{"shape":"EntityName"} + } + }, + "DescribeDeviceResponse":{ + "type":"structure", + "required":[ + "DeviceName", + "DeviceFleetName", + "RegistrationTime" + ], + "members":{ + "DeviceArn":{"shape":"DeviceArn"}, + "DeviceName":{"shape":"EntityName"}, + "Description":{"shape":"DeviceDescription"}, + "DeviceFleetName":{"shape":"EntityName"}, + "IotThingName":{"shape":"ThingName"}, + "RegistrationTime":{"shape":"Timestamp"}, + "LatestHeartbeat":{"shape":"Timestamp"}, + "Models":{"shape":"EdgeModels"}, + "MaxModels":{"shape":"Integer"}, + "NextToken":{"shape":"NextToken"} + } + }, "DescribeDomainRequest":{ "type":"structure", "required":["DomainId"], @@ -5374,6 +6055,37 @@ "KmsKeyId":{"shape":"KmsKeyId"} } }, + "DescribeEdgePackagingJobRequest":{ + "type":"structure", + "required":["EdgePackagingJobName"], + "members":{ + "EdgePackagingJobName":{"shape":"EntityName"} + } + }, + "DescribeEdgePackagingJobResponse":{ + "type":"structure", + "required":[ + "EdgePackagingJobArn", + "EdgePackagingJobName", + "EdgePackagingJobStatus" + ], + "members":{ + "EdgePackagingJobArn":{"shape":"EdgePackagingJobArn"}, + "EdgePackagingJobName":{"shape":"EntityName"}, + "CompilationJobName":{"shape":"EntityName"}, + "ModelName":{"shape":"EntityName"}, + "ModelVersion":{"shape":"EdgeVersion"}, + "RoleArn":{"shape":"RoleArn"}, + "OutputConfig":{"shape":"EdgeOutputConfig"}, + "ResourceKey":{"shape":"KmsKeyId"}, + "EdgePackagingJobStatus":{"shape":"EdgePackagingJobStatus"}, + "EdgePackagingJobStatusMessage":{"shape":"String"}, + "CreationTime":{"shape":"Timestamp"}, + "LastModifiedTime":{"shape":"Timestamp"}, + "ModelArtifact":{"shape":"S3Uri"}, + "ModelSignature":{"shape":"String"} + } + }, "DescribeEndpointConfigInput":{ "type":"structure", "required":["EndpointConfigName"], @@ -5661,6 +6373,72 @@ "LabelingJobOutput":{"shape":"LabelingJobOutput"} } }, + "DescribeModelBiasJobDefinitionRequest":{ + "type":"structure", + "required":["JobDefinitionName"], + "members":{ + "JobDefinitionName":{"shape":"MonitoringJobDefinitionName"} + } + }, + "DescribeModelBiasJobDefinitionResponse":{ + "type":"structure", + "required":[ + "JobDefinitionArn", + "JobDefinitionName", + "CreationTime", + "ModelBiasAppSpecification", + "ModelBiasJobInput", + "ModelBiasJobOutputConfig", + "JobResources", + "RoleArn" + ], + "members":{ + "JobDefinitionArn":{"shape":"MonitoringJobDefinitionArn"}, + "JobDefinitionName":{"shape":"MonitoringJobDefinitionName"}, + "CreationTime":{"shape":"Timestamp"}, + "ModelBiasBaselineConfig":{"shape":"ModelBiasBaselineConfig"}, + "ModelBiasAppSpecification":{"shape":"ModelBiasAppSpecification"}, + "ModelBiasJobInput":{"shape":"ModelBiasJobInput"}, + "ModelBiasJobOutputConfig":{"shape":"MonitoringOutputConfig"}, + "JobResources":{"shape":"MonitoringResources"}, + "NetworkConfig":{"shape":"MonitoringNetworkConfig"}, + "RoleArn":{"shape":"RoleArn"}, + "StoppingCondition":{"shape":"MonitoringStoppingCondition"} + } + }, + "DescribeModelExplainabilityJobDefinitionRequest":{ + "type":"structure", + "required":["JobDefinitionName"], + "members":{ + "JobDefinitionName":{"shape":"MonitoringJobDefinitionName"} + } + }, + "DescribeModelExplainabilityJobDefinitionResponse":{ + "type":"structure", + "required":[ + "JobDefinitionArn", + "JobDefinitionName", + "CreationTime", + "ModelExplainabilityAppSpecification", + "ModelExplainabilityJobInput", + "ModelExplainabilityJobOutputConfig", + "JobResources", + "RoleArn" + ], + "members":{ + "JobDefinitionArn":{"shape":"MonitoringJobDefinitionArn"}, + "JobDefinitionName":{"shape":"MonitoringJobDefinitionName"}, + "CreationTime":{"shape":"Timestamp"}, + "ModelExplainabilityBaselineConfig":{"shape":"ModelExplainabilityBaselineConfig"}, + "ModelExplainabilityAppSpecification":{"shape":"ModelExplainabilityAppSpecification"}, + "ModelExplainabilityJobInput":{"shape":"ModelExplainabilityJobInput"}, + "ModelExplainabilityJobOutputConfig":{"shape":"MonitoringOutputConfig"}, + "JobResources":{"shape":"MonitoringResources"}, + "NetworkConfig":{"shape":"MonitoringNetworkConfig"}, + "RoleArn":{"shape":"RoleArn"}, + "StoppingCondition":{"shape":"MonitoringStoppingCondition"} + } + }, "DescribeModelInput":{ "type":"structure", "required":["ModelName"], @@ -5750,6 +6528,39 @@ "ApprovalDescription":{"shape":"ApprovalDescription"} } }, + "DescribeModelQualityJobDefinitionRequest":{ + "type":"structure", + "required":["JobDefinitionName"], + "members":{ + "JobDefinitionName":{"shape":"MonitoringJobDefinitionName"} + } + }, + "DescribeModelQualityJobDefinitionResponse":{ + "type":"structure", + "required":[ + "JobDefinitionArn", + "JobDefinitionName", + "CreationTime", + "ModelQualityAppSpecification", + "ModelQualityJobInput", + "ModelQualityJobOutputConfig", + "JobResources", + "RoleArn" + ], + "members":{ + "JobDefinitionArn":{"shape":"MonitoringJobDefinitionArn"}, + "JobDefinitionName":{"shape":"MonitoringJobDefinitionName"}, + "CreationTime":{"shape":"Timestamp"}, + "ModelQualityBaselineConfig":{"shape":"ModelQualityBaselineConfig"}, + "ModelQualityAppSpecification":{"shape":"ModelQualityAppSpecification"}, + "ModelQualityJobInput":{"shape":"ModelQualityJobInput"}, + "ModelQualityJobOutputConfig":{"shape":"MonitoringOutputConfig"}, + "JobResources":{"shape":"MonitoringResources"}, + "NetworkConfig":{"shape":"MonitoringNetworkConfig"}, + "RoleArn":{"shape":"RoleArn"}, + "StoppingCondition":{"shape":"MonitoringStoppingCondition"} + } + }, "DescribeMonitoringScheduleRequest":{ "type":"structure", "required":["MonitoringScheduleName"], @@ -5771,6 +6582,7 @@ "MonitoringScheduleArn":{"shape":"MonitoringScheduleArn"}, "MonitoringScheduleName":{"shape":"MonitoringScheduleName"}, "MonitoringScheduleStatus":{"shape":"ScheduleStatus"}, + "MonitoringType":{"shape":"MonitoringType"}, "FailureReason":{"shape":"FailureReason"}, "CreationTime":{"shape":"Timestamp"}, "LastModifiedTime":{"shape":"Timestamp"}, @@ -6026,7 +6838,11 @@ "ExperimentConfig":{"shape":"ExperimentConfig"}, "DebugRuleConfigurations":{"shape":"DebugRuleConfigurations"}, "TensorBoardOutputConfig":{"shape":"TensorBoardOutputConfig"}, - "DebugRuleEvaluationStatuses":{"shape":"DebugRuleEvaluationStatuses"} + "DebugRuleEvaluationStatuses":{"shape":"DebugRuleEvaluationStatuses"}, + "ProfilerConfig":{"shape":"ProfilerConfig"}, + "ProfilerRuleConfigurations":{"shape":"ProfilerRuleConfigurations"}, + "ProfilerRuleEvaluationStatuses":{"shape":"ProfilerRuleEvaluationStatuses"}, + "ProfilingStatus":{"shape":"ProfilingStatus"} } }, "DescribeTransformJobRequest":{ @@ -6216,6 +7032,100 @@ "Failed" ] }, + "Device":{ + "type":"structure", + "required":["DeviceName"], + "members":{ + "DeviceName":{"shape":"DeviceName"}, + "Description":{"shape":"DeviceDescription"}, + "IotThingName":{"shape":"ThingName"} + } + }, + "DeviceArn":{ + "type":"string", + "max":2048, + "min":20, + "pattern":"^arn:aws[a-z\\-]*:[a-z\\-]*:[a-z\\-]*:\\d{12}:[a-z\\-]*/?[a-zA-Z_0-9+=,.@\\-_/]+$" + }, + "DeviceDescription":{ + "type":"string", + "max":40, + "min":1, + "pattern":"[\\S\\s]+" + }, + "DeviceFleetArn":{ + "type":"string", + "pattern":"^arn:aws[a-z\\-]*:iam::\\d{12}:device-fleet/?[a-zA-Z_0-9+=,.@\\-_/]+$" + }, + "DeviceFleetDescription":{ + "type":"string", + "max":800, + "min":1, + "pattern":"[\\S\\s]+" + }, + "DeviceFleetSummaries":{ + "type":"list", + "member":{"shape":"DeviceFleetSummary"} + }, + "DeviceFleetSummary":{ + "type":"structure", + "required":[ + "DeviceFleetArn", + "DeviceFleetName" + ], + "members":{ + "DeviceFleetArn":{"shape":"DeviceFleetArn"}, + "DeviceFleetName":{"shape":"EntityName"}, + "CreationTime":{"shape":"Timestamp"}, + "LastModifiedTime":{"shape":"Timestamp"} + } + }, + "DeviceName":{ + "type":"string", + "max":63, + "min":1, + "pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$" + }, + "DeviceNames":{ + "type":"list", + "member":{"shape":"DeviceName"} + }, + "DeviceStats":{ + "type":"structure", + "required":[ + "ConnectedDeviceCount", + "RegisteredDeviceCount" + ], + "members":{ + "ConnectedDeviceCount":{"shape":"Long"}, + "RegisteredDeviceCount":{"shape":"Long"} + } + }, + "DeviceSummaries":{ + "type":"list", + "member":{"shape":"DeviceSummary"} + }, + "DeviceSummary":{ + "type":"structure", + "required":[ + "DeviceName", + "DeviceArn" + ], + "members":{ + "DeviceName":{"shape":"EntityName"}, + "DeviceArn":{"shape":"DeviceArn"}, + "Description":{"shape":"DeviceDescription"}, + "DeviceFleetName":{"shape":"EntityName"}, + "IotThingName":{"shape":"ThingName"}, + "RegistrationTime":{"shape":"Timestamp"}, + "LatestHeartbeat":{"shape":"Timestamp"}, + "Models":{"shape":"EdgeModelSummaries"} + } + }, + "Devices":{ + "type":"list", + "member":{"shape":"Device"} + }, "DirectInternetAccess":{ "type":"string", "enum":[ @@ -6228,6 +7138,7 @@ "max":4096, "pattern":".*" }, + "DisableProfiler":{"type":"boolean"}, "DisableSagemakerServicecatalogPortfolioInput":{ "type":"structure", "members":{ @@ -6308,6 +7219,114 @@ ] }, "DoubleParameterValue":{"type":"double"}, + "EdgeModel":{ + "type":"structure", + "required":[ + "ModelName", + "ModelVersion" + ], + "members":{ + "ModelName":{"shape":"EntityName"}, + "ModelVersion":{"shape":"EdgeVersion"}, + "LatestSampleTime":{"shape":"Timestamp"}, + "LatestInference":{"shape":"Timestamp"} + } + }, + "EdgeModelStat":{ + "type":"structure", + "required":[ + "ModelName", + "ModelVersion", + "OfflineDeviceCount", + "ConnectedDeviceCount", + "ActiveDeviceCount", + "SamplingDeviceCount" + ], + "members":{ + "ModelName":{"shape":"EntityName"}, + "ModelVersion":{"shape":"EdgeVersion"}, + "OfflineDeviceCount":{"shape":"Long"}, + "ConnectedDeviceCount":{"shape":"Long"}, + "ActiveDeviceCount":{"shape":"Long"}, + "SamplingDeviceCount":{"shape":"Long"} + } + }, + "EdgeModelStats":{ + "type":"list", + "member":{"shape":"EdgeModelStat"} + }, + "EdgeModelSummaries":{ + "type":"list", + "member":{"shape":"EdgeModelSummary"} + }, + "EdgeModelSummary":{ + "type":"structure", + "required":[ + "ModelName", + "ModelVersion" + ], + "members":{ + "ModelName":{"shape":"EntityName"}, + "ModelVersion":{"shape":"EdgeVersion"} + } + }, + "EdgeModels":{ + "type":"list", + "member":{"shape":"EdgeModel"} + }, + "EdgeOutputConfig":{ + "type":"structure", + "required":["S3OutputLocation"], + "members":{ + "S3OutputLocation":{"shape":"S3Uri"}, + "KmsKeyId":{"shape":"KmsKeyId"} + } + }, + "EdgePackagingJobArn":{ + "type":"string", + "max":2048, + "min":20, + "pattern":"^arn:aws[a-z\\-]*:sagemaker:[a-z\\-]*:\\d{12}:edge-packaging-job/?[a-zA-Z_0-9+=,.@\\-_/]+$" + }, + "EdgePackagingJobStatus":{ + "type":"string", + "enum":[ + "STARTING", + "INPROGRESS", + "COMPLETED", + "FAILED", + "STOPPING", + "STOPPED" + ] + }, + "EdgePackagingJobSummaries":{ + "type":"list", + "member":{"shape":"EdgePackagingJobSummary"} + }, + "EdgePackagingJobSummary":{ + "type":"structure", + "required":[ + "EdgePackagingJobArn", + "EdgePackagingJobName", + "EdgePackagingJobStatus" + ], + "members":{ + "EdgePackagingJobArn":{"shape":"EdgePackagingJobArn"}, + "EdgePackagingJobName":{"shape":"EntityName"}, + "EdgePackagingJobStatus":{"shape":"EdgePackagingJobStatus"}, + "CompilationJobName":{"shape":"EntityName"}, + "ModelName":{"shape":"EntityName"}, + "ModelVersion":{"shape":"EdgeVersion"}, + "CreationTime":{"shape":"Timestamp"}, + "LastModifiedTime":{"shape":"Timestamp"} + } + }, + "EdgeVersion":{ + "type":"string", + "max":30, + "min":1, + "pattern":"[a-zA-Z0-9\\ \\_\\.]+" + }, "EfsUid":{ "type":"string", "max":10, @@ -6404,7 +7423,13 @@ "EndpointName":{"shape":"EndpointName"}, "LocalPath":{"shape":"ProcessingLocalPath"}, "S3InputMode":{"shape":"ProcessingS3InputMode"}, - "S3DataDistributionType":{"shape":"ProcessingS3DataDistributionType"} + "S3DataDistributionType":{"shape":"ProcessingS3DataDistributionType"}, + "FeaturesAttribute":{"shape":"String"}, + "InferenceAttribute":{"shape":"String"}, + "ProbabilityAttribute":{"shape":"String"}, + "ProbabilityThresholdAttribute":{"shape":"ProbabilityThresholdAttribute"}, + "StartTimeOffset":{"shape":"MonitoringTimeOffsetString"}, + "EndTimeOffset":{"shape":"MonitoringTimeOffsetString"} } }, "EndpointName":{ @@ -6894,6 +7919,30 @@ ] }, "GenerateCandidateDefinitionsOnly":{"type":"boolean"}, + "GetDeviceFleetReportRequest":{ + "type":"structure", + "required":["DeviceFleetName"], + "members":{ + "DeviceFleetName":{"shape":"EntityName"} + } + }, + "GetDeviceFleetReportResponse":{ + "type":"structure", + "required":[ + "DeviceFleetArn", + "DeviceFleetName" + ], + "members":{ + "DeviceFleetArn":{"shape":"DeviceFleetArn"}, + "DeviceFleetName":{"shape":"EntityName"}, + "OutputConfig":{"shape":"EdgeOutputConfig"}, + "Description":{"shape":"DeviceFleetDescription"}, + "ReportGenerated":{"shape":"Timestamp"}, + "DeviceStats":{"shape":"DeviceStats"}, + "AgentVersions":{"shape":"AgentVersions"}, + "ModelStats":{"shape":"EdgeModelStats"} + } + }, "GetModelPackageGroupPolicyInput":{ "type":"structure", "required":["ModelPackageGroupName"], @@ -7596,6 +8645,7 @@ "ml.p3.16xlarge" ] }, + "Integer":{"type":"integer"}, "IntegerParameterRange":{ "type":"structure", "required":[ @@ -7637,6 +8687,10 @@ "max":3600, "min":1 }, + "IotRoleAlias":{ + "type":"string", + "pattern":"^arn:aws[a-z\\-]*:iam::\\d{12}:rolealias/?[a-zA-Z_0-9+=,.@\\-_/]+$" + }, "JobReferenceCode":{ "type":"string", "min":1, @@ -8160,6 +9214,81 @@ "NextToken":{"shape":"NextToken"} } }, + "ListDataQualityJobDefinitionsRequest":{ + "type":"structure", + "members":{ + "EndpointName":{"shape":"EndpointName"}, + "SortBy":{"shape":"MonitoringJobDefinitionSortKey"}, + "SortOrder":{"shape":"SortOrder"}, + "NextToken":{"shape":"NextToken"}, + "MaxResults":{"shape":"MaxResults"}, + "NameContains":{"shape":"NameContains"}, + "CreationTimeBefore":{"shape":"Timestamp"}, + "CreationTimeAfter":{"shape":"Timestamp"} + } + }, + "ListDataQualityJobDefinitionsResponse":{ + "type":"structure", + "required":["JobDefinitionSummaries"], + "members":{ + "JobDefinitionSummaries":{"shape":"MonitoringJobDefinitionSummaryList"}, + "NextToken":{"shape":"NextToken"} + } + }, + "ListDeviceFleetsRequest":{ + "type":"structure", + "members":{ + "NextToken":{"shape":"NextToken"}, + "MaxResults":{ + "shape":"ListMaxResults", + "box":true + }, + "CreationTimeAfter":{"shape":"Timestamp"}, + "CreationTimeBefore":{"shape":"Timestamp"}, + "LastModifiedTimeAfter":{"shape":"Timestamp"}, + "LastModifiedTimeBefore":{"shape":"Timestamp"}, + "NameContains":{"shape":"NameContains"}, + "SortBy":{"shape":"ListDeviceFleetsSortBy"}, + "SortOrder":{"shape":"SortOrder"} + } + }, + "ListDeviceFleetsResponse":{ + "type":"structure", + "required":["DeviceFleetSummaries"], + "members":{ + "DeviceFleetSummaries":{"shape":"DeviceFleetSummaries"}, + "NextToken":{"shape":"NextToken"} + } + }, + "ListDeviceFleetsSortBy":{ + "type":"string", + "enum":[ + "NAME", + "CREATION_TIME", + "LAST_MODIFIED_TIME" + ] + }, + "ListDevicesRequest":{ + "type":"structure", + "members":{ + "NextToken":{"shape":"NextToken"}, + "MaxResults":{ + "shape":"ListMaxResults", + "box":true + }, + "LatestHeartbeatAfter":{"shape":"Timestamp"}, + "ModelName":{"shape":"EntityName"}, + "DeviceFleetName":{"shape":"EntityName"} + } + }, + "ListDevicesResponse":{ + "type":"structure", + "required":["DeviceSummaries"], + "members":{ + "DeviceSummaries":{"shape":"DeviceSummaries"}, + "NextToken":{"shape":"NextToken"} + } + }, "ListDomainsRequest":{ "type":"structure", "members":{ @@ -8174,6 +9303,43 @@ "NextToken":{"shape":"NextToken"} } }, + "ListEdgePackagingJobsRequest":{ + "type":"structure", + "members":{ + "NextToken":{"shape":"NextToken"}, + "MaxResults":{ + "shape":"ListMaxResults", + "box":true + }, + "CreationTimeAfter":{"shape":"Timestamp"}, + "CreationTimeBefore":{"shape":"Timestamp"}, + "LastModifiedTimeAfter":{"shape":"Timestamp"}, + "LastModifiedTimeBefore":{"shape":"Timestamp"}, + "NameContains":{"shape":"NameContains"}, + "ModelNameContains":{"shape":"NameContains"}, + "StatusEquals":{"shape":"EdgePackagingJobStatus"}, + "SortBy":{"shape":"ListEdgePackagingJobsSortBy"}, + "SortOrder":{"shape":"SortOrder"} + } + }, + "ListEdgePackagingJobsResponse":{ + "type":"structure", + "required":["EdgePackagingJobSummaries"], + "members":{ + "EdgePackagingJobSummaries":{"shape":"EdgePackagingJobSummaries"}, + "NextToken":{"shape":"NextToken"} + } + }, + "ListEdgePackagingJobsSortBy":{ + "type":"string", + "enum":[ + "NAME", + "MODEL_NAME", + "CREATION_TIME", + "LAST_MODIFIED_TIME", + "STATUS" + ] + }, "ListEndpointConfigsInput":{ "type":"structure", "members":{ @@ -8423,6 +9589,52 @@ "type":"list", "member":{"shape":"StringParameterValue"} }, + "ListMaxResults":{ + "type":"integer", + "max":100 + }, + "ListModelBiasJobDefinitionsRequest":{ + "type":"structure", + "members":{ + "EndpointName":{"shape":"EndpointName"}, + "SortBy":{"shape":"MonitoringJobDefinitionSortKey"}, + "SortOrder":{"shape":"SortOrder"}, + "NextToken":{"shape":"NextToken"}, + "MaxResults":{"shape":"MaxResults"}, + "NameContains":{"shape":"NameContains"}, + "CreationTimeBefore":{"shape":"Timestamp"}, + "CreationTimeAfter":{"shape":"Timestamp"} + } + }, + "ListModelBiasJobDefinitionsResponse":{ + "type":"structure", + "required":["JobDefinitionSummaries"], + "members":{ + "JobDefinitionSummaries":{"shape":"MonitoringJobDefinitionSummaryList"}, + "NextToken":{"shape":"NextToken"} + } + }, + "ListModelExplainabilityJobDefinitionsRequest":{ + "type":"structure", + "members":{ + "EndpointName":{"shape":"EndpointName"}, + "SortBy":{"shape":"MonitoringJobDefinitionSortKey"}, + "SortOrder":{"shape":"SortOrder"}, + "NextToken":{"shape":"NextToken"}, + "MaxResults":{"shape":"MaxResults"}, + "NameContains":{"shape":"NameContains"}, + "CreationTimeBefore":{"shape":"Timestamp"}, + "CreationTimeAfter":{"shape":"Timestamp"} + } + }, + "ListModelExplainabilityJobDefinitionsResponse":{ + "type":"structure", + "required":["JobDefinitionSummaries"], + "members":{ + "JobDefinitionSummaries":{"shape":"MonitoringJobDefinitionSummaryList"}, + "NextToken":{"shape":"NextToken"} + } + }, "ListModelPackageGroupsInput":{ "type":"structure", "members":{ @@ -8466,6 +9678,27 @@ "NextToken":{"shape":"NextToken"} } }, + "ListModelQualityJobDefinitionsRequest":{ + "type":"structure", + "members":{ + "EndpointName":{"shape":"EndpointName"}, + "SortBy":{"shape":"MonitoringJobDefinitionSortKey"}, + "SortOrder":{"shape":"SortOrder"}, + "NextToken":{"shape":"NextToken"}, + "MaxResults":{"shape":"MaxResults"}, + "NameContains":{"shape":"NameContains"}, + "CreationTimeBefore":{"shape":"Timestamp"}, + "CreationTimeAfter":{"shape":"Timestamp"} + } + }, + "ListModelQualityJobDefinitionsResponse":{ + "type":"structure", + "required":["JobDefinitionSummaries"], + "members":{ + "JobDefinitionSummaries":{"shape":"MonitoringJobDefinitionSummaryList"}, + "NextToken":{"shape":"NextToken"} + } + }, "ListModelsInput":{ "type":"structure", "members":{ @@ -8501,7 +9734,9 @@ "CreationTimeAfter":{"shape":"Timestamp"}, "LastModifiedTimeBefore":{"shape":"Timestamp"}, "LastModifiedTimeAfter":{"shape":"Timestamp"}, - "StatusEquals":{"shape":"ExecutionStatus"} + "StatusEquals":{"shape":"ExecutionStatus"}, + "MonitoringJobDefinitionName":{"shape":"MonitoringJobDefinitionName"}, + "MonitoringTypeEquals":{"shape":"MonitoringType"} } }, "ListMonitoringExecutionsResponse":{ @@ -8525,7 +9760,9 @@ "CreationTimeAfter":{"shape":"Timestamp"}, "LastModifiedTimeBefore":{"shape":"Timestamp"}, "LastModifiedTimeAfter":{"shape":"Timestamp"}, - "StatusEquals":{"shape":"ScheduleStatus"} + "StatusEquals":{"shape":"ScheduleStatus"}, + "MonitoringJobDefinitionName":{"shape":"MonitoringJobDefinitionName"}, + "MonitoringTypeEquals":{"shape":"MonitoringType"} } }, "ListMonitoringSchedulesResponse":{ @@ -8929,6 +10166,7 @@ "CreateDate" ] }, + "Long":{"type":"long"}, "MaxAutoMLJobRuntimeInSeconds":{ "type":"integer", "min":1 @@ -9092,6 +10330,36 @@ "S3ModelArtifacts":{"shape":"S3Uri"} } }, + "ModelBiasAppSpecification":{ + "type":"structure", + "required":[ + "ImageUri", + "ConfigUri" + ], + "members":{ + "ImageUri":{"shape":"ImageUri"}, + "ConfigUri":{"shape":"S3Uri"}, + "Environment":{"shape":"MonitoringEnvironmentMap"} + } + }, + "ModelBiasBaselineConfig":{ + "type":"structure", + "members":{ + "BaseliningJobName":{"shape":"ProcessingJobName"}, + "ConstraintsResource":{"shape":"MonitoringConstraintsResource"} + } + }, + "ModelBiasJobInput":{ + "type":"structure", + "required":[ + "EndpointInput", + "GroundTruthS3Input" + ], + "members":{ + "EndpointInput":{"shape":"EndpointInput"}, + "GroundTruthS3Input":{"shape":"MonitoringGroundTruthS3Input"} + } + }, "ModelClientConfig":{ "type":"structure", "members":{ @@ -9112,6 +10380,32 @@ "ArtifactDigest":{"shape":"ArtifactDigest"} } }, + "ModelExplainabilityAppSpecification":{ + "type":"structure", + "required":[ + "ImageUri", + "ConfigUri" + ], + "members":{ + "ImageUri":{"shape":"ImageUri"}, + "ConfigUri":{"shape":"S3Uri"}, + "Environment":{"shape":"MonitoringEnvironmentMap"} + } + }, + "ModelExplainabilityBaselineConfig":{ + "type":"structure", + "members":{ + "BaseliningJobName":{"shape":"ProcessingJobName"}, + "ConstraintsResource":{"shape":"MonitoringConstraintsResource"} + } + }, + "ModelExplainabilityJobInput":{ + "type":"structure", + "required":["EndpointInput"], + "members":{ + "EndpointInput":{"shape":"EndpointInput"} + } + }, "ModelMetrics":{ "type":"structure", "members":{ @@ -9346,6 +10640,37 @@ "Constraints":{"shape":"MetricsSource"} } }, + "ModelQualityAppSpecification":{ + "type":"structure", + "required":["ImageUri"], + "members":{ + "ImageUri":{"shape":"ImageUri"}, + "ContainerEntrypoint":{"shape":"ContainerEntrypoint"}, + "ContainerArguments":{"shape":"MonitoringContainerArguments"}, + "RecordPreprocessorSourceUri":{"shape":"S3Uri"}, + "PostAnalyticsProcessorSourceUri":{"shape":"S3Uri"}, + "ProblemType":{"shape":"MonitoringProblemType"}, + "Environment":{"shape":"MonitoringEnvironmentMap"} + } + }, + "ModelQualityBaselineConfig":{ + "type":"structure", + "members":{ + "BaseliningJobName":{"shape":"ProcessingJobName"}, + "ConstraintsResource":{"shape":"MonitoringConstraintsResource"} + } + }, + "ModelQualityJobInput":{ + "type":"structure", + "required":[ + "EndpointInput", + "GroundTruthS3Input" + ], + "members":{ + "EndpointInput":{"shape":"EndpointInput"}, + "GroundTruthS3Input":{"shape":"MonitoringGroundTruthS3Input"} + } + }, "ModelSortKey":{ "type":"string", "enum":[ @@ -9390,6 +10715,7 @@ "MonitoringBaselineConfig":{ "type":"structure", "members":{ + "BaseliningJobName":{"shape":"ProcessingJobName"}, "ConstraintsResource":{"shape":"MonitoringConstraintsResource"}, "StatisticsResource":{"shape":"MonitoringStatisticsResource"} } @@ -9451,13 +10777,21 @@ "MonitoringExecutionStatus":{"shape":"ExecutionStatus"}, "ProcessingJobArn":{"shape":"ProcessingJobArn"}, "EndpointName":{"shape":"EndpointName"}, - "FailureReason":{"shape":"FailureReason"} + "FailureReason":{"shape":"FailureReason"}, + "MonitoringJobDefinitionName":{"shape":"MonitoringJobDefinitionName"}, + "MonitoringType":{"shape":"MonitoringType"} } }, "MonitoringExecutionSummaryList":{ "type":"list", "member":{"shape":"MonitoringExecutionSummary"} }, + "MonitoringGroundTruthS3Input":{ + "type":"structure", + "members":{ + "S3Uri":{"shape":"MonitoringS3Uri"} + } + }, "MonitoringInput":{ "type":"structure", "required":["EndpointInput"], @@ -9492,11 +10826,56 @@ "RoleArn":{"shape":"RoleArn"} } }, + "MonitoringJobDefinitionArn":{ + "type":"string", + "max":256, + "pattern":".*" + }, + "MonitoringJobDefinitionName":{ + "type":"string", + "max":63, + "min":1, + "pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9])*$" + }, + "MonitoringJobDefinitionSortKey":{ + "type":"string", + "enum":[ + "Name", + "CreationTime" + ] + }, + "MonitoringJobDefinitionSummary":{ + "type":"structure", + "required":[ + "MonitoringJobDefinitionName", + "MonitoringJobDefinitionArn", + "CreationTime", + "EndpointName" + ], + "members":{ + "MonitoringJobDefinitionName":{"shape":"MonitoringJobDefinitionName"}, + "MonitoringJobDefinitionArn":{"shape":"MonitoringJobDefinitionArn"}, + "CreationTime":{"shape":"Timestamp"}, + "EndpointName":{"shape":"EndpointName"} + } + }, + "MonitoringJobDefinitionSummaryList":{ + "type":"list", + "member":{"shape":"MonitoringJobDefinitionSummary"} + }, "MonitoringMaxRuntimeInSeconds":{ "type":"integer", "max":86400, "min":1 }, + "MonitoringNetworkConfig":{ + "type":"structure", + "members":{ + "EnableInterContainerTrafficEncryption":{"shape":"Boolean"}, + "EnableNetworkIsolation":{"shape":"Boolean"}, + "VpcConfig":{"shape":"VpcConfig"} + } + }, "MonitoringOutput":{ "type":"structure", "required":["S3Output"], @@ -9518,6 +10897,14 @@ "max":1, "min":1 }, + "MonitoringProblemType":{ + "type":"string", + "enum":[ + "BinaryClassification", + "MulticlassClassification", + "Regression" + ] + }, "MonitoringResources":{ "type":"structure", "required":["ClusterConfig"], @@ -9548,6 +10935,7 @@ "MonitoringScheduleArn":{"shape":"MonitoringScheduleArn"}, "MonitoringScheduleName":{"shape":"MonitoringScheduleName"}, "MonitoringScheduleStatus":{"shape":"ScheduleStatus"}, + "MonitoringType":{"shape":"MonitoringType"}, "FailureReason":{"shape":"FailureReason"}, "CreationTime":{"shape":"Timestamp"}, "LastModifiedTime":{"shape":"Timestamp"}, @@ -9566,7 +10954,9 @@ "type":"structure", "members":{ "ScheduleConfig":{"shape":"ScheduleConfig"}, - "MonitoringJobDefinition":{"shape":"MonitoringJobDefinition"} + "MonitoringJobDefinition":{"shape":"MonitoringJobDefinition"}, + "MonitoringJobDefinitionName":{"shape":"MonitoringJobDefinitionName"}, + "MonitoringType":{"shape":"MonitoringType"} } }, "MonitoringScheduleList":{ @@ -9602,7 +10992,9 @@ "CreationTime":{"shape":"Timestamp"}, "LastModifiedTime":{"shape":"Timestamp"}, "MonitoringScheduleStatus":{"shape":"ScheduleStatus"}, - "EndpointName":{"shape":"EndpointName"} + "EndpointName":{"shape":"EndpointName"}, + "MonitoringJobDefinitionName":{"shape":"MonitoringJobDefinitionName"}, + "MonitoringType":{"shape":"MonitoringType"} } }, "MonitoringScheduleSummaryList":{ @@ -9622,6 +11014,21 @@ "MaxRuntimeInSeconds":{"shape":"MonitoringMaxRuntimeInSeconds"} } }, + "MonitoringTimeOffsetString":{ + "type":"string", + "max":15, + "min":1, + "pattern":"^.?P.*" + }, + "MonitoringType":{ + "type":"string", + "enum":[ + "DataQuality", + "ModelQuality", + "ModelBias", + "ModelExplainability" + ] + }, "MountPath":{ "type":"string", "max":1024, @@ -10239,6 +11646,7 @@ "pattern":".*" }, "PresignedDomainUrl":{"type":"string"}, + "ProbabilityThresholdAttribute":{"type":"double"}, "ProblemType":{ "type":"string", "enum":[ @@ -10672,6 +12080,77 @@ "member":{"shape":"ProductionVariantSummary"}, "min":1 }, + "ProfilerConfig":{ + "type":"structure", + "required":["S3OutputPath"], + "members":{ + "S3OutputPath":{"shape":"S3Uri"}, + "ProfilingIntervalInMilliseconds":{"shape":"ProfilingIntervalInMilliseconds"}, + "ProfilingParameters":{"shape":"ProfilingParameters"} + } + }, + "ProfilerConfigForUpdate":{ + "type":"structure", + "members":{ + "S3OutputPath":{"shape":"S3Uri"}, + "ProfilingIntervalInMilliseconds":{"shape":"ProfilingIntervalInMilliseconds"}, + "ProfilingParameters":{"shape":"ProfilingParameters"}, + "DisableProfiler":{"shape":"DisableProfiler"} + } + }, + "ProfilerRuleConfiguration":{ + "type":"structure", + "required":[ + "RuleConfigurationName", + "RuleEvaluatorImage" + ], + "members":{ + "RuleConfigurationName":{"shape":"RuleConfigurationName"}, + "LocalPath":{"shape":"DirectoryPath"}, + "S3OutputPath":{"shape":"S3Uri"}, + "RuleEvaluatorImage":{"shape":"AlgorithmImage"}, + "InstanceType":{"shape":"ProcessingInstanceType"}, + "VolumeSizeInGB":{"shape":"OptionalVolumeSizeInGB"}, + "RuleParameters":{"shape":"RuleParameters"} + } + }, + "ProfilerRuleConfigurations":{ + "type":"list", + "member":{"shape":"ProfilerRuleConfiguration"}, + "max":20, + "min":0 + }, + "ProfilerRuleEvaluationStatus":{ + "type":"structure", + "members":{ + "RuleConfigurationName":{"shape":"RuleConfigurationName"}, + "RuleEvaluationJobArn":{"shape":"ProcessingJobArn"}, + "RuleEvaluationStatus":{"shape":"RuleEvaluationStatus"}, + "StatusDetails":{"shape":"StatusDetails"}, + "LastModifiedTime":{"shape":"Timestamp"} + } + }, + "ProfilerRuleEvaluationStatuses":{ + "type":"list", + "member":{"shape":"ProfilerRuleEvaluationStatus"}, + "max":20, + "min":0 + }, + "ProfilingIntervalInMilliseconds":{"type":"long"}, + "ProfilingParameters":{ + "type":"map", + "key":{"shape":"ConfigKey"}, + "value":{"shape":"ConfigValue"}, + "max":20, + "min":0 + }, + "ProfilingStatus":{ + "type":"string", + "enum":[ + "Enabled", + "Disabled" + ] + }, "ProjectArn":{ "type":"string", "max":2048, @@ -10886,6 +12365,18 @@ "min":1, "pattern":".*" }, + "RegisterDevicesRequest":{ + "type":"structure", + "required":[ + "DeviceFleetName", + "Devices" + ], + "members":{ + "DeviceFleetName":{"shape":"EntityName"}, + "Devices":{"shape":"Devices"}, + "Tags":{"shape":"TagList"} + } + }, "RegisterModelStepMetadata":{ "type":"structure", "members":{ @@ -11539,6 +13030,13 @@ "CompilationJobName":{"shape":"EntityName"} } }, + "StopEdgePackagingJobRequest":{ + "type":"structure", + "required":["EdgePackagingJobName"], + "members":{ + "EdgePackagingJobName":{"shape":"EntityName"} + } + }, "StopHyperParameterTuningJobRequest":{ "type":"structure", "required":["HyperParameterTuningJobName"], @@ -11876,6 +13374,11 @@ "max":3600, "min":0 }, + "ThingName":{ + "type":"string", + "max":128, + "pattern":"[a-zA-Z0-9:_-]+" + }, "Timestamp":{"type":"timestamp"}, "TrafficRoutingConfig":{ "type":"structure", @@ -12642,6 +14145,30 @@ "ContextArn":{"shape":"ContextArn"} } }, + "UpdateDeviceFleetRequest":{ + "type":"structure", + "required":[ + "DeviceFleetName", + "OutputConfig" + ], + "members":{ + "DeviceFleetName":{"shape":"EntityName"}, + "RoleArn":{"shape":"RoleArn"}, + "Description":{"shape":"DeviceFleetDescription"}, + "OutputConfig":{"shape":"EdgeOutputConfig"} + } + }, + "UpdateDevicesRequest":{ + "type":"structure", + "required":[ + "DeviceFleetName", + "Devices" + ], + "members":{ + "DeviceFleetName":{"shape":"EntityName"}, + "Devices":{"shape":"Devices"} + } + }, "UpdateDomainRequest":{ "type":"structure", "required":["DomainId"], @@ -12834,6 +14361,22 @@ "PipelineArn":{"shape":"PipelineArn"} } }, + "UpdateTrainingJobRequest":{ + "type":"structure", + "required":["TrainingJobName"], + "members":{ + "TrainingJobName":{"shape":"TrainingJobName"}, + "ProfilerConfig":{"shape":"ProfilerConfigForUpdate"}, + "ProfilerRuleConfigurations":{"shape":"ProfilerRuleConfigurations"} + } + }, + "UpdateTrainingJobResponse":{ + "type":"structure", + "required":["TrainingJobArn"], + "members":{ + "TrainingJobArn":{"shape":"TrainingJobArn"} + } + }, "UpdateTrialComponentRequest":{ "type":"structure", "required":["TrialComponentName"], diff --git a/models/apis/sagemaker/2017-07-24/docs-2.json b/models/apis/sagemaker/2017-07-24/docs-2.json index e8f293263e3..f0fa970dcb2 100644 --- a/models/apis/sagemaker/2017-07-24/docs-2.json +++ b/models/apis/sagemaker/2017-07-24/docs-2.json @@ -14,7 +14,10 @@ "CreateCodeRepository": "Creates a Git repository as a resource in your Amazon SageMaker account. You can associate the repository with notebook instances so that you can use Git source control for the notebooks you create. The Git repository is a resource in your Amazon SageMaker account, so it can be associated with more than one notebook instance, and it persists independently from the lifecycle of any notebook instances it is associated with.
The repository can be hosted either in AWS CodeCommit or in any other Git repository.
", "CreateCompilationJob": "Starts a model compilation job. After the model has been compiled, Amazon SageMaker saves the resulting model artifacts to an Amazon Simple Storage Service (Amazon S3) bucket that you specify.
If you choose to host your model using Amazon SageMaker hosting services, you can use the resulting model artifacts as part of the model. You can also use the artifacts with AWS IoT Greengrass. In that case, deploy them as an ML resource.
In the request body, you provide the following:
A name for the compilation job
Information about the input model artifacts
The output location for the compiled model and the device (target) that the model runs on
The Amazon Resource Name (ARN) of the IAM role that Amazon SageMaker assumes to perform the model compilation job.
You can also provide a Tag to track the model compilation job's resource use and costs. The response body contains the CompilationJobArn for the compiled job.
To stop a model compilation job, use StopCompilationJob. To get information about a particular model compilation job, use DescribeCompilationJob. To get information about multiple model compilation jobs, use ListCompilationJobs.
", "CreateContext": "Creates a context. A context is a lineage tracking entity that represents a logical grouping of other tracking or experiment entities. Some examples are an endpoint and a model package. For more information, see Amazon SageMaker ML Lineage Tracking.
", + "CreateDataQualityJobDefinition": "Creates a definition for a job that monitors data quality and drift. For information about model monitor, see Amazon SageMaker Model Monitor.
", + "CreateDeviceFleet": "Creates a device fleet.
", "CreateDomain": "Creates a Domain used by Amazon SageMaker Studio. A domain consists of an associated Amazon Elastic File System (EFS) volume, a list of authorized users, and a variety of security, application, policy, and Amazon Virtual Private Cloud (VPC) configurations. An AWS account is limited to one domain per region. Users within a domain can share notebook files and other artifacts with each other.
EFS storage
When a domain is created, an EFS volume is created for use by all of the users within the domain. Each user receives a private home directory within the EFS volume for notebooks, Git repositories, and data files.
SageMaker uses the AWS Key Management Service (AWS KMS) to encrypt the EFS volume attached to the domain with an AWS managed customer master key (CMK) by default. For more control, you can specify a customer managed CMK. For more information, see Protect Data at Rest Using Encryption.
VPC configuration
All SageMaker Studio traffic between the domain and the EFS volume is through the specified VPC and subnets. For other Studio traffic, you can specify the AppNetworkAccessType parameter. AppNetworkAccessType corresponds to the network access type that you choose when you onboard to Studio. The following options are available:
PublicInternetOnly - Non-EFS traffic goes through a VPC managed by Amazon SageMaker, which allows internet access. This is the default value.
VpcOnly - All Studio traffic is through the specified VPC and subnets. Internet access is disabled by default. To allow internet access, you must specify a NAT gateway.
When internet access is disabled, you won't be able to run a Studio notebook or to train or host models unless your VPC has an interface endpoint to the SageMaker API and runtime or a NAT gateway and your security groups allow outbound connections.
For more information, see Connect SageMaker Studio Notebooks to Resources in a VPC.
", + "CreateEdgePackagingJob": "Starts a SageMaker Edge Manager model packaging job. Edge Manager will use the model artifacts from the Amazon Simple Storage Service bucket that you specify. After the model has been packaged, Amazon SageMaker saves the resulting artifacts to an S3 bucket that you specify.
", "CreateEndpoint": "Creates an endpoint using the endpoint configuration specified in the request. Amazon SageMaker uses the endpoint to provision resources and deploy models. You create the endpoint configuration with the CreateEndpointConfig API.
Use this API to deploy models using Amazon SageMaker hosting services.
For an example that calls this method when deploying a model to Amazon SageMaker hosting services, see Deploy the Model to Amazon SageMaker Hosting Services (AWS SDK for Python (Boto 3)).
You must not delete an EndpointConfig that is in use by an endpoint that is live or while the UpdateEndpoint or CreateEndpoint operations are being performed on the endpoint. To update an endpoint, you must create a new EndpointConfig.
The endpoint name must be unique within an AWS Region in your AWS account.
When it receives the request, Amazon SageMaker creates the endpoint, launches the resources (ML compute instances), and deploys the model(s) on them.
When you call CreateEndpoint, a load call is made to DynamoDB to verify that your endpoint configuration exists. When you read data from a DynamoDB table supporting Eventually Consistent Reads , the response might not reflect the results of a recently completed write operation. The response might include some stale data. If the dependent entities are not yet in DynamoDB, this causes a validation error. If you repeat your read request after a short time, the response should return the latest data. So retry logic is recommended to handle these possible issues. We also recommend that customers call DescribeEndpointConfig before calling CreateEndpoint to minimize the potential impact of a DynamoDB eventually consistent read.
When Amazon SageMaker receives the request, it sets the endpoint status to Creating. After it creates the endpoint, it sets the status to InService. Amazon SageMaker can then process incoming requests for inferences. To check the status of an endpoint, use the DescribeEndpoint API.
If any of the models hosted at this endpoint get model data from an Amazon S3 location, Amazon SageMaker uses AWS Security Token Service to download model artifacts from the S3 path you provided. AWS STS is activated in your IAM user account by default. If you previously deactivated AWS STS for a region, you need to reactivate AWS STS for that region. For more information, see Activating and Deactivating AWS STS in an AWS Region in the AWS Identity and Access Management User Guide.
To add the IAM role policies for using this API operation, go to the IAM console, and choose Roles in the left navigation pane. Search the IAM role that you want to grant access to use the CreateEndpoint and CreateEndpointConfig API operations, add the following policies to the role.
Option 1: For a full Amazon SageMaker access, search and attach the AmazonSageMakerFullAccess policy.
Option 2: For granting a limited access to an IAM role, paste the following Action elements manually into the JSON file of the IAM role:
\"Action\": [\"sagemaker:CreateEndpoint\", \"sagemaker:CreateEndpointConfig\"]
\"Resource\": [
\"arn:aws:sagemaker:region:account-id:endpoint/endpointName\"
\"arn:aws:sagemaker:region:account-id:endpoint-config/endpointConfigName\"
]
For more information, see Amazon SageMaker API Permissions: Actions, Permissions, and Resources Reference.
Creates an endpoint configuration that Amazon SageMaker hosting services uses to deploy models. In the configuration, you identify one or more models, created using the CreateModel API, to deploy and the resources that you want Amazon SageMaker to provision. Then you call the CreateEndpoint API.
Use this API if you want to use Amazon SageMaker hosting services to deploy models into production.
In the request, you define a ProductionVariant, for each model that you want to deploy. Each ProductionVariant parameter also describes the resources that you want Amazon SageMaker to provision. This includes the number and type of ML compute instances to deploy.
If you are hosting multiple models, you also assign a VariantWeight to specify how much traffic you want to allocate to each model. For example, suppose that you want to host two models, A and B, and you assign traffic weight 2 for model A and 1 for model B. Amazon SageMaker distributes two-thirds of the traffic to Model A, and one-third to model B.
For an example that calls this method when deploying a model to Amazon SageMaker hosting services, see Deploy the Model to Amazon SageMaker Hosting Services (AWS SDK for Python (Boto 3)).
When you call CreateEndpoint, a load call is made to DynamoDB to verify that your endpoint configuration exists. When you read data from a DynamoDB table supporting Eventually Consistent Reads , the response might not reflect the results of a recently completed write operation. The response might include some stale data. If the dependent entities are not yet in DynamoDB, this causes a validation error. If you repeat your read request after a short time, the response should return the latest data. So retry logic is recommended to handle these possible issues. We also recommend that customers call DescribeEndpointConfig before calling CreateEndpoint to minimize the potential impact of a DynamoDB eventually consistent read.
Creates an SageMaker experiment. An experiment is a collection of trials that are observed, compared and evaluated as a group. A trial is a set of steps, called trial components, that produce a machine learning model.
The goal of an experiment is to determine the components that produce the best model. Multiple trials are performed, each one isolating and measuring the impact of a change to one or more inputs, while keeping the remaining inputs constant.
When you use Amazon SageMaker Studio or the Amazon SageMaker Python SDK, all experiments, trials, and trial components are automatically tracked, logged, and indexed. When you use the AWS SDK for Python (Boto), you must use the logging APIs provided by the SDK.
You can add tags to experiments, trials, trial components and then use the Search API to search for the tags.
To add a description to an experiment, specify the optional Description parameter. To add a description later, or to change the description, call the UpdateExperiment API.
To get a list of all your experiments, call the ListExperiments API. To view an experiment's properties, call the DescribeExperiment API. To get a list of all the trials associated with an experiment, call the ListTrials API. To create a trial call the CreateTrial API.
", @@ -26,8 +29,11 @@ "CreateImageVersion": "Creates a version of the SageMaker image specified by ImageName. The version represents the Amazon Container Registry (ECR) container image specified by BaseImage.
Creates a job that uses workers to label the data objects in your input dataset. You can use the labeled data to train machine learning models.
You can select your workforce from one of three providers:
A private workforce that you create. It can include employees, contractors, and outside experts. Use a private workforce when want the data to stay within your organization or when a specific set of skills is required.
One or more vendors that you select from the AWS Marketplace. Vendors provide expertise in specific areas.
The Amazon Mechanical Turk workforce. This is the largest workforce, but it should only be used for public data or data that has been stripped of any personally identifiable information.
You can also use automated data labeling to reduce the number of data objects that need to be labeled by a human. Automated data labeling uses active learning to determine if a data object can be labeled by machine or if it needs to be sent to a human worker. For more information, see Using Automated Data Labeling.
The data objects to be labeled are contained in an Amazon S3 bucket. You create a manifest file that describes the location of each object. For more information, see Using Input and Output Data.
The output can be used as the manifest file for another labeling job or as training data for your machine learning models.
", "CreateModel": "Creates a model in Amazon SageMaker. In the request, you name the model and describe a primary container. For the primary container, you specify the Docker image that contains inference code, artifacts (from prior training), and a custom environment map that the inference code uses when you deploy the model for predictions.
Use this API to create a model if you want to use Amazon SageMaker hosting services or run a batch transform job.
To host your model, you create an endpoint configuration with the CreateEndpointConfig API, and then create an endpoint with the CreateEndpoint API. Amazon SageMaker then deploys all of the containers that you defined for the model in the hosting environment.
For an example that calls this method when deploying a model to Amazon SageMaker hosting services, see Deploy the Model to Amazon SageMaker Hosting Services (AWS SDK for Python (Boto 3)).
To run a batch transform using your model, you start a job with the CreateTransformJob API. Amazon SageMaker uses your model and your dataset to get inferences which are then saved to a specified S3 location.
In the CreateModel request, you must define a container with the PrimaryContainer parameter.
In the request, you also provide an IAM role that Amazon SageMaker can assume to access model artifacts and docker image for deployment on ML compute hosting instances or for batch transform jobs. In addition, you also use the IAM role to manage permissions the inference code needs. For example, if the inference code access any other AWS resources, you grant necessary permissions via this role.
", + "CreateModelBiasJobDefinition": "Creates the definition for a model bias job.
", + "CreateModelExplainabilityJobDefinition": "Creates the definition for a model explainability job.
", "CreateModelPackage": "Creates a model package that you can use to create Amazon SageMaker models or list on AWS Marketplace, or a versioned model that is part of a model group. Buyers can subscribe to model packages listed on AWS Marketplace to create models in Amazon SageMaker.
To create a model package by specifying a Docker container that contains your inference code and the Amazon S3 location of your model artifacts, provide values for InferenceSpecification. To create a model from an algorithm resource that you created or subscribed to in AWS Marketplace, provide a value for SourceAlgorithmSpecification.
There are two types of model packages:
Versioned - a model that is part of a model group in the model registry.
Unversioned - a model package that is not part of a model group.
Creates a model group. A model group contains a group of model versions.
", + "CreateModelQualityJobDefinition": "Creates a definition for a job that monitors model quality and drift. For information about model monitor, see Amazon SageMaker Model Monitor.
", "CreateMonitoringSchedule": "Creates a schedule that regularly starts Amazon SageMaker Processing Jobs to monitor the data captured for an Amazon SageMaker Endoint.
", "CreateNotebookInstance": "Creates an Amazon SageMaker notebook instance. A notebook instance is a machine learning (ML) compute instance running on a Jupyter notebook.
In a CreateNotebookInstance request, specify the type of ML compute instance that you want to run. Amazon SageMaker launches the instance, installs common libraries that you can use to explore datasets for model training, and attaches an ML storage volume to the notebook instance.
Amazon SageMaker also provides a set of example notebooks. Each notebook demonstrates how to use Amazon SageMaker with a specific algorithm or with a machine learning framework.
After receiving the request, Amazon SageMaker does the following:
Creates a network interface in the Amazon SageMaker VPC.
(Option) If you specified SubnetId, Amazon SageMaker creates a network interface in your own VPC, which is inferred from the subnet ID that you provide in the input. When creating this network interface, Amazon SageMaker attaches the security group that you specified in the request to the network interface that it creates in your VPC.
Launches an EC2 instance of the type specified in the request in the Amazon SageMaker VPC. If you specified SubnetId of your VPC, Amazon SageMaker specifies both network interfaces when launching this instance. This enables inbound traffic from your own VPC to the notebook instance, assuming that the security groups allow it.
After creating the notebook instance, Amazon SageMaker returns its Amazon Resource Name (ARN). You can't change the name of a notebook instance after you create it.
After Amazon SageMaker creates the notebook instance, you can connect to the Jupyter server and work in Jupyter notebooks. For example, you can write code to explore a dataset that you can use for model training, train a model, host models by creating Amazon SageMaker endpoints, and validate hosted models.
For more information, see How It Works.
", "CreateNotebookInstanceLifecycleConfig": "Creates a lifecycle configuration that you can associate with a notebook instance. A lifecycle configuration is a collection of shell scripts that run when you create or start a notebook instance.
Each lifecycle configuration script has a limit of 16384 characters.
The value of the $PATH environment variable that is available to both scripts is /sbin:bin:/usr/sbin:/usr/bin.
View CloudWatch Logs for notebook instance lifecycle configurations in log group /aws/sagemaker/NotebookInstances in log stream [notebook-instance-name]/[LifecycleConfigHook].
Lifecycle configuration scripts cannot run for longer than 5 minutes. If a script runs for longer than 5 minutes, it fails and the notebook instance is not created or started.
For information about notebook instance lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance.
", @@ -51,6 +57,8 @@ "DeleteAssociation": "Deletes an association.
", "DeleteCodeRepository": "Deletes the specified Git repository from your account.
", "DeleteContext": "Deletes an context.
", + "DeleteDataQualityJobDefinition": "Deletes a data quality monitoring job definition.
", + "DeleteDeviceFleet": "Deletes a fleet.
", "DeleteDomain": "Used to delete a domain. If you onboarded with IAM mode, you will need to delete your domain to onboard again using SSO. Use with caution. All of the members of the domain will lose access to their EFS volume, including data, notebooks, and other artifacts.
", "DeleteEndpoint": "Deletes an endpoint. Amazon SageMaker frees up all of the resources that were deployed when the endpoint was created.
Amazon SageMaker retires any custom KMS key grants associated with the endpoint, meaning you don't need to use the RevokeGrant API call.
", "DeleteEndpointConfig": "Deletes an endpoint configuration. The DeleteEndpointConfig API deletes only the specified configuration. It does not delete endpoints created using the configuration.
You must not delete an EndpointConfig in use by an endpoint that is live or while the UpdateEndpoint or CreateEndpoint operations are being performed on the endpoint. If you delete the EndpointConfig of an endpoint that is active or being created or updated you may lose visibility into the instance type the endpoint is using. The endpoint must be deleted in order to stop incurring charges.
Deletes a SageMaker image and all versions of the image. The container images aren't deleted.
", "DeleteImageVersion": "Deletes a version of a SageMaker image. The container image the version represents isn't deleted.
", "DeleteModel": "Deletes a model. The DeleteModel API deletes only the model entry that was created in Amazon SageMaker when you called the CreateModel API. It does not delete model artifacts, inference code, or the IAM role that you specified when creating the model.
Deletes an Amazon SageMaker model bias job definition.
", + "DeleteModelExplainabilityJobDefinition": "Deletes an Amazon SageMaker model explainability job definition.
", "DeleteModelPackage": "Deletes a model package.
A model package is used to create Amazon SageMaker models or list on AWS Marketplace. Buyers can subscribe to model packages listed on AWS Marketplace to create models in Amazon SageMaker.
", "DeleteModelPackageGroup": "Deletes the specified model group.
", "DeleteModelPackageGroupPolicy": "Deletes a model group resource policy.
", + "DeleteModelQualityJobDefinition": "Deletes the secified model quality monitoring job definition.
", "DeleteMonitoringSchedule": "Deletes a monitoring schedule. Also stops the schedule had not already been stopped. This does not delete the job execution history of the monitoring schedule.
", "DeleteNotebookInstance": " Deletes an Amazon SageMaker notebook instance. Before you can delete a notebook instance, you must call the StopNotebookInstance API.
When you delete a notebook instance, you lose all of your data. Amazon SageMaker removes the ML compute instance, and deletes the ML storage volume and the network interface associated with the notebook instance.
Deletes a notebook instance lifecycle configuration.
", - "DeletePipeline": "Deletes a pipeline.
", + "DeletePipeline": "Deletes a pipeline if there are no in-progress executions.
", "DeleteProject": "Delete the specified project.
", "DeleteTags": "Deletes the specified tags from an Amazon SageMaker resource.
To list a resource's tags, use the ListTags API.
When you call this API to delete tags from a hyperparameter tuning job, the deleted tags are not removed from training jobs that the hyperparameter tuning job launched before you called this API.
Deletes the specified trial. All trial components that make up the trial must be deleted first. Use the DescribeTrialComponent API to get the list of trial components.
", @@ -75,6 +86,7 @@ "DeleteUserProfile": "Deletes a user profile. When a user profile is deleted, the user loses access to their EFS volume, including data, notebooks, and other artifacts.
", "DeleteWorkforce": "Use this operation to delete a workforce.
If you want to create a new workforce in an AWS Region where a workforce already exists, use this operation to delete the existing workforce and then use to create a new workforce.
If a private workforce contains one or more work teams, you must use the operation to delete all work teams before you delete the workforce. If you try to delete a workforce that contains one or more work teams, you will recieve a ResourceInUse error.
Deletes an existing work team. This operation can't be undone.
", + "DeregisterDevices": "Deregisters the specified devices. After you deregister a device, you will need to re-register the devices.
", "DescribeAction": "Describes an action.
", "DescribeAlgorithm": "Returns a description of the specified algorithm that is in your account.
", "DescribeApp": "Describes the app.
", @@ -84,7 +96,11 @@ "DescribeCodeRepository": "Gets details about the specified Git repository.
", "DescribeCompilationJob": "Returns information about a model compilation job.
To create a model compilation job, use CreateCompilationJob. To get information about multiple model compilation jobs, use ListCompilationJobs.
", "DescribeContext": "Describes a context.
", + "DescribeDataQualityJobDefinition": "Gets the details of a data quality monitoring job definition.
", + "DescribeDevice": "Describes the device.
", + "DescribeDeviceFleet": "A description of the fleet the device belongs to.
", "DescribeDomain": "The description of the domain.
", + "DescribeEdgePackagingJob": "A description of edge packaging jobs.
", "DescribeEndpoint": "Returns the description of an endpoint.
", "DescribeEndpointConfig": "Returns the description of an endpoint configuration created using the CreateEndpointConfig API.
Provides a list of an experiment's properties.
", @@ -96,8 +112,11 @@ "DescribeImageVersion": "Describes a version of a SageMaker image.
", "DescribeLabelingJob": "Gets information about a labeling job.
", "DescribeModel": "Describes a model that you created using the CreateModel API.
Returns a description of a model bias job definition.
", + "DescribeModelExplainabilityJobDefinition": "Returns a description of a model explainability job definition.
", "DescribeModelPackage": "Returns a description of the specified model package, which is used to create Amazon SageMaker models or list them on AWS Marketplace.
To create models in Amazon SageMaker, buyers can subscribe to model packages listed on AWS Marketplace.
", "DescribeModelPackageGroup": "Gets a description for the specified model group.
", + "DescribeModelQualityJobDefinition": "Returns a description of a model quality job definition.
", "DescribeMonitoringSchedule": "Describes the schedule for a monitoring job.
", "DescribeNotebookInstance": "Returns information about a notebook instance.
", "DescribeNotebookInstanceLifecycleConfig": "Returns a description of a notebook instance lifecycle configuration.
For information about notebook instance lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance.
", @@ -117,6 +136,7 @@ "DisableSagemakerServicecatalogPortfolio": "Disables using Service Catalog in SageMaker. Service Catalog is used to create SageMaker projects.
", "DisassociateTrialComponent": "Disassociates a trial component from a trial. This doesn't effect other trials the component is associated with. Before you can delete a component, you must disassociate the component from all trials it is associated with. To associate a trial component with a trial, call the AssociateTrialComponent API.
To get a list of the trials a component is associated with, use the Search API. Specify ExperimentTrialComponent for the Resource parameter. The list appears in the response under Results.TrialComponent.Parents.
Enables using Service Catalog in SageMaker. Service Catalog is used to create SageMaker projects.
", + "GetDeviceFleetReport": "Describes a fleet.
", "GetModelPackageGroupPolicy": "Gets a resource policy that manages access for a model group. For information about resource policies, see Identity-based policies and resource-based policies in the AWS Identity and Access Management User Guide..
", "GetSagemakerServicecatalogPortfolioStatus": "Gets the status of Service Catalog in SageMaker. Service Catalog is used to create SageMaker projects.
", "GetSearchSuggestions": "An auto-complete API for the search functionality in the Amazon SageMaker console. It returns suggestions of possible matches for the property name to use in Search queries. Provides suggestions for HyperParameters, Tags, and Metrics.
Gets a list of the Git repositories in your account.
", "ListCompilationJobs": "Lists model compilation jobs that satisfy various filters.
To create a model compilation job, use CreateCompilationJob. To get information about a particular model compilation job you have created, use DescribeCompilationJob.
", "ListContexts": "Lists the contexts in your account and their properties.
", + "ListDataQualityJobDefinitions": "Lists the data quality job definitions in your account.
", + "ListDeviceFleets": "Returns a list of devices in the fleet.
", + "ListDevices": "A list of devices.
", "ListDomains": "Lists the domains.
", + "ListEdgePackagingJobs": "Returns a list of edge packaging jobs.
", "ListEndpointConfigs": "Lists endpoint configurations.
", "ListEndpoints": "Lists endpoints.
", "ListExperiments": "Lists all the experiments in your account. The list can be filtered to show only experiments that were created in a specific time range. The list can be sorted by experiment name or creation time.
", @@ -143,8 +167,11 @@ "ListImages": "Lists the images in your account and their properties. The list can be filtered by creation time or modified time, and whether the image name contains a specified string.
", "ListLabelingJobs": "Gets a list of labeling jobs.
", "ListLabelingJobsForWorkteam": "Gets a list of labeling jobs assigned to a specified work team.
", + "ListModelBiasJobDefinitions": "Lists model bias jobs definitions that satisfy various filters.
", + "ListModelExplainabilityJobDefinitions": "Lists model explainability job definitions that satisfy various filters.
", "ListModelPackageGroups": "Gets a list of the model groups in your AWS account.
", "ListModelPackages": "Lists the model packages that have been created.
", + "ListModelQualityJobDefinitions": "Gets a list of model quality monitoring job definitions in your account.
", "ListModels": "Lists models created with the CreateModel API.
", "ListMonitoringExecutions": "Returns list of all monitoring job executions.
", "ListMonitoringSchedules": "Returns list of all monitoring schedules.
", @@ -167,13 +194,15 @@ "ListWorkforces": "Use this operation to list all private and vendor workforces in an AWS Region. Note that you can only have one private workforce per AWS Region.
", "ListWorkteams": "Gets a list of private work teams that you have defined in a region. The list may be empty if no work team satisfies the filter specified in the NameContains parameter.
Adds a resouce policy to control access to a model group. For information about resoure policies, see Identity-based policies and resource-based policies in the AWS Identity and Access Management User Guide..
", + "RegisterDevices": "Register devices.
", "RenderUiTemplate": "Renders the UI template so that you can preview the worker's experience.
", "Search": "Finds Amazon SageMaker resources that match a search query. Matching resources are returned as a list of SearchRecord objects in the response. You can sort the search results by any resource property in a ascending or descending order.
You can query against the following value types: numeric, text, Boolean, and timestamp.
", - "StartMonitoringSchedule": "Starts a previously stopped monitoring schedule.
New monitoring schedules are immediately started after creation.
Starts a previously stopped monitoring schedule.
By default, when you successfully create a new schedule, the status of a monitoring schedule is scheduled.
Launches an ML compute instance with the latest version of the libraries and attaches your ML storage volume. After configuring the notebook instance, Amazon SageMaker sets the notebook instance status to InService. A notebook instance's status must be InService before you can connect to your Jupyter notebook.
Starts a pipeline execution.
", "StopAutoMLJob": "A method for forcing the termination of a running job.
", "StopCompilationJob": "Stops a model compilation job.
To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal. This gracefully shuts the job down. If the job hasn't stopped, it sends the SIGKILL signal.
When it receives a StopCompilationJob request, Amazon SageMaker changes the CompilationJobSummary$CompilationJobStatus of the job to Stopping. After Amazon SageMaker stops the job, it sets the CompilationJobSummary$CompilationJobStatus to Stopped.
Request to stop an edge packaging job.
", "StopHyperParameterTuningJob": "Stops a running hyperparameter tuning job and all running training jobs that the tuning job launched.
All model artifacts output from the training jobs are stored in Amazon Simple Storage Service (Amazon S3). All data that the training jobs write to Amazon CloudWatch Logs are still available in CloudWatch. After the tuning job moves to the Stopped state, it releases all reserved resources for the tuning job.
Stops a running labeling job. A job that is stopped cannot be restarted. Any results obtained before the job is stopped are placed in the Amazon S3 output bucket.
", "StopMonitoringSchedule": "Stops a previously started monitoring schedule.
", @@ -187,6 +216,8 @@ "UpdateArtifact": "Updates an artifact.
", "UpdateCodeRepository": "Updates the specified Git repository with the specified values.
", "UpdateContext": "Updates a context.
", + "UpdateDeviceFleet": "Updates a fleet of devices.
", + "UpdateDevices": "Updates one or more devices in a fleet.
", "UpdateDomain": "Updates the default settings for new user profiles in the domain.
", "UpdateEndpoint": "Deploys the new EndpointConfig specified in the request, switches to using newly created endpoint, and then deletes resources provisioned for the endpoint using the previous EndpointConfig (there is no availability loss).
When Amazon SageMaker receives the request, it sets the endpoint status to Updating. After updating the endpoint, it sets the status to InService. To check the status of an endpoint, use the DescribeEndpoint API.
You must not delete an EndpointConfig in use by an endpoint that is live or while the UpdateEndpoint or CreateEndpoint operations are being performed on the endpoint. To update an endpoint, you must create a new EndpointConfig.
If you delete the EndpointConfig of an endpoint that is active or being created or updated you may lose visibility into the instance type the endpoint is using. The endpoint must be deleted in order to stop incurring charges.
Updates variant weight of one or more variants associated with an existing endpoint, or capacity of one variant associated with an existing endpoint. When it receives the request, Amazon SageMaker sets the endpoint status to Updating. After updating the endpoint, it sets the status to InService. To check the status of an endpoint, use the DescribeEndpoint API.
Updates a notebook instance lifecycle configuration created with the CreateNotebookInstanceLifecycleConfig API.
", "UpdatePipeline": "Updates a pipeline.
", "UpdatePipelineExecution": "Updates a pipeline execution.
", + "UpdateTrainingJob": "Update a model training job to request a new Debugger profiling configuration.
", "UpdateTrial": "Updates the display name of a trial.
", "UpdateTrialComponent": "Updates one or more properties of a trial component.
", "UpdateUserProfile": "Updates a user profile.
", @@ -285,6 +317,18 @@ "UpdateNotebookInstanceInput$AdditionalCodeRepositories": "An array of up to three Git repositories to associate with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in AWS CodeCommit or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance. For more information, see Associating Git Repositories with Amazon SageMaker Notebook Instances.
" } }, + "AgentVersion": { + "base": "Edge Manager agent version.
", + "refs": { + "AgentVersions$member": null + } + }, + "AgentVersions": { + "base": null, + "refs": { + "GetDeviceFleetReportResponse$AgentVersions": "The versions of Edge Manager agent deployed on the fleet.
" + } + }, "Alarm": { "base": "This API is not supported.
", "refs": { @@ -316,7 +360,8 @@ "refs": { "AlgorithmSpecification$TrainingImage": "The registry path of the Docker image that contains the training algorithm. For information about docker registry paths for built-in algorithms, see Algorithms Provided by Amazon SageMaker: Common Parameters. Amazon SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker.
The Amazon Elastic Container (ECR) Image for the managed rule evaluation.
", - "HyperParameterAlgorithmSpecification$TrainingImage": " The registry path of the Docker image that contains the training algorithm. For information about Docker registry paths for built-in algorithms, see Algorithms Provided by Amazon SageMaker: Common Parameters. Amazon SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker.
The registry path of the Docker image that contains the training algorithm. For information about Docker registry paths for built-in algorithms, see Algorithms Provided by Amazon SageMaker: Common Parameters. Amazon SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker.
The Amazon Elastic Container (ECR) Image for the managed rule evaluation.
" } }, "AlgorithmSortBy": { @@ -975,6 +1020,8 @@ "HyperParameterTrainingJobDefinition$EnableNetworkIsolation": "Isolates the training container. No inbound or outbound network calls can be made, except for calls between peers within a training cluster for distributed training. If network isolation is used for training jobs that are configured to use a VPC, Amazon SageMaker downloads and uploads customer data and model artifacts through the specified VPC, but the training container does not have network access.
", "HyperParameterTrainingJobDefinition$EnableInterContainerTrafficEncryption": "To encrypt all communications between ML compute instances in distributed training, choose True. Encryption provides greater security for distributed training, but training might take longer. How long it takes depends on the amount of communication between compute instances, especially if you use a deep learning algorithm in distributed training.
A Boolean indicating whether managed spot training is enabled (True) or not (False).
Whether to encrypt all communications between the instances used for the monitoring jobs. Choose True to encrypt communications. Encryption provides greater security for distributed jobs, but the processing might take longer.
Whether to allow inbound and outbound network calls to and from the containers used for the monitoring job.
", "NetworkConfig$EnableInterContainerTrafficEncryption": "Whether to encrypt all communications between distributed processing jobs. Choose True to encrypt communications. Encryption provides greater security for distributed processing jobs, but the processing might take longer.
Whether to allow inbound and outbound network calls to and from the containers used for the processing job.
", "OfflineStoreConfig$DisableGlueTableCreation": "Set to True to disable the automatic creation of an AWS Glue table when configuring an OfflineStore.
Configuration information for tensor collections.
", + "base": "Configuration information for the Debugger output tensor collections.
", "refs": { "CollectionConfigurations$member": null } @@ -1301,7 +1348,7 @@ "CollectionConfigurations": { "base": null, "refs": { - "DebugHookConfig$CollectionConfigurations": "Configuration information for tensor collections.
" + "DebugHookConfig$CollectionConfigurations": "Configuration information for Debugger tensor collections. To learn more about how to configure the CollectionConfiguration parameter, see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.
The entrypoint for a container used to run a processing job.
", + "DataQualityAppSpecification$ContainerEntrypoint": "The entrypoint for a container used to run a monitoring job.
", + "ModelQualityAppSpecification$ContainerEntrypoint": "Specifies the entrypoint for a container that the monitoring job runs.
", "MonitoringAppSpecification$ContainerEntrypoint": "Specifies the entrypoint for a container used to run the monitoring job.
" } }, @@ -1635,6 +1686,21 @@ "refs": { } }, + "CreateDataQualityJobDefinitionRequest": { + "base": null, + "refs": { + } + }, + "CreateDataQualityJobDefinitionResponse": { + "base": null, + "refs": { + } + }, + "CreateDeviceFleetRequest": { + "base": null, + "refs": { + } + }, "CreateDomainRequest": { "base": null, "refs": { @@ -1645,6 +1711,11 @@ "refs": { } }, + "CreateEdgePackagingJobRequest": { + "base": null, + "refs": { + } + }, "CreateEndpointConfigInput": { "base": null, "refs": { @@ -1745,6 +1816,26 @@ "refs": { } }, + "CreateModelBiasJobDefinitionRequest": { + "base": null, + "refs": { + } + }, + "CreateModelBiasJobDefinitionResponse": { + "base": null, + "refs": { + } + }, + "CreateModelExplainabilityJobDefinitionRequest": { + "base": null, + "refs": { + } + }, + "CreateModelExplainabilityJobDefinitionResponse": { + "base": null, + "refs": { + } + }, "CreateModelInput": { "base": null, "refs": { @@ -1775,6 +1866,16 @@ "refs": { } }, + "CreateModelQualityJobDefinitionRequest": { + "base": null, + "refs": { + } + }, + "CreateModelQualityJobDefinitionResponse": { + "base": null, + "refs": { + } + }, "CreateMonitoringScheduleRequest": { "base": null, "refs": { @@ -2040,6 +2141,27 @@ "TransformJob$DataProcessing": null } }, + "DataQualityAppSpecification": { + "base": "Information about the container that a data quality monitoring job runs.
", + "refs": { + "CreateDataQualityJobDefinitionRequest$DataQualityAppSpecification": "Specifies the container that runs the monitoring job.
", + "DescribeDataQualityJobDefinitionResponse$DataQualityAppSpecification": "Information about the container that runs the data quality monitoring job.
" + } + }, + "DataQualityBaselineConfig": { + "base": "Configuration for monitoring constraints and monitoring statistics. These baseline resources are compared against the results of the current job from the series of jobs scheduled to collect data periodically.
", + "refs": { + "CreateDataQualityJobDefinitionRequest$DataQualityBaselineConfig": "Configures the constraints and baselines for the monitoring job.
", + "DescribeDataQualityJobDefinitionResponse$DataQualityBaselineConfig": "The constraints and baselines for the data quality monitoring job definition.
" + } + }, + "DataQualityJobInput": { + "base": "The input for the data quality monitoring job. Currently endpoints are supported for input.
", + "refs": { + "CreateDataQualityJobDefinitionRequest$DataQualityJobInput": "A list of inputs for the monitoring job. Currently endpoints are supported as monitoring inputs.
", + "DescribeDataQualityJobDefinitionResponse$DataQualityJobInput": "The list of inputs for the data quality monitoring job. Currently endpoints are supported.
" + } + }, "DataSource": { "base": "Describes the location of the channel data.
", "refs": { @@ -2059,7 +2181,7 @@ } }, "DebugHookConfig": { - "base": "Configuration information for the debug hook parameters, collection configuration, and storage paths.
", + "base": "Configuration information for the Debugger hook parameters, metric and tensor collections, and storage paths. To learn more about how to configure the DebugHookConfig parameter, see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.
Configuration information for debugging rules.
", + "base": "Configuration information for SageMaker Debugger rules for debugging. To learn more about how to configure the DebugRuleConfiguration parameter, see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.
Configuration information for debugging rules.
", - "DescribeTrainingJobResponse$DebugRuleConfigurations": "Configuration information for debugging rules.
", + "CreateTrainingJobRequest$DebugRuleConfigurations": "Configuration information for Debugger rules for debugging output tensors.
", + "DescribeTrainingJobResponse$DebugRuleConfigurations": "Configuration information for Debugger rules for debugging output tensors.
", "TrainingJob$DebugRuleConfigurations": "Information about the debug rule configuration.
" } }, @@ -2089,7 +2211,7 @@ "DebugRuleEvaluationStatuses": { "base": null, "refs": { - "DescribeTrainingJobResponse$DebugRuleEvaluationStatuses": "Status about the debug rule evaluation.
", + "DescribeTrainingJobResponse$DebugRuleEvaluationStatuses": "Evaluation status of Debugger rules for debugging on a training job.
", "TrainingJob$DebugRuleEvaluationStatuses": "Information about the evaluation status of the rules for the training job.
" } }, @@ -2165,6 +2287,16 @@ "refs": { } }, + "DeleteDataQualityJobDefinitionRequest": { + "base": null, + "refs": { + } + }, + "DeleteDeviceFleetRequest": { + "base": null, + "refs": { + } + }, "DeleteDomainRequest": { "base": null, "refs": { @@ -2235,6 +2367,16 @@ "refs": { } }, + "DeleteModelBiasJobDefinitionRequest": { + "base": null, + "refs": { + } + }, + "DeleteModelExplainabilityJobDefinitionRequest": { + "base": null, + "refs": { + } + }, "DeleteModelInput": { "base": null, "refs": { @@ -2255,6 +2397,11 @@ "refs": { } }, + "DeleteModelQualityJobDefinitionRequest": { + "base": null, + "refs": { + } + }, "DeleteMonitoringScheduleRequest": { "base": null, "refs": { @@ -2359,6 +2506,11 @@ "UpdateEndpointInput$DeploymentConfig": "The deployment configuration for the endpoint to be updated.
" } }, + "DeregisterDevicesRequest": { + "base": null, + "refs": { + } + }, "DescribeActionRequest": { "base": null, "refs": { @@ -2449,6 +2601,36 @@ "refs": { } }, + "DescribeDataQualityJobDefinitionRequest": { + "base": null, + "refs": { + } + }, + "DescribeDataQualityJobDefinitionResponse": { + "base": null, + "refs": { + } + }, + "DescribeDeviceFleetRequest": { + "base": null, + "refs": { + } + }, + "DescribeDeviceFleetResponse": { + "base": null, + "refs": { + } + }, + "DescribeDeviceRequest": { + "base": null, + "refs": { + } + }, + "DescribeDeviceResponse": { + "base": null, + "refs": { + } + }, "DescribeDomainRequest": { "base": null, "refs": { @@ -2459,6 +2641,16 @@ "refs": { } }, + "DescribeEdgePackagingJobRequest": { + "base": null, + "refs": { + } + }, + "DescribeEdgePackagingJobResponse": { + "base": null, + "refs": { + } + }, "DescribeEndpointConfigInput": { "base": null, "refs": { @@ -2559,6 +2751,26 @@ "refs": { } }, + "DescribeModelBiasJobDefinitionRequest": { + "base": null, + "refs": { + } + }, + "DescribeModelBiasJobDefinitionResponse": { + "base": null, + "refs": { + } + }, + "DescribeModelExplainabilityJobDefinitionRequest": { + "base": null, + "refs": { + } + }, + "DescribeModelExplainabilityJobDefinitionResponse": { + "base": null, + "refs": { + } + }, "DescribeModelInput": { "base": null, "refs": { @@ -2589,6 +2801,16 @@ "refs": { } }, + "DescribeModelQualityJobDefinitionRequest": { + "base": null, + "refs": { + } + }, + "DescribeModelQualityJobDefinitionResponse": { + "base": null, + "refs": { + } + }, "DescribeMonitoringScheduleRequest": { "base": null, "refs": { @@ -2788,6 +3010,94 @@ "ModelPackageStatusItem$Status": "The current status.
" } }, + "Device": { + "base": "Information of a particular device.
", + "refs": { + "Devices$member": null + } + }, + "DeviceArn": { + "base": null, + "refs": { + "DescribeDeviceResponse$DeviceArn": "The Amazon Resource Name (ARN) of the device.
", + "DeviceSummary$DeviceArn": "Amazon Resource Name (ARN) of the device.
" + } + }, + "DeviceDescription": { + "base": null, + "refs": { + "DescribeDeviceResponse$Description": "A description of the device.
", + "Device$Description": "Description of the device.
", + "DeviceSummary$Description": "A description of the device.
" + } + }, + "DeviceFleetArn": { + "base": null, + "refs": { + "DescribeDeviceFleetResponse$DeviceFleetArn": "The The Amazon Resource Name (ARN) of the fleet.
", + "DeviceFleetSummary$DeviceFleetArn": "Amazon Resource Name (ARN) of the device fleet.
", + "GetDeviceFleetReportResponse$DeviceFleetArn": "The Amazon Resource Name (ARN) of the device.
" + } + }, + "DeviceFleetDescription": { + "base": null, + "refs": { + "CreateDeviceFleetRequest$Description": "A description of the fleet.
", + "DescribeDeviceFleetResponse$Description": "A description of the fleet.
", + "GetDeviceFleetReportResponse$Description": "Description of the fleet.
", + "UpdateDeviceFleetRequest$Description": "Description of the fleet.
" + } + }, + "DeviceFleetSummaries": { + "base": null, + "refs": { + "ListDeviceFleetsResponse$DeviceFleetSummaries": "Summary of the device fleet.
" + } + }, + "DeviceFleetSummary": { + "base": "Summary of the device fleet.
", + "refs": { + "DeviceFleetSummaries$member": null + } + }, + "DeviceName": { + "base": null, + "refs": { + "Device$DeviceName": "The name of the device.
", + "DeviceNames$member": null + } + }, + "DeviceNames": { + "base": null, + "refs": { + "DeregisterDevicesRequest$DeviceNames": "The unique IDs of the devices.
" + } + }, + "DeviceStats": { + "base": "Status of devices.
", + "refs": { + "GetDeviceFleetReportResponse$DeviceStats": "Status of devices.
" + } + }, + "DeviceSummaries": { + "base": null, + "refs": { + "ListDevicesResponse$DeviceSummaries": "Summary of devices.
" + } + }, + "DeviceSummary": { + "base": "Summary of the device.
", + "refs": { + "DeviceSummaries$member": null + } + }, + "Devices": { + "base": null, + "refs": { + "RegisterDevicesRequest$Devices": "A list of devices to register with SageMaker Edge Manager.
", + "UpdateDevicesRequest$Devices": "List of devices to register with Edge Manager agent.
" + } + }, "DirectInternetAccess": { "base": null, "refs": { @@ -2799,12 +3109,19 @@ "base": null, "refs": { "CheckpointConfig$LocalPath": "(Optional) The local directory where checkpoints are written. The default directory is /opt/ml/checkpoints/.
Path to local storage location for tensors. Defaults to /opt/ml/output/tensors/.
Path to local storage location for metrics and tensors. Defaults to /opt/ml/output/tensors/.
Path to local storage location for output of rules. Defaults to /opt/ml/processing/output/rule/.
The full path to the directory to associate with the channel.
", + "ProfilerRuleConfiguration$LocalPath": "Path to local storage location for output of rules. Defaults to /opt/ml/processing/output/rule/.
Path to local storage location for tensorBoard output. Defaults to /opt/ml/output/tensorboard.
To disable Debugger monitoring and profiling, set to True.
The numeric value of a numeric hyperparameter. If you specify a value for this parameter, you can't specify the StringValue parameter.
The model on the edge device.
", + "refs": { + "EdgeModels$member": null + } + }, + "EdgeModelStat": { + "base": "Status of edge devices with this model.
", + "refs": { + "EdgeModelStats$member": null + } + }, + "EdgeModelStats": { + "base": null, + "refs": { + "GetDeviceFleetReportResponse$ModelStats": "Status of model on device.
" + } + }, + "EdgeModelSummaries": { + "base": null, + "refs": { + "DeviceSummary$Models": "Models on the device.
" + } + }, + "EdgeModelSummary": { + "base": "Summary of model on edge device.
", + "refs": { + "EdgeModelSummaries$member": null + } + }, + "EdgeModels": { + "base": null, + "refs": { + "DescribeDeviceResponse$Models": "Models on the device.
" + } + }, + "EdgeOutputConfig": { + "base": "The output configuration.
", + "refs": { + "CreateDeviceFleetRequest$OutputConfig": "The output configuration for storing sample data collected by the fleet.
", + "CreateEdgePackagingJobRequest$OutputConfig": "Provides information about the output location for the packaged model.
", + "DescribeDeviceFleetResponse$OutputConfig": "The output configuration for storing sampled data.
", + "DescribeEdgePackagingJobResponse$OutputConfig": "The output configuration for the edge packaging job.
", + "GetDeviceFleetReportResponse$OutputConfig": "The output configuration for storing sample data collected by the fleet.
", + "UpdateDeviceFleetRequest$OutputConfig": "Output configuration for storing sample data collected by the fleet.
" + } + }, + "EdgePackagingJobArn": { + "base": null, + "refs": { + "DescribeEdgePackagingJobResponse$EdgePackagingJobArn": "The Amazon Resource Name (ARN) of the edge packaging job.
", + "EdgePackagingJobSummary$EdgePackagingJobArn": "The Amazon Resource Name (ARN) of the edge packaging job.
" + } + }, + "EdgePackagingJobStatus": { + "base": null, + "refs": { + "DescribeEdgePackagingJobResponse$EdgePackagingJobStatus": "The current status of the packaging job.
", + "EdgePackagingJobSummary$EdgePackagingJobStatus": "The status of the edge packaging job.
", + "ListEdgePackagingJobsRequest$StatusEquals": "The job status to filter for.
" + } + }, + "EdgePackagingJobSummaries": { + "base": null, + "refs": { + "ListEdgePackagingJobsResponse$EdgePackagingJobSummaries": "Summaries of edge packaging jobs.
" + } + }, + "EdgePackagingJobSummary": { + "base": "Summary of edge packaging job.
", + "refs": { + "EdgePackagingJobSummaries$member": null + } + }, + "EdgeVersion": { + "base": null, + "refs": { + "AgentVersion$Version": "Version of the agent.
", + "CreateEdgePackagingJobRequest$ModelVersion": "The version of the model.
", + "DescribeEdgePackagingJobResponse$ModelVersion": "The version of the model.
", + "EdgeModel$ModelVersion": "The model version.
", + "EdgeModelStat$ModelVersion": "The model version.
", + "EdgeModelSummary$ModelVersion": "The version model.
", + "EdgePackagingJobSummary$ModelVersion": "The version of the model.
" + } + }, "EfsUid": { "base": null, "refs": { @@ -3010,6 +3413,10 @@ "EndpointInput": { "base": "Input object for the endpoint
", "refs": { + "DataQualityJobInput$EndpointInput": null, + "ModelBiasJobInput$EndpointInput": null, + "ModelExplainabilityJobInput$EndpointInput": null, + "ModelQualityJobInput$EndpointInput": null, "MonitoringInput$EndpointInput": "The endpoint for a monitoring job.
" } }, @@ -3024,9 +3431,14 @@ "Endpoint$EndpointName": "The name of the endpoint.
", "EndpointInput$EndpointName": "An endpoint in customer's account which has enabled DataCaptureConfig enabled.
The name of the endpoint.
", + "ListDataQualityJobDefinitionsRequest$EndpointName": "A filter that lists the data quality job definitions associated with the specified endpoint.
", + "ListModelBiasJobDefinitionsRequest$EndpointName": "Name of the endpoint to monitor for model bias.
", + "ListModelExplainabilityJobDefinitionsRequest$EndpointName": "Name of the endpoint to monitor for model explainability.
", + "ListModelQualityJobDefinitionsRequest$EndpointName": "A filter that returns only model quality monitoring job definitions that are associated with the specified endpoint.
", "ListMonitoringExecutionsRequest$EndpointName": "Name of a specific endpoint to fetch jobs for.
", "ListMonitoringSchedulesRequest$EndpointName": "Name of a specific endpoint to fetch schedules for.
", - "MonitoringExecutionSummary$EndpointName": "The name of teh endpoint used to run the monitoring job.
", + "MonitoringExecutionSummary$EndpointName": "The name of the endpoint used to run the monitoring job.
", + "MonitoringJobDefinitionSummary$EndpointName": "The name of the endpoint that the job monitors.
", "MonitoringSchedule$EndpointName": "The endpoint that hosts the model being monitored.
", "MonitoringScheduleSummary$EndpointName": "The name of the endpoint using the monitoring schedule.
", "UpdateEndpointInput$EndpointName": "The name of the endpoint whose configuration you want to update.
", @@ -3098,21 +3510,50 @@ "CreateAlgorithmInput$AlgorithmName": "The name of the algorithm.
", "CreateCodeRepositoryInput$CodeRepositoryName": "The name of the Git repository. The name must have 1 to 63 characters. Valid characters are a-z, A-Z, 0-9, and - (hyphen).
", "CreateCompilationJobRequest$CompilationJobName": "A name for the model compilation job. The name must be unique within the AWS Region and within your AWS account.
", + "CreateDeviceFleetRequest$DeviceFleetName": "The name of the fleet that the device belongs to.
", + "CreateEdgePackagingJobRequest$EdgePackagingJobName": "The name of the edge packaging job.
", + "CreateEdgePackagingJobRequest$CompilationJobName": "The name of the SageMaker Neo compilation job that will be used to locate model artifacts for packaging.
", + "CreateEdgePackagingJobRequest$ModelName": "The name of the model.
", "CreateModelPackageGroupInput$ModelPackageGroupName": "The name of the model group.
", "CreateModelPackageInput$ModelPackageName": "The name of the model package. The name must have 1 to 63 characters. Valid characters are a-z, A-Z, 0-9, and - (hyphen).
This parameter is required for unversioned models. It is not applicable to versioned models.
", "CreateModelPackageInput$ModelPackageGroupName": "The name of the model group that this model version belongs to.
This parameter is required for versioned models, and does not apply to unversioned models.
", "DeleteAlgorithmInput$AlgorithmName": "The name of the algorithm to delete.
", "DeleteCodeRepositoryInput$CodeRepositoryName": "The name of the Git repository to delete.
", + "DeleteDeviceFleetRequest$DeviceFleetName": "The name of the fleet to delete.
", "DeleteModelPackageGroupPolicyInput$ModelPackageGroupName": "The name of the model group for which to delete the policy.
", + "DeregisterDevicesRequest$DeviceFleetName": "The name of the fleet the devices belong to.
", "DescribeAlgorithmOutput$AlgorithmName": "The name of the algorithm being described.
", "DescribeCodeRepositoryInput$CodeRepositoryName": "The name of the Git repository to describe.
", "DescribeCodeRepositoryOutput$CodeRepositoryName": "The name of the Git repository.
", "DescribeCompilationJobRequest$CompilationJobName": "The name of the model compilation job that you want information about.
", "DescribeCompilationJobResponse$CompilationJobName": "The name of the model compilation job.
", + "DescribeDeviceFleetRequest$DeviceFleetName": "The name of the fleet.
", + "DescribeDeviceFleetResponse$DeviceFleetName": "The name of the fleet.
", + "DescribeDeviceRequest$DeviceName": "The unique ID of the device.
", + "DescribeDeviceRequest$DeviceFleetName": "The name of the fleet the devices belong to.
", + "DescribeDeviceResponse$DeviceName": "The unique identifier of the device.
", + "DescribeDeviceResponse$DeviceFleetName": "The name of the fleet the device belongs to.
", + "DescribeEdgePackagingJobRequest$EdgePackagingJobName": "The name of the edge packaging job.
", + "DescribeEdgePackagingJobResponse$EdgePackagingJobName": "The name of the edge packaging job.
", + "DescribeEdgePackagingJobResponse$CompilationJobName": "The name of the SageMaker Neo compilation job that is used to locate model artifacts that are being packaged.
", + "DescribeEdgePackagingJobResponse$ModelName": "The name of the model.
", "DescribeModelPackageGroupOutput$ModelPackageGroupName": "The name of the model group.
", "DescribeModelPackageOutput$ModelPackageName": "The name of the model package being described.
", "DescribeModelPackageOutput$ModelPackageGroupName": "If the model is a versioned model, the name of the model group that the versioned model belongs to.
", + "DeviceFleetSummary$DeviceFleetName": "Name of the device fleet.
", + "DeviceSummary$DeviceName": "The unique identifier of the device.
", + "DeviceSummary$DeviceFleetName": "The name of the fleet the device belongs to.
", + "EdgeModel$ModelName": "The name of the model.
", + "EdgeModelStat$ModelName": "The name of the model.
", + "EdgeModelSummary$ModelName": "The name of the model.
", + "EdgePackagingJobSummary$EdgePackagingJobName": "The name of the edge packaging job.
", + "EdgePackagingJobSummary$CompilationJobName": "The name of the SageMaker Neo compilation job.
", + "EdgePackagingJobSummary$ModelName": "The name of the model.
", + "GetDeviceFleetReportRequest$DeviceFleetName": "The name of the fleet.
", + "GetDeviceFleetReportResponse$DeviceFleetName": "The name of the fleet.
", "GetModelPackageGroupPolicyInput$ModelPackageGroupName": "The name of the model group for which to get the resource policy.
", + "ListDevicesRequest$ModelName": "A filter that searches devices that contains this name in any of their models.
", + "ListDevicesRequest$DeviceFleetName": "Filter for fleets containing this name in their device fleet name.
", "ModelPackage$ModelPackageName": "The name of the model.
", "ModelPackage$ModelPackageGroupName": "The model group to which the model belongs.
", "ModelPackageGroup$ModelPackageGroupName": "The name of the model group.
", @@ -3122,8 +3563,12 @@ "ModelPackageSummary$ModelPackageGroupName": "If the model package is a versioned model, the model group that the versioned model belongs to.
", "ModelPackageValidationProfile$ProfileName": "The name of the profile for the model package.
", "PutModelPackageGroupPolicyInput$ModelPackageGroupName": "The name of the model group to add a resource policy to.
", + "RegisterDevicesRequest$DeviceFleetName": "The name of the fleet.
", "StopCompilationJobRequest$CompilationJobName": "The name of the model compilation job to stop.
", - "UpdateCodeRepositoryInput$CodeRepositoryName": "The name of the Git repository to update.
" + "StopEdgePackagingJobRequest$EdgePackagingJobName": "The name of the edge packaging job.
", + "UpdateCodeRepositoryInput$CodeRepositoryName": "The name of the Git repository to update.
", + "UpdateDeviceFleetRequest$DeviceFleetName": "The name of the fleet.
", + "UpdateDevicesRequest$DeviceFleetName": "The name of the fleet the devices belong to.
" } }, "EnvironmentKey": { @@ -3631,6 +4076,16 @@ "DescribeAutoMLJobResponse$GenerateCandidateDefinitionsOnly": "Returns the job's output from GenerateCandidateDefinitionsOnly.
" } }, + "GetDeviceFleetReportRequest": { + "base": null, + "refs": { + } + }, + "GetDeviceFleetReportResponse": { + "base": null, + "refs": { + } + }, "GetModelPackageGroupPolicyInput": { "base": null, "refs": { @@ -3696,7 +4151,7 @@ "HookParameters": { "base": null, "refs": { - "DebugHookConfig$HookParameters": "Configuration information for the debug hook parameters.
" + "DebugHookConfig$HookParameters": "Configuration information for the Debugger hook parameters.
" } }, "HumanLoopActivationConditions": { @@ -4088,6 +4543,10 @@ "base": null, "refs": { "AppSpecification$ImageUri": "The container image to be run by the processing job.
", + "DataQualityAppSpecification$ImageUri": "The container image that the data quality monitoring job runs.
", + "ModelBiasAppSpecification$ImageUri": "The container image to be run by the model bias job.
", + "ModelExplainabilityAppSpecification$ImageUri": "The container image to be run by the model explainability job.
", + "ModelQualityAppSpecification$ImageUri": "The address of the container image that the monitoring job runs.
", "MonitoringAppSpecification$ImageUri": "The container image to be run by the monitoring job.
" } }, @@ -4195,6 +4654,12 @@ "UpdateNotebookInstanceInput$InstanceType": "The Amazon ML compute instance type.
" } }, + "Integer": { + "base": null, + "refs": { + "DescribeDeviceResponse$MaxModels": "The maximum number of models.
" + } + }, "IntegerParameterRange": { "base": "For a hyperparameter of the integer type, specifies the range that a hyperparameter tuning job searches.
", "refs": { @@ -4225,6 +4690,12 @@ "ModelClientConfig$InvocationsTimeoutInSeconds": "The timeout value in seconds for an invocation request.
" } }, + "IotRoleAlias": { + "base": null, + "refs": { + "DescribeDeviceFleetResponse$IotRoleAlias": "The Amazon Resource Name (ARN) alias created in AWS Internet of Things (IoT).
" + } + }, "JobReferenceCode": { "base": null, "refs": { @@ -4316,14 +4787,17 @@ "AutoMLSecurityConfig$VolumeKmsKeyId": "The key used to encrypt stored data.
", "CreateDomainRequest$HomeEfsFileSystemKmsKeyId": "This member is deprecated and replaced with KmsKeyId.
SageMaker uses AWS KMS to encrypt the EFS volume attached to the domain with an AWS managed customer master key (CMK) by default. For more control, specify a customer managed CMK.
", + "CreateEdgePackagingJobRequest$ResourceKey": "The CMK to use when encrypting the EBS volume the edge packaging job runs on.
", "CreateEndpointConfigInput$KmsKeyId": "The Amazon Resource Name (ARN) of a AWS Key Management Service key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint.
The KmsKeyId can be any of the following formats:
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
Alias name: alias/ExampleAlias
Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias
The KMS key policy must grant permission to the IAM role that you specify in your CreateEndpoint, UpdateEndpoint requests. For more information, refer to the AWS Key Management Service section Using Key Policies in AWS KMS
Certain Nitro-based instances include local storage, dependent on the instance type. Local storage volumes are encrypted using a hardware module on the instance. You can't request a KmsKeyId when using an instance type with local storage. If any of the models that you specify in the ProductionVariants parameter use nitro-based instances with local storage, do not specify a value for the KmsKeyId parameter. If you specify a value for KmsKeyId when using any nitro-based instances with local storage, the call to CreateEndpointConfig fails.
For a list of instance types that support local instance storage, see Instance Store Volumes.
For more information about local instance storage encryption, see SSD Instance Store Volumes.
The Amazon Resource Name (ARN) of a AWS Key Management Service key that Amazon SageMaker uses to encrypt data on the storage volume attached to your notebook instance. The KMS key you provide must be enabled. For information, see Enabling and Disabling Keys in the AWS Key Management Service Developer Guide.
", "DataCaptureConfig$KmsKeyId": "", "DataCaptureConfigSummary$KmsKeyId": "", "DescribeDomainResponse$HomeEfsFileSystemKmsKeyId": "This member is deprecated and replaced with KmsKeyId.
The AWS KMS customer managed CMK used to encrypt the EFS volume attached to the domain.
", + "DescribeEdgePackagingJobResponse$ResourceKey": "The CMK to use when encrypting the EBS volume the job run on.
", "DescribeEndpointConfigOutput$KmsKeyId": "AWS KMS key ID Amazon SageMaker uses to encrypt data when storing it on the ML storage volume attached to the instance.
", "DescribeNotebookInstanceOutput$KmsKeyId": "The AWS KMS key ID Amazon SageMaker uses to encrypt data when storing it on the ML storage volume attached to the instance.
", + "EdgeOutputConfig$KmsKeyId": "The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt data on the storage volume after compilation job. If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account.
", "FlowDefinitionOutputConfig$KmsKeyId": "The Amazon Key Management Service (KMS) key ID for server-side encryption.
", "LabelingJobOutputConfig$KmsKeyId": "The AWS Key Management Service ID of the key used to encrypt the output data, if any.
If you use a KMS key ID or an alias of your master key, the Amazon SageMaker execution role must include permissions to call kms:Encrypt. If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account. Amazon SageMaker uses server-side encryption with KMS-managed keys for LabelingJobOutputConfig. If you use a bucket policy with an s3:PutObject permission that only allows objects with server-side encryption, set the condition key of s3:x-amz-server-side-encryption to \"aws:kms\". For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide.
The KMS key policy must grant permission to the IAM role that you specify in your CreateLabelingJob request. For more information, see Using Key Policies in AWS KMS in the AWS Key Management Service Developer Guide.
The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the training job. The VolumeKmsKeyId can be any of the following formats:
// KMS Key ID
\"1234abcd-12ab-34cd-56ef-1234567890ab\"
// Amazon Resource Name (ARN) of a KMS Key
\"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"
The column to sort by.
" + } + }, + "ListDevicesRequest": { + "base": null, + "refs": { + } + }, + "ListDevicesResponse": { + "base": null, + "refs": { + } + }, "ListDomainsRequest": { "base": null, "refs": { @@ -4674,6 +5184,22 @@ "refs": { } }, + "ListEdgePackagingJobsRequest": { + "base": null, + "refs": { + } + }, + "ListEdgePackagingJobsResponse": { + "base": null, + "refs": { + } + }, + "ListEdgePackagingJobsSortBy": { + "base": null, + "refs": { + "ListEdgePackagingJobsRequest$SortBy": "Use to specify what column to sort by.
" + } + }, "ListEndpointConfigsInput": { "base": null, "refs": { @@ -4798,6 +5324,34 @@ "UpdateContextRequest$PropertiesToRemove": "A list of properties to remove.
" } }, + "ListMaxResults": { + "base": null, + "refs": { + "ListDeviceFleetsRequest$MaxResults": "The maximum number of results to select.
", + "ListDevicesRequest$MaxResults": "Maximum number of results to select.
", + "ListEdgePackagingJobsRequest$MaxResults": "Maximum number of results to select.
" + } + }, + "ListModelBiasJobDefinitionsRequest": { + "base": null, + "refs": { + } + }, + "ListModelBiasJobDefinitionsResponse": { + "base": null, + "refs": { + } + }, + "ListModelExplainabilityJobDefinitionsRequest": { + "base": null, + "refs": { + } + }, + "ListModelExplainabilityJobDefinitionsResponse": { + "base": null, + "refs": { + } + }, "ListModelPackageGroupsInput": { "base": null, "refs": { @@ -4818,6 +5372,16 @@ "refs": { } }, + "ListModelQualityJobDefinitionsRequest": { + "base": null, + "refs": { + } + }, + "ListModelQualityJobDefinitionsResponse": { + "base": null, + "refs": { + } + }, "ListModelsInput": { "base": null, "refs": { @@ -5054,6 +5618,18 @@ "ListWorkteamsRequest$SortBy": "The field to sort results by. The default is CreationTime.
The number of Edge Manager agents.
", + "DeviceStats$ConnectedDeviceCount": "The number of devices connected with a heartbeat.
", + "DeviceStats$RegisteredDeviceCount": "The number of registered devices.
", + "EdgeModelStat$OfflineDeviceCount": "The number of devices that have this model version and do not have a heart beat.
", + "EdgeModelStat$ConnectedDeviceCount": "The number of devices that have this model version and have a heart beat.
", + "EdgeModelStat$ActiveDeviceCount": "The number of devices that have this model version, a heart beat, and are currently running.
", + "EdgeModelStat$SamplingDeviceCount": "The number of devices with this model version and are producing sample data.
" + } + }, "MaxAutoMLJobRuntimeInSeconds": { "base": null, "refs": { @@ -5126,6 +5702,7 @@ "ListCodeRepositoriesInput$MaxResults": "The maximum number of Git repositories to return in the response.
", "ListCompilationJobsRequest$MaxResults": "The maximum number of model compilation jobs to return in the response.
", "ListContextsRequest$MaxResults": "The maximum number of contexts to return in the response. The default value is 10.
", + "ListDataQualityJobDefinitionsRequest$MaxResults": "The maximum number of data quality monitoring job definitions to return in the response.
", "ListDomainsRequest$MaxResults": "Returns a list up to a specified limit.
", "ListEndpointConfigsInput$MaxResults": "The maximum number of training jobs to return in the response.
", "ListEndpointsInput$MaxResults": "The maximum number of endpoints to return in the response.
", @@ -5137,8 +5714,11 @@ "ListImagesRequest$MaxResults": "The maximum number of images to return in the response. The default value is 10.
", "ListLabelingJobsForWorkteamRequest$MaxResults": "The maximum number of labeling jobs to return in each page of the response.
", "ListLabelingJobsRequest$MaxResults": "The maximum number of labeling jobs to return in each page of the response.
", + "ListModelBiasJobDefinitionsRequest$MaxResults": "The maximum number of model bias jobs to return in the response. The default value is 10.
", + "ListModelExplainabilityJobDefinitionsRequest$MaxResults": "The maximum number of jobs to return in the response. The default value is 10.
", "ListModelPackageGroupsInput$MaxResults": "The maximum number of results to return in the response.
", "ListModelPackagesInput$MaxResults": "The maximum number of model packages to return in the response.
", + "ListModelQualityJobDefinitionsRequest$MaxResults": "The maximum number of results to return in a call to ListModelQualityJobDefinitions.
The maximum number of models to return in the response.
", "ListMonitoringExecutionsRequest$MaxResults": "The maximum number of jobs to return in the response. The default value is 10.
", "ListMonitoringSchedulesRequest$MaxResults": "The maximum number of jobs to return in the response. The default value is 10.
", @@ -5316,6 +5896,27 @@ "TrainingJob$ModelArtifacts": "Information about the Amazon S3 location that is configured for storing model artifacts.
" } }, + "ModelBiasAppSpecification": { + "base": "Docker container image configuration object for the model bias job.
", + "refs": { + "CreateModelBiasJobDefinitionRequest$ModelBiasAppSpecification": "Configures the model bias job to run a specified Docker container image.
", + "DescribeModelBiasJobDefinitionResponse$ModelBiasAppSpecification": "Configures the model bias job to run a specified Docker container image.
" + } + }, + "ModelBiasBaselineConfig": { + "base": "The configuration for a baseline model bias job.
", + "refs": { + "CreateModelBiasJobDefinitionRequest$ModelBiasBaselineConfig": "The baseline configuration for a model bias job.
", + "DescribeModelBiasJobDefinitionResponse$ModelBiasBaselineConfig": "The baseline configuration for a model bias job.
" + } + }, + "ModelBiasJobInput": { + "base": "Inputs for the model bias job.
", + "refs": { + "CreateModelBiasJobDefinitionRequest$ModelBiasJobInput": "Inputs for the model bias job.
", + "DescribeModelBiasJobDefinitionResponse$ModelBiasJobInput": "Inputs for the model bias job.
" + } + }, "ModelClientConfig": { "base": "Configures the timeout and maximum number of retries for processing a transform job invocation.
", "refs": { @@ -5336,6 +5937,27 @@ "DescribeCompilationJobResponse$ModelDigests": "Provides a BLAKE2 hash value that identifies the compiled model artifacts in Amazon S3.
" } }, + "ModelExplainabilityAppSpecification": { + "base": "Docker container image configuration object for the model explainability job.
", + "refs": { + "CreateModelExplainabilityJobDefinitionRequest$ModelExplainabilityAppSpecification": "Configures the model explainability job to run a specified Docker container image.
", + "DescribeModelExplainabilityJobDefinitionResponse$ModelExplainabilityAppSpecification": "Configures the model explainability job to run a specified Docker container image.
" + } + }, + "ModelExplainabilityBaselineConfig": { + "base": "The configuration for a baseline model explainability job.
", + "refs": { + "CreateModelExplainabilityJobDefinitionRequest$ModelExplainabilityBaselineConfig": "The baseline configuration for a model explainability job.
", + "DescribeModelExplainabilityJobDefinitionResponse$ModelExplainabilityBaselineConfig": "The baseline configuration for a model explainability job.
" + } + }, + "ModelExplainabilityJobInput": { + "base": "Inputs for the model explainability job.
", + "refs": { + "CreateModelExplainabilityJobDefinitionRequest$ModelExplainabilityJobInput": "Inputs for the model explainability job.
", + "DescribeModelExplainabilityJobDefinitionResponse$ModelExplainabilityJobInput": "Inputs for the model explainability job.
" + } + }, "ModelMetrics": { "base": "Contains metrics captured from a model.
", "refs": { @@ -5521,6 +6143,27 @@ "ModelMetrics$ModelQuality": "Metrics that measure the quality of a model.
" } }, + "ModelQualityAppSpecification": { + "base": "Container image configuration object for the monitoring job.
", + "refs": { + "CreateModelQualityJobDefinitionRequest$ModelQualityAppSpecification": "The container that runs the monitoring job.
", + "DescribeModelQualityJobDefinitionResponse$ModelQualityAppSpecification": "Configures the model quality job to run a specified Docker container image.
" + } + }, + "ModelQualityBaselineConfig": { + "base": "Configuration for monitoring constraints and monitoring statistics. These baseline resources are compared against the results of the current job from the series of jobs scheduled to collect data periodically.
", + "refs": { + "CreateModelQualityJobDefinitionRequest$ModelQualityBaselineConfig": "Specifies the constraints and baselines for the monitoring job.
", + "DescribeModelQualityJobDefinitionResponse$ModelQualityBaselineConfig": "The baseline configuration for a model quality job.
" + } + }, + "ModelQualityJobInput": { + "base": "The input for the model quality monitoring job. Currently endponts are supported for input for model quality monitoring jobs.
", + "refs": { + "CreateModelQualityJobDefinitionRequest$ModelQualityJobInput": "A list of the inputs that are monitored. Currently endpoints are supported.
", + "DescribeModelQualityJobDefinitionResponse$ModelQualityJobInput": "Inputs for the model quality job.
" + } + }, "ModelSortKey": { "base": null, "refs": { @@ -5566,18 +6209,28 @@ "MonitoringConstraintsResource": { "base": "The constraints resource for a monitoring job.
", "refs": { + "DataQualityBaselineConfig$ConstraintsResource": null, + "ModelBiasBaselineConfig$ConstraintsResource": null, + "ModelExplainabilityBaselineConfig$ConstraintsResource": null, + "ModelQualityBaselineConfig$ConstraintsResource": null, "MonitoringBaselineConfig$ConstraintsResource": "The baseline constraint file in Amazon S3 that the current monitoring job should validated against.
" } }, "MonitoringContainerArguments": { "base": null, "refs": { + "DataQualityAppSpecification$ContainerArguments": "The arguments to send to the container that the monitoring job runs.
", + "ModelQualityAppSpecification$ContainerArguments": "An array of arguments for the container used to run the monitoring job.
", "MonitoringAppSpecification$ContainerArguments": "An array of arguments for the container used to run the monitoring job.
" } }, "MonitoringEnvironmentMap": { "base": null, "refs": { + "DataQualityAppSpecification$Environment": "Sets the environment variables in the container that the monitoring job runs.
", + "ModelBiasAppSpecification$Environment": "Sets the environment variables in the Docker container.
", + "ModelExplainabilityAppSpecification$Environment": "Sets the environment variables in the Docker container.
", + "ModelQualityAppSpecification$Environment": "Sets the environment variables in the container that the monitoring job runs.
", "MonitoringJobDefinition$Environment": "Sets the environment variables in the Docker container.
" } }, @@ -5601,6 +6254,13 @@ "ListMonitoringExecutionsResponse$MonitoringExecutionSummaries": "A JSON array in which each element is a summary for a monitoring execution.
" } }, + "MonitoringGroundTruthS3Input": { + "base": "The ground truth labels for the dataset used for the monitoring job.
", + "refs": { + "ModelBiasJobInput$GroundTruthS3Input": "Location of ground truth labels to use in model bias job.
", + "ModelQualityJobInput$GroundTruthS3Input": "The ground truth label provided for the model.
" + } + }, "MonitoringInput": { "base": "The inputs for a monitoring job.
", "refs": { @@ -5619,12 +6279,90 @@ "MonitoringScheduleConfig$MonitoringJobDefinition": "Defines the monitoring job.
" } }, + "MonitoringJobDefinitionArn": { + "base": null, + "refs": { + "CreateDataQualityJobDefinitionResponse$JobDefinitionArn": "The Amazon Resource Name (ARN) of the job definition.
", + "CreateModelBiasJobDefinitionResponse$JobDefinitionArn": "The Amazon Resource Name (ARN) of the model bias job.
", + "CreateModelExplainabilityJobDefinitionResponse$JobDefinitionArn": "The Amazon Resource Name (ARN) of the model explainability job.
", + "CreateModelQualityJobDefinitionResponse$JobDefinitionArn": "The Amazon Resource Name (ARN) of the model quality monitoring job.
", + "DescribeDataQualityJobDefinitionResponse$JobDefinitionArn": "The Amazon Resource Name (ARN) of the data quality monitoring job definition.
", + "DescribeModelBiasJobDefinitionResponse$JobDefinitionArn": "The Amazon Resource Name (ARN) of the model bias job.
", + "DescribeModelExplainabilityJobDefinitionResponse$JobDefinitionArn": "The Amazon Resource Name (ARN) of the model explainability job.
", + "DescribeModelQualityJobDefinitionResponse$JobDefinitionArn": "The Amazon Resource Name (ARN) of the model quality job.
", + "MonitoringJobDefinitionSummary$MonitoringJobDefinitionArn": "The Amazon Resource Name (ARN) of the monitoring job.
" + } + }, + "MonitoringJobDefinitionName": { + "base": null, + "refs": { + "CreateDataQualityJobDefinitionRequest$JobDefinitionName": "The name for the monitoring job definition.
", + "CreateModelBiasJobDefinitionRequest$JobDefinitionName": "The name of the bias job definition. The name must be unique within an AWS Region in the AWS account.
", + "CreateModelExplainabilityJobDefinitionRequest$JobDefinitionName": "The name of the model explainability job definition. The name must be unique within an AWS Region in the AWS account.
", + "CreateModelQualityJobDefinitionRequest$JobDefinitionName": "The name of the monitoring job definition.
", + "DeleteDataQualityJobDefinitionRequest$JobDefinitionName": "The name of the data quality monitoring job definition to delete.
", + "DeleteModelBiasJobDefinitionRequest$JobDefinitionName": "The name of the model bias job definition to delete.
", + "DeleteModelExplainabilityJobDefinitionRequest$JobDefinitionName": "The name of the model explainability job definition to delete.
", + "DeleteModelQualityJobDefinitionRequest$JobDefinitionName": "The name of the model quality monitoring job definition to delete.
", + "DescribeDataQualityJobDefinitionRequest$JobDefinitionName": "The name of the data quality monitoring job definition to describe.
", + "DescribeDataQualityJobDefinitionResponse$JobDefinitionName": "The name of the data quality monitoring job definition.
", + "DescribeModelBiasJobDefinitionRequest$JobDefinitionName": "The name of the model bias job definition. The name must be unique within an AWS Region in the AWS account.
", + "DescribeModelBiasJobDefinitionResponse$JobDefinitionName": "The name of the bias job definition. The name must be unique within an AWS Region in the AWS account.
", + "DescribeModelExplainabilityJobDefinitionRequest$JobDefinitionName": "The name of the model explainability job definition. The name must be unique within an AWS Region in the AWS account.
", + "DescribeModelExplainabilityJobDefinitionResponse$JobDefinitionName": "The name of the explainability job definition. The name must be unique within an AWS Region in the AWS account.
", + "DescribeModelQualityJobDefinitionRequest$JobDefinitionName": "The name of the model quality job. The name must be unique within an AWS Region in the AWS account.
", + "DescribeModelQualityJobDefinitionResponse$JobDefinitionName": "The name of the quality job definition. The name must be unique within an AWS Region in the AWS account.
", + "ListMonitoringExecutionsRequest$MonitoringJobDefinitionName": "Gets a list of the monitoring job runs of the specified monitoring job definitions.
", + "ListMonitoringSchedulesRequest$MonitoringJobDefinitionName": "Gets a list of the monitoring schedules for the specified monitoring job definition.
", + "MonitoringExecutionSummary$MonitoringJobDefinitionName": "The name of the monitoring job.
", + "MonitoringJobDefinitionSummary$MonitoringJobDefinitionName": "The name of the monitoring job.
", + "MonitoringScheduleConfig$MonitoringJobDefinitionName": "The name of the monitoring job definition to schedule.
", + "MonitoringScheduleSummary$MonitoringJobDefinitionName": "The name of the monitoring job definition that the schedule is for.
" + } + }, + "MonitoringJobDefinitionSortKey": { + "base": null, + "refs": { + "ListDataQualityJobDefinitionsRequest$SortBy": "The field to sort results by. The default is CreationTime.
Whether to sort results by the Name or CreationTime field. The default is CreationTime.
Whether to sort results by the Name or CreationTime field. The default is CreationTime.
The field to sort results by. The default is CreationTime.
Summary information about a monitoring job.
", + "refs": { + "MonitoringJobDefinitionSummaryList$member": null + } + }, + "MonitoringJobDefinitionSummaryList": { + "base": null, + "refs": { + "ListDataQualityJobDefinitionsResponse$JobDefinitionSummaries": "A list of data quality monitoring job definitions.
", + "ListModelBiasJobDefinitionsResponse$JobDefinitionSummaries": "A JSON array in which each element is a summary for a model bias jobs.
", + "ListModelExplainabilityJobDefinitionsResponse$JobDefinitionSummaries": "A JSON array in which each element is a summary for a explainability bias jobs.
", + "ListModelQualityJobDefinitionsResponse$JobDefinitionSummaries": "A list of summaries of model quality monitoring job definitions.
" + } + }, "MonitoringMaxRuntimeInSeconds": { "base": null, "refs": { "MonitoringStoppingCondition$MaxRuntimeInSeconds": "The maximum runtime allowed in seconds.
" } }, + "MonitoringNetworkConfig": { + "base": "The networking configuration for the monitoring job.
", + "refs": { + "CreateDataQualityJobDefinitionRequest$NetworkConfig": "Specifies networking configuration for the monitoring job.
", + "CreateModelBiasJobDefinitionRequest$NetworkConfig": "Networking options for a model bias job.
", + "CreateModelExplainabilityJobDefinitionRequest$NetworkConfig": "Networking options for a model explainability job.
", + "CreateModelQualityJobDefinitionRequest$NetworkConfig": "Specifies the network configuration for the monitoring job.
", + "DescribeDataQualityJobDefinitionResponse$NetworkConfig": "The networking configuration for the data quality monitoring job.
", + "DescribeModelBiasJobDefinitionResponse$NetworkConfig": "Networking options for a model bias job.
", + "DescribeModelExplainabilityJobDefinitionResponse$NetworkConfig": "Networking options for a model explainability job.
", + "DescribeModelQualityJobDefinitionResponse$NetworkConfig": "Networking options for a model quality job.
" + } + }, "MonitoringOutput": { "base": "The output object for a monitoring job.
", "refs": { @@ -5634,6 +6372,14 @@ "MonitoringOutputConfig": { "base": "The output configuration for monitoring jobs.
", "refs": { + "CreateDataQualityJobDefinitionRequest$DataQualityJobOutputConfig": null, + "CreateModelBiasJobDefinitionRequest$ModelBiasJobOutputConfig": null, + "CreateModelExplainabilityJobDefinitionRequest$ModelExplainabilityJobOutputConfig": null, + "CreateModelQualityJobDefinitionRequest$ModelQualityJobOutputConfig": null, + "DescribeDataQualityJobDefinitionResponse$DataQualityJobOutputConfig": null, + "DescribeModelBiasJobDefinitionResponse$ModelBiasJobOutputConfig": null, + "DescribeModelExplainabilityJobDefinitionResponse$ModelExplainabilityJobOutputConfig": null, + "DescribeModelQualityJobDefinitionResponse$ModelQualityJobOutputConfig": null, "MonitoringJobDefinition$MonitoringOutputConfig": "The array of outputs from the monitoring job to be uploaded to Amazon Simple Storage Service (Amazon S3).
" } }, @@ -5643,9 +6389,23 @@ "MonitoringOutputConfig$MonitoringOutputs": "Monitoring outputs for monitoring jobs. This is where the output of the periodic monitoring jobs is uploaded.
" } }, + "MonitoringProblemType": { + "base": null, + "refs": { + "ModelQualityAppSpecification$ProblemType": "The machine learning problem type of the model that the monitoring job monitors.
" + } + }, "MonitoringResources": { "base": "Identifies the resources to deploy for a monitoring job.
", "refs": { + "CreateDataQualityJobDefinitionRequest$JobResources": null, + "CreateModelBiasJobDefinitionRequest$JobResources": null, + "CreateModelExplainabilityJobDefinitionRequest$JobResources": null, + "CreateModelQualityJobDefinitionRequest$JobResources": null, + "DescribeDataQualityJobDefinitionResponse$JobResources": null, + "DescribeModelBiasJobDefinitionResponse$JobResources": null, + "DescribeModelExplainabilityJobDefinitionResponse$JobResources": null, + "DescribeModelQualityJobDefinitionResponse$JobResources": null, "MonitoringJobDefinition$MonitoringResources": "Identifies the resources, ML compute instances, and ML storage volumes to deploy for a monitoring job. In distributed processing, you specify more than one instance.
" } }, @@ -5658,6 +6418,7 @@ "MonitoringS3Uri": { "base": null, "refs": { + "MonitoringGroundTruthS3Input$S3Uri": "The address of the Amazon S3 location of the ground truth labels.
", "MonitoringS3Output$S3Uri": "A URI that identifies the Amazon S3 storage location where Amazon SageMaker saves the results of a monitoring job.
" } }, @@ -5731,15 +6492,43 @@ "MonitoringStatisticsResource": { "base": "The statistics resource for a monitoring job.
", "refs": { + "DataQualityBaselineConfig$StatisticsResource": null, "MonitoringBaselineConfig$StatisticsResource": "The baseline statistics file in Amazon S3 that the current monitoring job should be validated against.
" } }, "MonitoringStoppingCondition": { "base": "A time limit for how long the monitoring job is allowed to run before stopping.
", "refs": { + "CreateDataQualityJobDefinitionRequest$StoppingCondition": null, + "CreateModelBiasJobDefinitionRequest$StoppingCondition": null, + "CreateModelExplainabilityJobDefinitionRequest$StoppingCondition": null, + "CreateModelQualityJobDefinitionRequest$StoppingCondition": null, + "DescribeDataQualityJobDefinitionResponse$StoppingCondition": null, + "DescribeModelBiasJobDefinitionResponse$StoppingCondition": null, + "DescribeModelExplainabilityJobDefinitionResponse$StoppingCondition": null, + "DescribeModelQualityJobDefinitionResponse$StoppingCondition": null, "MonitoringJobDefinition$StoppingCondition": "Specifies a time limit for how long the monitoring job is allowed to run.
" } }, + "MonitoringTimeOffsetString": { + "base": null, + "refs": { + "EndpointInput$StartTimeOffset": "If specified, monitoring jobs substract this time from the start time. For information about using offsets for scheduling monitoring jobs, see Schedule Model Quality Monitoring Jobs.
", + "EndpointInput$EndTimeOffset": "If specified, monitoring jobs substract this time from the end time. For information about using offsets for scheduling monitoring jobs, see Schedule Model Quality Monitoring Jobs.
" + } + }, + "MonitoringType": { + "base": null, + "refs": { + "DescribeMonitoringScheduleResponse$MonitoringType": "The type of the monitoring job that this schedule runs. This is one of the following values.
DATA_QUALITY - The schedule is for a data quality monitoring job.
MODEL_QUALITY - The schedule is for a model quality monitoring job.
MODEL_BIAS - The schedule is for a bias monitoring job.
MODEL_EXPLAINABILITY - The schedule is for an explainability monitoring job.
A filter that returns only the monitoring job runs of the specified monitoring type.
", + "ListMonitoringSchedulesRequest$MonitoringTypeEquals": "A filter that returns only the monitoring schedules for the specified monitoring type.
", + "MonitoringExecutionSummary$MonitoringType": "The type of the monitoring job.
", + "MonitoringSchedule$MonitoringType": "The type of the monitoring job definition to schedule.
", + "MonitoringScheduleConfig$MonitoringType": "The type of the monitoring job definition to schedule.
", + "MonitoringScheduleSummary$MonitoringType": "The type of the monitoring job definition that the schedule is for.
" + } + }, "MountPath": { "base": null, "refs": { @@ -5751,10 +6540,17 @@ "refs": { "ListAlgorithmsInput$NameContains": "A string in the algorithm name. This filter returns only algorithms whose name contains the specified string.
", "ListCompilationJobsRequest$NameContains": "A filter that returns the model compilation jobs whose name contains a specified string.
", + "ListDataQualityJobDefinitionsRequest$NameContains": "A string in the data quality monitoring job definition name. This filter returns only data quality monitoring job definitions whose name contains the specified string.
", + "ListDeviceFleetsRequest$NameContains": "Filter for fleets containing this name in their fleet device name.
", + "ListEdgePackagingJobsRequest$NameContains": "Filter for jobs containing this name in their packaging job name.
", + "ListEdgePackagingJobsRequest$ModelNameContains": "Filter for jobs where the model name contains this string.
", "ListHyperParameterTuningJobsRequest$NameContains": "A string in the tuning job name. This filter returns only tuning jobs whose name contains the specified string.
", "ListLabelingJobsRequest$NameContains": "A string in the labeling job name. This filter returns only labeling jobs whose name contains the specified string.
", + "ListModelBiasJobDefinitionsRequest$NameContains": "Filter for model bias jobs whose name contains a specified string.
", + "ListModelExplainabilityJobDefinitionsRequest$NameContains": "Filter for model explainability jobs whose name contains a specified string.
", "ListModelPackageGroupsInput$NameContains": "A string in the model group name. This filter returns only model groups whose name contains the specified string.
", "ListModelPackagesInput$NameContains": "A string in the model package name. This filter returns only model packages whose name contains the specified string.
", + "ListModelQualityJobDefinitionsRequest$NameContains": "A string in the transform job name. This filter returns only model quality monitoring job definitions whose name contains the specified string.
", "ListMonitoringSchedulesRequest$NameContains": "Filter for monitoring schedules whose name contains a specified string.
", "ListTrainingJobsRequest$NameContains": "A string in the training job name. This filter returns only training jobs whose name contains the specified string.
", "ListTransformJobsRequest$NameContains": "A string in the transform job name. This filter returns only transform jobs whose name contains the specified string.
" @@ -5790,6 +6586,8 @@ "NextToken": { "base": null, "refs": { + "DescribeDeviceRequest$NextToken": "Next token of device description.
", + "DescribeDeviceResponse$NextToken": "The response from the last list when returning a list large enough to need tokening.
", "DescribeFeatureGroupRequest$NextToken": "A token to resume pagination of the list of Features (FeatureDefinitions). 2,500 Features are returned by default.
A token to resume pagination of the list of Features (FeatureDefinitions).
If the previous call to ListActions didn't return the full set of actions, the call returns a token for getting the next set of actions.
If the response is truncated, Amazon SageMaker returns this NextToken. To retrieve the next set of model compilation jobs, use this token in the next request.
If the previous call to ListContexts didn't return the full set of contexts, the call returns a token for getting the next set of contexts.
A token for getting the next set of contexts, if there are any.
", + "ListDataQualityJobDefinitionsRequest$NextToken": "If the result of the previous ListDataQualityJobDefinitions request was truncated, the response includes a NextToken. To retrieve the next set of transform jobs, use the token in the next request.>
If the result of the previous ListDataQualityJobDefinitions request was truncated, the response includes a NextToken. To retrieve the next set of data quality monitoring job definitions, use the token in the next request.
The response from the last list when returning a list large enough to need tokening.
", + "ListDeviceFleetsResponse$NextToken": "The response from the last list when returning a list large enough to need tokening.
", + "ListDevicesRequest$NextToken": "The response from the last list when returning a list large enough to need tokening.
", + "ListDevicesResponse$NextToken": "The response from the last list when returning a list large enough to need tokening.
", "ListDomainsRequest$NextToken": "If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.
", "ListDomainsResponse$NextToken": "If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.
", + "ListEdgePackagingJobsRequest$NextToken": "The response from the last list when returning a list large enough to need tokening.
", + "ListEdgePackagingJobsResponse$NextToken": "Token to use when calling the next page of results.
", "ListExperimentsRequest$NextToken": "If the previous call to ListExperiments didn't return the full set of experiments, the call returns a token for getting the next set of experiments.
A token for getting the next set of experiments, if there are any.
", "ListFeatureGroupsRequest$NextToken": "A token to resume pagination of ListFeatureGroups results.
If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of labeling jobs, use it in the subsequent request.
", "ListLabelingJobsRequest$NextToken": "If the result of the previous ListLabelingJobs request was truncated, the response includes a NextToken. To retrieve the next set of labeling jobs, use the token in the next request.
If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of labeling jobs, use it in the subsequent request.
", + "ListModelBiasJobDefinitionsRequest$NextToken": "The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request.
", + "ListModelBiasJobDefinitionsResponse$NextToken": "If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of jobs, use it in the subsequent request.
", + "ListModelExplainabilityJobDefinitionsRequest$NextToken": "The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request.
", + "ListModelExplainabilityJobDefinitionsResponse$NextToken": "If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of jobs, use it in the subsequent request.
", "ListModelPackageGroupsInput$NextToken": "If the result of the previous ListModelPackageGroups request was truncated, the response includes a NextToken. To retrieve the next set of model groups, use the token in the next request.
If the response is truncated, SageMaker returns this token. To retrieve the next set of model groups, use it in the subsequent request.
", "ListModelPackagesInput$NextToken": "If the response to a previous ListModelPackages request was truncated, the response includes a NextToken. To retrieve the next set of model packages, use the token in the next request.
If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of model packages, use it in the subsequent request.
", + "ListModelQualityJobDefinitionsRequest$NextToken": "If the result of the previous ListModelQualityJobDefinitions request was truncated, the response includes a NextToken. To retrieve the next set of model quality monitoring job definitions, use the token in the next request.
If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of model quality monitoring job definitions, use it in the next request.
", "ListMonitoringExecutionsRequest$NextToken": "The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request.
", "ListMonitoringExecutionsResponse$NextToken": "If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of jobs, use it in the subsequent reques
", "ListMonitoringSchedulesRequest$NextToken": "The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request.
", - "ListMonitoringSchedulesResponse$NextToken": "If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of jobs, use it in the subsequent reques
", + "ListMonitoringSchedulesResponse$NextToken": "If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of jobs, use it in the subsequent request.
", "ListNotebookInstanceLifecycleConfigsInput$NextToken": "If the result of a ListNotebookInstanceLifecycleConfigs request was truncated, the response includes a NextToken. To get the next set of lifecycle configurations, use the token in the next request.
If the response is truncated, Amazon SageMaker returns this token. To get the next set of lifecycle configurations, use it in the next request.
", "ListNotebookInstancesInput$NextToken": " If the previous call to the ListNotebookInstances is truncated, the response includes a NextToken. You can use this token in your subsequent ListNotebookInstances request to fetch the next set of notebook instances.
You might specify a filter or a sort order in your request. When response is truncated, you must use the same values for the filer and sort order in the next request.
The size, in GB, of the ML storage volume attached to the processing instance.
" + "DebugRuleConfiguration$VolumeSizeInGB": "The size, in GB, of the ML storage volume attached to the processing instance.
", + "ProfilerRuleConfiguration$VolumeSizeInGB": "The size, in GB, of the ML storage volume attached to the processing instance.
" } }, "OrderKey": { @@ -6505,6 +7318,12 @@ "CreatePresignedDomainUrlResponse$AuthorizedUrl": "The presigned URL.
" } }, + "ProbabilityThresholdAttribute": { + "base": null, + "refs": { + "EndpointInput$ProbabilityThresholdAttribute": "The threshold for the class probability to be evaluated as a positive result.
" + } + }, "ProblemType": { "base": null, "refs": { @@ -6571,9 +7390,10 @@ "ProcessingInstanceType": { "base": null, "refs": { - "DebugRuleConfiguration$InstanceType": "The instance type to deploy for a training job.
", + "DebugRuleConfiguration$InstanceType": "The instance type to deploy a Debugger custom rule for debugging a training job.
", "MonitoringClusterConfig$InstanceType": "The ML compute instance type for the processing job.
", - "ProcessingClusterConfig$InstanceType": "The ML compute instance type for the processing job.
" + "ProcessingClusterConfig$InstanceType": "The ML compute instance type for the processing job.
", + "ProfilerRuleConfiguration$InstanceType": "The instance type to deploy a Debugger custom rule for profiling a training job.
" } }, "ProcessingJob": { @@ -6591,15 +7411,21 @@ "MonitoringExecutionSummary$ProcessingJobArn": "The Amazon Resource Name (ARN) of the monitoring job.
", "ProcessingJob$ProcessingJobArn": "The ARN of the processing job.
", "ProcessingJobStepMetadata$Arn": "The Amazon Resource Name (ARN) of the processing job.
", - "ProcessingJobSummary$ProcessingJobArn": "The Amazon Resource Name (ARN) of the processing job..
" + "ProcessingJobSummary$ProcessingJobArn": "The Amazon Resource Name (ARN) of the processing job..
", + "ProfilerRuleEvaluationStatus$RuleEvaluationJobArn": "The Amazon Resource Name (ARN) of the rule evaluation job.
" } }, "ProcessingJobName": { "base": null, "refs": { "CreateProcessingJobRequest$ProcessingJobName": "The name of the processing job. The name must be unique within an AWS Region in the AWS account.
", + "DataQualityBaselineConfig$BaseliningJobName": "The name of the job that performs baselining for the data quality monitoring job.
", "DescribeProcessingJobRequest$ProcessingJobName": "The name of the processing job. The name must be unique within an AWS Region in the AWS account.
", "DescribeProcessingJobResponse$ProcessingJobName": "The name of the processing job. The name must be unique within an AWS Region in the AWS account.
", + "ModelBiasBaselineConfig$BaseliningJobName": "The name of the baseline model bias job.
", + "ModelExplainabilityBaselineConfig$BaseliningJobName": "The name of the baseline model explainability job.
", + "ModelQualityBaselineConfig$BaseliningJobName": "The name of the job that performs baselining for the monitoring job.
", + "MonitoringBaselineConfig$BaseliningJobName": "The name of the job that performs baselining for the monitoring job.
", "ProcessingJob$ProcessingJobName": "The name of the processing job.
", "ProcessingJobSummary$ProcessingJobName": "The name of the processing job.
", "StopProcessingJobRequest$ProcessingJobName": "The name of the processing job to stop.
" @@ -6788,6 +7614,65 @@ "Endpoint$ProductionVariants": "A list of the production variants hosted on the endpoint. Each production variant is a model.
" } }, + "ProfilerConfig": { + "base": "Configuration information for Debugger system monitoring, framework profiling, and storage paths.
", + "refs": { + "CreateTrainingJobRequest$ProfilerConfig": null, + "DescribeTrainingJobResponse$ProfilerConfig": null + } + }, + "ProfilerConfigForUpdate": { + "base": "Configuration information for updating the Debugger profile parameters, system and framework metrics configurations, and storage paths.
", + "refs": { + "UpdateTrainingJobRequest$ProfilerConfig": "Configuration information for Debugger system monitoring, framework profiling, and storage paths.
" + } + }, + "ProfilerRuleConfiguration": { + "base": "Configuration information for profiling rules.
", + "refs": { + "ProfilerRuleConfigurations$member": null + } + }, + "ProfilerRuleConfigurations": { + "base": null, + "refs": { + "CreateTrainingJobRequest$ProfilerRuleConfigurations": "Configuration information for Debugger rules for profiling system and framework metrics.
", + "DescribeTrainingJobResponse$ProfilerRuleConfigurations": "Configuration information for Debugger rules for profiling system and framework metrics.
", + "UpdateTrainingJobRequest$ProfilerRuleConfigurations": "Configuration information for Debugger rules for profiling system and framework metrics.
" + } + }, + "ProfilerRuleEvaluationStatus": { + "base": "Information about the status of the rule evaluation.
", + "refs": { + "ProfilerRuleEvaluationStatuses$member": null + } + }, + "ProfilerRuleEvaluationStatuses": { + "base": null, + "refs": { + "DescribeTrainingJobResponse$ProfilerRuleEvaluationStatuses": "Evaluation status of Debugger rules for profiling on a training job.
" + } + }, + "ProfilingIntervalInMilliseconds": { + "base": null, + "refs": { + "ProfilerConfig$ProfilingIntervalInMilliseconds": "A time interval for capturing system metrics in milliseconds. Available values are 100, 200, 500, 1000 (1 second), 5000 (5 seconds), and 60000 (1 minute) milliseconds. The default value is 500 milliseconds.
", + "ProfilerConfigForUpdate$ProfilingIntervalInMilliseconds": "A time interval for capturing system metrics in milliseconds. Available values are 100, 200, 500, 1000 (1 second), 5000 (5 seconds), and 60000 (1 minute) milliseconds. The default value is 500 milliseconds.
" + } + }, + "ProfilingParameters": { + "base": null, + "refs": { + "ProfilerConfig$ProfilingParameters": "Configuration information for capturing framework metrics. Available key strings for different profiling options are DetailedProfilingConfig, PythonProfilingConfig, and DataLoaderProfilingConfig. The following codes are configuration structures for the ProfilingParameters parameter. To learn more about how to configure the ProfilingParameters parameter, see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.
Configuration information for capturing framework metrics. Available key strings for different profiling options are DetailedProfilingConfig, PythonProfilingConfig, and DataLoaderProfilingConfig. The following codes are configuration structures for the ProfilingParameters parameter. To learn more about how to configure the ProfilingParameters parameter, see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.
Profiling status of a training job.
" + } + }, "ProjectArn": { "base": null, "refs": { @@ -6971,6 +7856,11 @@ "RedshiftDatasetDefinition$DbUser": null } }, + "RegisterDevicesRequest": { + "base": null, + "refs": { + } + }, "RegisterModelStepMetadata": { "base": "Metadata for a register model job step.
", "refs": { @@ -7119,22 +8009,34 @@ "AlgorithmValidationSpecification$ValidationRole": "The IAM roles that Amazon SageMaker uses to run the training jobs.
", "CreateAutoMLJobRequest$RoleArn": "The ARN of the role that is used to access the data.
", "CreateCompilationJobRequest$RoleArn": "The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.
During model compilation, Amazon SageMaker needs your permission to:
Read input data from an S3 bucket
Write model artifacts to an S3 bucket
Write logs to Amazon CloudWatch Logs
Publish metrics to Amazon CloudWatch
You grant permissions for all of these tasks to an IAM role. To pass this role to Amazon SageMaker, the caller of this API must have the iam:PassRole permission. For more information, see Amazon SageMaker Roles.
The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
", + "CreateDeviceFleetRequest$RoleArn": "The Amazon Resource Name (ARN) that has access to AWS Internet of Things (IoT).
", + "CreateEdgePackagingJobRequest$RoleArn": "The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to download and upload the model, and to contact SageMaker Neo.
", "CreateFeatureGroupRequest$RoleArn": "The Amazon Resource Name (ARN) of the IAM execution role used to persist data into the OfflineStore if an OfflineStoreConfig is provided.
The Amazon Resource Name (ARN) of the role needed to call other services on your behalf. For example, arn:aws:iam::1234567890:role/service-role/AmazonSageMaker-ExecutionRole-20180111T151298.
The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.
", "CreateLabelingJobRequest$RoleArn": "The Amazon Resource Number (ARN) that Amazon SageMaker assumes to perform tasks on your behalf during data labeling. You must grant this role the necessary permissions so that Amazon SageMaker can successfully complete data labeling.
", + "CreateModelBiasJobDefinitionRequest$RoleArn": "The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
", + "CreateModelExplainabilityJobDefinitionRequest$RoleArn": "The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
", "CreateModelInput$ExecutionRoleArn": "The Amazon Resource Name (ARN) of the IAM role that Amazon SageMaker can assume to access model artifacts and docker image for deployment on ML compute instances or for batch transform jobs. Deploying on ML compute instances is part of model hosting. For more information, see Amazon SageMaker Roles.
To be able to pass this role to Amazon SageMaker, the caller of this API must have the iam:PassRole permission.
The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
", "CreateNotebookInstanceInput$RoleArn": "When you send any requests to AWS resources from the notebook instance, Amazon SageMaker assumes this role to perform tasks on your behalf. You must grant this role necessary permissions so Amazon SageMaker can perform these tasks. The policy must allow the Amazon SageMaker service principal (sagemaker.amazonaws.com) permissions to assume this role. For more information, see Amazon SageMaker Roles.
To be able to pass this role to Amazon SageMaker, the caller of this API must have the iam:PassRole permission.
The Amazon Resource Name (ARN) of the role used by the pipeline to access and create resources.
", "CreateProcessingJobRequest$RoleArn": "The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
", "CreateTrainingJobRequest$RoleArn": "The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
During model training, Amazon SageMaker needs your permission to read input data from an S3 bucket, download a Docker image that contains training code, write model artifacts to an S3 bucket, write logs to Amazon CloudWatch Logs, and publish metrics to Amazon CloudWatch. You grant permissions for all of these tasks to an IAM role. For more information, see Amazon SageMaker Roles.
To be able to pass this role to Amazon SageMaker, the caller of this API must have the iam:PassRole permission.
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that has read permission to the input data location and write permission to the output data location in Amazon S3.
", "DescribeCompilationJobResponse$RoleArn": "The Amazon Resource Name (ARN) of the model compilation job.
", + "DescribeDataQualityJobDefinitionResponse$RoleArn": "The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
", + "DescribeDeviceFleetResponse$RoleArn": "The Amazon Resource Name (ARN) that has access to AWS Internet of Things (IoT).
", + "DescribeEdgePackagingJobResponse$RoleArn": "The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to download and upload the model, and to contact Neo.
", "DescribeFeatureGroupResponse$RoleArn": "The Amazon Resource Name (ARN) of the IAM execution role used to persist data into the OfflineStore if an OfflineStoreConfig is provided.
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) execution role for the flow definition.
", "DescribeImageResponse$RoleArn": "The Amazon Resource Name (ARN) of the IAM role that enables Amazon SageMaker to perform tasks on your behalf.
", "DescribeLabelingJobResponse$RoleArn": "The Amazon Resource Name (ARN) that Amazon SageMaker assumes to perform tasks on your behalf during data labeling.
", + "DescribeModelBiasJobDefinitionResponse$RoleArn": "The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that has read permission to the input data location and write permission to the output data location in Amazon S3.
", + "DescribeModelExplainabilityJobDefinitionResponse$RoleArn": "The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that has read permission to the input data location and write permission to the output data location in Amazon S3.
", "DescribeModelOutput$ExecutionRoleArn": "The Amazon Resource Name (ARN) of the IAM role that you specified for the model.
", + "DescribeModelQualityJobDefinitionResponse$RoleArn": "The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
", "DescribeNotebookInstanceOutput$RoleArn": "The Amazon Resource Name (ARN) of the IAM role associated with the instance.
", "DescribePipelineResponse$RoleArn": "The Amazon Resource Name (ARN) that the pipeline uses to execute.
", "DescribeProcessingJobResponse$RoleArn": "The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
", @@ -7149,6 +8051,7 @@ "RedshiftDatasetDefinition$ClusterRoleArn": "The IAM role attached to your Redshift cluster that Amazon SageMaker uses to generate datasets.
", "RenderUiTemplateRequest$RoleArn": "The Amazon Resource Name (ARN) that has access to the S3 objects that are used by the template.
", "TrainingJob$RoleArn": "The AWS Identity and Access Management (IAM) role configured for the training job.
", + "UpdateDeviceFleetRequest$RoleArn": "The Amazon Resource Name (ARN) of the device.
", "UpdateImageRequest$RoleArn": "The new Amazon Resource Name (ARN) for the IAM role that enables Amazon SageMaker to perform tasks on your behalf.
", "UpdateNotebookInstanceInput$RoleArn": "The Amazon Resource Name (ARN) of the IAM role that Amazon SageMaker can assume to access the notebook instance. For more information, see Amazon SageMaker Roles.
To be able to pass this role to Amazon SageMaker, the caller of this API must have the iam:PassRole permission.
The Amazon Resource Name (ARN) that the pipeline uses to execute.
", @@ -7167,19 +8070,23 @@ "base": null, "refs": { "DebugRuleConfiguration$RuleConfigurationName": "The name of the rule configuration. It must be unique relative to other rule configuration names.
", - "DebugRuleEvaluationStatus$RuleConfigurationName": "The name of the rule configuration
" + "DebugRuleEvaluationStatus$RuleConfigurationName": "The name of the rule configuration.
", + "ProfilerRuleConfiguration$RuleConfigurationName": "The name of the rule configuration. It must be unique relative to other rule configuration names.
", + "ProfilerRuleEvaluationStatus$RuleConfigurationName": "The name of the rule configuration.
" } }, "RuleEvaluationStatus": { "base": null, "refs": { - "DebugRuleEvaluationStatus$RuleEvaluationStatus": "Status of the rule evaluation.
" + "DebugRuleEvaluationStatus$RuleEvaluationStatus": "Status of the rule evaluation.
", + "ProfilerRuleEvaluationStatus$RuleEvaluationStatus": "Status of the rule evaluation.
" } }, "RuleParameters": { "base": null, "refs": { - "DebugRuleConfiguration$RuleParameters": "Runtime configuration for rule container.
" + "DebugRuleConfiguration$RuleParameters": "Runtime configuration for rule container.
", + "ProfilerRuleConfiguration$RuleParameters": "Runtime configuration for rule container.
" } }, "S3DataDistribution": { @@ -7215,9 +8122,13 @@ "AutoMLS3DataSource$S3Uri": "The URL to the Amazon S3 data source.
", "CheckpointConfig$S3Uri": "Identifies the S3 path where you want Amazon SageMaker to store checkpoints. For example, s3://bucket-name/key-name-prefix.
The S3 URI of the file that defines the categories used to label the data objects.
For 3D point cloud task types, see Create a Labeling Category Configuration File for 3D Point Cloud Labeling Jobs.
For all other built-in task types and custom tasks, your label category configuration file must be a JSON file in the following format. Identify the labels you want to use by replacing label_1, label_2,...,label_n with your label categories.
{
\"document-version\": \"2018-11-28\"
\"labels\": [
{
\"label\": \"label_1\"
},
{
\"label\": \"label_2\"
},
...
{
\"label\": \"label_n\"
}
]
}
Path to Amazon S3 storage location for tensors.
", + "DataQualityAppSpecification$RecordPreprocessorSourceUri": "An Amazon S3 URI to a script that is called per row prior to running analysis. It can base64 decode the payload and convert it into a flatted json so that the built-in container can use the converted data. Applicable only for the built-in (first party) containers.
", + "DataQualityAppSpecification$PostAnalyticsProcessorSourceUri": "An Amazon S3 URI to a script that is called after analysis has been performed. Applicable only for the built-in (first party) containers.
", + "DebugHookConfig$S3OutputPath": "Path to Amazon S3 storage location for metrics and tensors.
", "DebugRuleConfiguration$S3OutputPath": "Path to Amazon S3 storage location for rules.
", + "DescribeEdgePackagingJobResponse$ModelArtifact": "The Amazon Simple Storage (S3) URI where model artifacts ares stored.
", "DescribeLabelingJobResponse$LabelCategoryConfigS3Uri": "The S3 location of the JSON file that defines the categories used to label data objects. Please note the following label-category limits:
Semantic segmentation labeling jobs using automated labeling: 20 labels
Box bounding labeling jobs (all): 10 labels
The file is a JSON structure in the following format:
{
\"document-version\": \"2018-11-28\"
\"labels\": [
{
\"label\": \"label 1\"
},
{
\"label\": \"label 2\"
},
...
{
\"label\": \"label n\"
}
]
}
The Amazon Simple Storage (S3) bucker URI.
", "FlowDefinitionOutputConfig$S3OutputPath": "The Amazon S3 path where the object containing human output will be made available.
", "InputConfig$S3Uri": "The S3 path where the model artifacts, which result from model training, are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).
", "LabelingJobOutput$OutputDatasetS3Uri": "The Amazon S3 bucket location of the manifest file for labeled data.
", @@ -7225,6 +8136,10 @@ "LabelingJobS3DataSource$ManifestS3Uri": "The Amazon S3 location of the manifest file that describes the input data objects.
", "MetricsSource$S3Uri": "", "ModelArtifacts$S3ModelArtifacts": "The path of the S3 object that contains the model artifacts. For example, s3://bucket-name/keynameprefix/model.tar.gz.
JSON formatted S3 file that defines bias parameters. For more information on this JSON configuration file, see Configure bias parameters.
", + "ModelExplainabilityAppSpecification$ConfigUri": "JSON formatted S3 file that defines explainability parameters. For more information on this JSON configuration file, see Configure model explainability parameters.
", + "ModelQualityAppSpecification$RecordPreprocessorSourceUri": "An Amazon S3 URI to a script that is called per row prior to running analysis. It can base64 decode the payload and convert it into a flatted json so that the built-in container can use the converted data. Applicable only for the built-in (first party) containers.
", + "ModelQualityAppSpecification$PostAnalyticsProcessorSourceUri": "An Amazon S3 URI to a script that is called after analysis has been performed. Applicable only for the built-in (first party) containers.
", "MonitoringAppSpecification$RecordPreprocessorSourceUri": "An Amazon S3 URI to a script that is called per row prior to running analysis. It can base64 decode the payload and convert it into a flatted json so that the built-in container can use the converted data. Applicable only for the built-in (first party) containers.
", "MonitoringAppSpecification$PostAnalyticsProcessorSourceUri": "An Amazon S3 URI to a script that is called after analysis has been performed. Applicable only for the built-in (first party) containers.
", "MonitoringConstraintsResource$S3Uri": "The Amazon S3 URI for the constraints resource.
", @@ -7233,6 +8148,9 @@ "OutputDataConfig$S3OutputPath": "Identifies the S3 path where you want Amazon SageMaker to store the model artifacts. For example, s3://bucket-name/key-name-prefix.
The URI for the Amazon S3 storage where you want Amazon SageMaker to download the artifacts needed to run a processing job.
", "ProcessingS3Output$S3Uri": "A URI that identifies the Amazon S3 bucket where you want Amazon SageMaker to save the results of a processing job.
", + "ProfilerConfig$S3OutputPath": "Path to Amazon S3 storage location for system and framework metrics.
", + "ProfilerConfigForUpdate$S3OutputPath": "Path to Amazon S3 storage location for system and framework metrics.
", + "ProfilerRuleConfiguration$S3OutputPath": "Path to Amazon S3 storage location for rules.
", "RedshiftDatasetDefinition$OutputS3Uri": "The location in Amazon S3 where the Redshift query results are stored.
", "S3DataSource$S3Uri": "Depending on the value specified for the S3DataType, identifies either a key name prefix or a manifest. For example:
A key name prefix might look like this: s3://bucketname/exampleprefix
A manifest might look like this: s3://bucketname/example.manifest
A manifest is an S3 object which is a JSON file consisting of an array of elements. The first element is a prefix which is followed by one or more suffixes. SageMaker appends the suffix elements to the prefix to get a full set of S3Uri. Note that the prefix must be a valid non-empty S3Uri that precludes users from specifying a manifest whose individual S3Uri is sourced from different S3 buckets.
The following code example shows a valid manifest format:
[ {\"prefix\": \"s3://customer_bucket/some/prefix/\"},
\"relative/path/to/custdata-1\",
\"relative/path/custdata-2\",
...
\"relative/path/custdata-N\"
]
This JSON is equivalent to the following S3Uri list:
s3://customer_bucket/some/prefix/relative/path/to/custdata-1
s3://customer_bucket/some/prefix/relative/path/custdata-2
...
s3://customer_bucket/some/prefix/relative/path/custdata-N
The complete set of S3Uri in this manifest is the input data for the channel for this data source. The object that each S3Uri points to must be readable by the IAM role that Amazon SageMaker uses to perform tasks on your behalf.
The S3 URI, or location in Amazon S3, of OfflineStore.
S3 URIs have a format similar to the following: s3://example-bucket/prefix/.
The sort order. The default value is Descending.
The sort order for results. The default is Ascending.
The sort order. The default value is Descending.
The sort order for results. The default is Descending.
What direction to sort in.
", + "ListEdgePackagingJobsRequest$SortOrder": "What direction to sort by.
", "ListExperimentsRequest$SortOrder": "The sort order. The default value is Descending.
An optional value that specifies whether you want the results sorted in Ascending or Descending order.
An optional value that specifies whether you want the results sorted in Ascending or Descending order.
The sort order for results. The default is Ascending.
The sort order for results. The default is Ascending.
The sort order for results. The default is Ascending.
Whether to sort the results in Ascending or Descending order. The default is Descending.
Whether to sort the results in Ascending or Descending order. The default is Descending.
The sort order for results. The default is Ascending.
The sort order for the results. The default is Ascending.
The sort order for results. The default is Descending.
Whether to sort the results in Ascending or Descending order. The default is Descending.
Whether to sort the results in Ascending or Descending order. The default is Descending.
The field by which to sort results. The default is CreatedTime.
Details from the rule evaluation.
" + "DebugRuleEvaluationStatus$StatusDetails": "Details from the rule evaluation.
", + "ProfilerRuleEvaluationStatus$StatusDetails": "Details from the rule evaluation.
" } }, "StatusMessage": { @@ -7624,6 +8549,11 @@ "refs": { } }, + "StopEdgePackagingJobRequest": { + "base": null, + "refs": { + } + }, "StopHyperParameterTuningJobRequest": { "base": null, "refs": { @@ -7685,6 +8615,11 @@ "base": null, "refs": { "AlgorithmStatusItem$FailureReason": "if the overall status is Failed, the reason for the failure.
Returns a message describing the job status and error messages.
", + "DescribeEdgePackagingJobResponse$ModelSignature": "The signature document of files in the model artifact.
", + "EndpointInput$FeaturesAttribute": "The attributes of the input data that are the input features.
", + "EndpointInput$InferenceAttribute": "The attribute of the input data that represents the ground truth label.
", + "EndpointInput$ProbabilityAttribute": "In a classification problem, the attribute that represents the class probability.
", "ListProcessingJobsRequest$NameContains": "A string in the processing job name. This filter returns only processing jobs whose name contains the specified string.
", "ModelPackageStatusItem$FailureReason": "if the overall status is Failed, the reason for the failure.
The name of the inputs for the processing job.
", @@ -7855,7 +8790,10 @@ "CreateCodeRepositoryInput$Tags": "An array of key-value pairs. You can use tags to categorize your AWS resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging AWS Resources.
", "CreateCompilationJobRequest$Tags": "An array of key-value pairs. You can use tags to categorize your AWS resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging AWS Resources.
", "CreateContextRequest$Tags": "A list of tags to apply to the context.
", + "CreateDataQualityJobDefinitionRequest$Tags": "(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.
", + "CreateDeviceFleetRequest$Tags": "Creates tags for the specified fleet.
", "CreateDomainRequest$Tags": "Tags to associated with the Domain. Each tag consists of a key and an optional value. Tag keys must be unique per resource. Tags are searchable using the Search API.
", + "CreateEdgePackagingJobRequest$Tags": "Creates tags for the packaging job.
", "CreateEndpointConfigInput$Tags": "An array of key-value pairs. You can use tags to categorize your AWS resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging AWS Resources.
", "CreateEndpointInput$Tags": "An array of key-value pairs. You can use tags to categorize your AWS resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging AWS Resources.
", "CreateExperimentRequest$Tags": "A list of tags to associate with the experiment. You can use Search API to search on the tags.
", @@ -7865,9 +8803,12 @@ "CreateHyperParameterTuningJobRequest$Tags": "An array of key-value pairs. You can use tags to categorize your AWS resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging AWS Resources.
Tags that you specify for the tuning job are also added to all training jobs that the tuning job launches.
", "CreateImageRequest$Tags": "A list of tags to apply to the image.
", "CreateLabelingJobRequest$Tags": "An array of key/value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.
", + "CreateModelBiasJobDefinitionRequest$Tags": "(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.
", + "CreateModelExplainabilityJobDefinitionRequest$Tags": "(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.
", "CreateModelInput$Tags": "An array of key-value pairs. You can use tags to categorize your AWS resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging AWS Resources.
", "CreateModelPackageGroupInput$Tags": "A list of key value pairs associated with the model group. For more information, see Tagging AWS resources in the AWS General Reference Guide.
", "CreateModelPackageInput$Tags": "A list of key value pairs associated with the model. For more information, see Tagging AWS resources in the AWS General Reference Guide.
", + "CreateModelQualityJobDefinitionRequest$Tags": "(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.
", "CreateMonitoringScheduleRequest$Tags": "(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.
", "CreateNotebookInstanceInput$Tags": "An array of key-value pairs. You can use tags to categorize your AWS resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging AWS Resources.
", "CreatePipelineRequest$Tags": "A list of tags to apply to the created pipeline.
", @@ -7890,6 +8831,7 @@ "MonitoringSchedule$Tags": "A list of the tags associated with the monitoring schedlue. For more information, see Tagging AWS resources in the AWS General Reference Guide.
", "Pipeline$Tags": "A list of tags that apply to the pipeline.
", "ProcessingJob$Tags": "An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.
", + "RegisterDevicesRequest$Tags": "The tags associated with devices.
", "TrainingJob$Tags": "An array of key-value pairs. You can use tags to categorize your AWS resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging AWS Resources.
", "TransformJob$Tags": "A list of tags associated with the transform job.
", "Trial$Tags": "The list of tags that are associated with the trial. You can use Search API to search on the tags.
", @@ -8024,7 +8966,7 @@ } }, "TensorBoardOutputConfig": { - "base": "Configuration of storage locations for TensorBoard output.
", + "base": "Configuration of storage locations for the Debugger TensorBoard output data.
", "refs": { "CreateTrainingJobRequest$TensorBoardOutputConfig": null, "DescribeTrainingJobResponse$TensorBoardOutputConfig": null, @@ -8043,6 +8985,14 @@ "BlueGreenUpdatePolicy$TerminationWaitInSeconds": "" } }, + "ThingName": { + "base": null, + "refs": { + "DescribeDeviceResponse$IotThingName": "The AWS Internet of Things (IoT) object thing name associated with the device.
", + "Device$IotThingName": "AWS Internet of Things (IoT) object name.
", + "DeviceSummary$IotThingName": "The AWS Internet of Things (IoT) object thing name associated with the device..
" + } + }, "Timestamp": { "base": null, "refs": { @@ -8082,6 +9032,13 @@ "DescribeCompilationJobResponse$CompilationEndTime": "The time when the model compilation job on a compilation job instance ended. For a successful or stopped job, this is when the job's model artifacts have finished uploading. For a failed job, this is when Amazon SageMaker detected that the job failed.
", "DescribeContextResponse$CreationTime": "When the context was created.
", "DescribeContextResponse$LastModifiedTime": "When the context was last modified.
", + "DescribeDataQualityJobDefinitionResponse$CreationTime": "The time that the data quality monitoring job definition was created.
", + "DescribeDeviceFleetResponse$CreationTime": "Timestamp of when the device fleet was created.
", + "DescribeDeviceFleetResponse$LastModifiedTime": "Timestamp of when the device fleet was last updated.
", + "DescribeDeviceResponse$RegistrationTime": "The timestamp of the last registration or de-reregistration.
", + "DescribeDeviceResponse$LatestHeartbeat": "The last heartbeat received from the device.
", + "DescribeEdgePackagingJobResponse$CreationTime": "The timestamp of when the packaging job was created.
", + "DescribeEdgePackagingJobResponse$LastModifiedTime": "The timestamp of when the job was last updated.
", "DescribeEndpointConfigOutput$CreationTime": "A timestamp that shows when the endpoint configuration was created.
", "DescribeEndpointOutput$CreationTime": "A timestamp that shows when the endpoint was created.
", "DescribeEndpointOutput$LastModifiedTime": "A timestamp that shows when the endpoint was last modified.
", @@ -8098,8 +9055,11 @@ "DescribeImageVersionResponse$LastModifiedTime": "When the version was last modified.
", "DescribeLabelingJobResponse$CreationTime": "The date and time that the labeling job was created.
", "DescribeLabelingJobResponse$LastModifiedTime": "The date and time that the labeling job was last updated.
", + "DescribeModelBiasJobDefinitionResponse$CreationTime": "The time at which the model bias job was created.
", + "DescribeModelExplainabilityJobDefinitionResponse$CreationTime": "The time at which the model explainability job was created.
", "DescribeModelOutput$CreationTime": "A timestamp that shows when the model was created.
", "DescribeModelPackageOutput$LastModifiedTime": "The last time the model package was modified.
", + "DescribeModelQualityJobDefinitionResponse$CreationTime": "The time at which the model quality job was created.
", "DescribeMonitoringScheduleResponse$CreationTime": "The time at which the monitoring job was created.
", "DescribeMonitoringScheduleResponse$LastModifiedTime": "The time at which the monitoring job was last modified.
", "DescribePipelineDefinitionForExecutionResponse$CreationTime": "The time when the pipeline was created.
", @@ -8126,6 +9086,14 @@ "DescribeTrialComponentResponse$LastModifiedTime": "When the component was last modified.
", "DescribeTrialResponse$CreationTime": "When the trial was created.
", "DescribeTrialResponse$LastModifiedTime": "When the trial was last modified.
", + "DeviceFleetSummary$CreationTime": "Timestamp of when the device fleet was created.
", + "DeviceFleetSummary$LastModifiedTime": "Timestamp of when the device fleet was last updated.
", + "DeviceSummary$RegistrationTime": "The timestamp of the last registration or de-reregistration.
", + "DeviceSummary$LatestHeartbeat": "The last heartbeat received from the device.
", + "EdgeModel$LatestSampleTime": "The timestamp of the last data sample taken.
", + "EdgeModel$LatestInference": "The timestamp of the last inference that was made.
", + "EdgePackagingJobSummary$CreationTime": "The timestamp of when the job was created.
", + "EdgePackagingJobSummary$LastModifiedTime": "The timestamp of when the edge packaging job was last updated.
", "Endpoint$CreationTime": "The time that the endpoint was created.
", "Endpoint$LastModifiedTime": "The last time the endpoint was modified.
", "EndpointConfigSummary$CreationTime": "A timestamp that shows when the endpoint configuration was created.
", @@ -8137,6 +9105,7 @@ "ExperimentSummary$LastModifiedTime": "When the experiment was last modified.
", "FeatureGroupSummary$CreationTime": "A timestamp indicating the time of creation time of the FeatureGroup.
The timestamp when SageMaker created the flow definition.
", + "GetDeviceFleetReportResponse$ReportGenerated": "Timestamp of when the report was generated.
", "HumanTaskUiSummary$CreationTime": "A timestamp when SageMaker created the human task user interface.
", "HyperParameterTrainingJobSummary$CreationTime": "The date and time that the training job was created.
", "HyperParameterTrainingJobSummary$TrainingStartTime": "The date and time that the training job started.
", @@ -8169,6 +9138,17 @@ "ListCodeRepositoriesInput$LastModifiedTimeBefore": "A filter that returns only Git repositories that were last modified before the specified time.
", "ListContextsRequest$CreatedAfter": "A filter that returns only contexts created on or after the specified time.
", "ListContextsRequest$CreatedBefore": "A filter that returns only contexts created on or before the specified time.
", + "ListDataQualityJobDefinitionsRequest$CreationTimeBefore": "A filter that returns only data quality monitoring job definitions created before the specified time.
", + "ListDataQualityJobDefinitionsRequest$CreationTimeAfter": "A filter that returns only data quality monitoring job definitions created after the specified time.
", + "ListDeviceFleetsRequest$CreationTimeAfter": "Filter fleets where packaging job was created after specified time.
", + "ListDeviceFleetsRequest$CreationTimeBefore": "Filter fleets where the edge packaging job was created before specified time.
", + "ListDeviceFleetsRequest$LastModifiedTimeAfter": "Select fleets where the job was updated after X
", + "ListDeviceFleetsRequest$LastModifiedTimeBefore": "Select fleets where the job was updated before X
", + "ListDevicesRequest$LatestHeartbeatAfter": "Select fleets where the job was updated after X
", + "ListEdgePackagingJobsRequest$CreationTimeAfter": "Select jobs where the job was created after specified time.
", + "ListEdgePackagingJobsRequest$CreationTimeBefore": "Select jobs where the job was created before specified time.
", + "ListEdgePackagingJobsRequest$LastModifiedTimeAfter": "Select jobs where the job was updated after specified time.
", + "ListEdgePackagingJobsRequest$LastModifiedTimeBefore": "Select jobs where the job was updated before specified time.
", "ListEndpointConfigsInput$CreationTimeBefore": "A filter that returns only endpoint configurations created before the specified time (timestamp).
", "ListEndpointConfigsInput$CreationTimeAfter": "A filter that returns only endpoint configurations with a creation time greater than or equal to the specified time (timestamp).
", "ListEndpointsInput$CreationTimeBefore": "A filter that returns only endpoints that were created before the specified time (timestamp).
", @@ -8199,6 +9179,12 @@ "ListLabelingJobsRequest$CreationTimeBefore": "A filter that returns only labeling jobs created before the specified time (timestamp).
", "ListLabelingJobsRequest$LastModifiedTimeAfter": "A filter that returns only labeling jobs modified after the specified time (timestamp).
", "ListLabelingJobsRequest$LastModifiedTimeBefore": "A filter that returns only labeling jobs modified before the specified time (timestamp).
", + "ListModelBiasJobDefinitionsRequest$CreationTimeBefore": "A filter that returns only model bias jobs created before a specified time.
", + "ListModelBiasJobDefinitionsRequest$CreationTimeAfter": "A filter that returns only model bias jobs created after a specified time.
", + "ListModelExplainabilityJobDefinitionsRequest$CreationTimeBefore": "A filter that returns only model explainability jobs created before a specified time.
", + "ListModelExplainabilityJobDefinitionsRequest$CreationTimeAfter": "A filter that returns only model explainability jobs created after a specified time.
", + "ListModelQualityJobDefinitionsRequest$CreationTimeBefore": "A filter that returns only model quality monitoring job definitions created before the specified time.
", + "ListModelQualityJobDefinitionsRequest$CreationTimeAfter": "A filter that returns only model quality monitoring job definitions created after the specified time.
", "ListModelsInput$CreationTimeBefore": "A filter that returns only models created before the specified time (timestamp).
", "ListModelsInput$CreationTimeAfter": "A filter that returns only models with a creation time greater than or equal to the specified time (timestamp).
", "ListMonitoringExecutionsRequest$ScheduledTimeBefore": "Filter for jobs scheduled before a specified time.
", @@ -8239,6 +9225,7 @@ "MonitoringExecutionSummary$ScheduledTime": "The time the monitoring job was scheduled.
", "MonitoringExecutionSummary$CreationTime": "The time at which the monitoring job was created.
", "MonitoringExecutionSummary$LastModifiedTime": "A timestamp that indicates the last time the monitoring job was modified.
", + "MonitoringJobDefinitionSummary$CreationTime": "The time that the monitoring job was created.
", "MonitoringSchedule$CreationTime": "The time that the monitoring schedule was created.
", "MonitoringSchedule$LastModifiedTime": "The last time the monitoring schedule was changed.
", "MonitoringScheduleSummary$CreationTime": "The creation time of the monitoring schedule.
", @@ -8261,6 +9248,7 @@ "ProcessingJobSummary$CreationTime": "The time at which the processing job was created.
", "ProcessingJobSummary$ProcessingEndTime": "The time at which the processing job completed.
", "ProcessingJobSummary$LastModifiedTime": "A timestamp that indicates the last time the processing job was modified.
", + "ProfilerRuleEvaluationStatus$LastModifiedTime": "Timestamp when the rule evaluation status was last modified.
", "ProjectSummary$CreationTime": "The time that the project was created.
", "SecondaryStatusTransition$StartTime": "A timestamp that shows when the training job transitioned to the current secondary status state.
", "SecondaryStatusTransition$EndTime": "A timestamp that shows when the training job transitioned out of this secondary status state into another secondary status state or when the training job has ended.
", @@ -8357,7 +9345,8 @@ "ProcessingJob$TrainingJobArn": "The ARN of the training job associated with this processing job.
", "TrainingJob$TrainingJobArn": "The Amazon Resource Name (ARN) of the training job.
", "TrainingJobStepMetadata$Arn": "The Amazon Resource Name (ARN) of the training job that was run by this step execution.
", - "TrainingJobSummary$TrainingJobArn": "The Amazon Resource Name (ARN) of the training job.
" + "TrainingJobSummary$TrainingJobArn": "The Amazon Resource Name (ARN) of the training job.
", + "UpdateTrainingJobResponse$TrainingJobArn": "The Amazon Resource Name (ARN) of the training job.
" } }, "TrainingJobDefinition": { @@ -8381,7 +9370,8 @@ "HyperParameterTrainingJobSummary$TrainingJobName": "The name of the training job.
", "StopTrainingJobRequest$TrainingJobName": "The name of the training job to stop.
", "TrainingJob$TrainingJobName": "The name of the training job.
", - "TrainingJobSummary$TrainingJobName": "The name of the training job that you want a summary for.
" + "TrainingJobSummary$TrainingJobName": "The name of the training job that you want a summary for.
", + "UpdateTrainingJobRequest$TrainingJobName": "The name of a training job to update the Debugger profiling configuration.
" } }, "TrainingJobSortByOptions": { @@ -8871,6 +9861,16 @@ "refs": { } }, + "UpdateDeviceFleetRequest": { + "base": null, + "refs": { + } + }, + "UpdateDevicesRequest": { + "base": null, + "refs": { + } + }, "UpdateDomainRequest": { "base": null, "refs": { @@ -8981,6 +9981,16 @@ "refs": { } }, + "UpdateTrainingJobRequest": { + "base": null, + "refs": { + } + }, + "UpdateTrainingJobResponse": { + "base": null, + "refs": { + } + }, "UpdateTrialComponentRequest": { "base": null, "refs": { @@ -9203,6 +10213,7 @@ "DescribeModelOutput$VpcConfig": "A VpcConfig object that specifies the VPC that this model has access to. For more information, see Protect Endpoints by Using an Amazon Virtual Private Cloud
", "DescribeTrainingJobResponse$VpcConfig": "A VpcConfig object that specifies the VPC that this training job has access to. For more information, see Protect Training Jobs by Using an Amazon Virtual Private Cloud.
", "HyperParameterTrainingJobDefinition$VpcConfig": "The VpcConfig object that specifies the VPC that you want the training jobs that this hyperparameter tuning job launches to connect to. Control access to and from your training container by configuring the VPC. For more information, see Protect Training Jobs by Using an Amazon Virtual Private Cloud.
", + "MonitoringNetworkConfig$VpcConfig": null, "NetworkConfig$VpcConfig": null, "TrainingJob$VpcConfig": "A VpcConfig object that specifies the VPC that this training job has access to. For more information, see Protect Training Jobs by Using an Amazon Virtual Private Cloud.
" } diff --git a/models/apis/sagemaker/2017-07-24/paginators-1.json b/models/apis/sagemaker/2017-07-24/paginators-1.json index 482033820fe..7a127a58cee 100644 --- a/models/apis/sagemaker/2017-07-24/paginators-1.json +++ b/models/apis/sagemaker/2017-07-24/paginators-1.json @@ -66,12 +66,36 @@ "limit_key": "MaxResults", "result_key": "ContextSummaries" }, + "ListDataQualityJobDefinitions": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "JobDefinitionSummaries" + }, + "ListDeviceFleets": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "DeviceFleetSummaries" + }, + "ListDevices": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "DeviceSummaries" + }, "ListDomains": { "input_token": "NextToken", "output_token": "NextToken", "limit_key": "MaxResults", "result_key": "Domains" }, + "ListEdgePackagingJobs": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "EdgePackagingJobSummaries" + }, "ListEndpointConfigs": { "input_token": "NextToken", "output_token": "NextToken", @@ -138,6 +162,18 @@ "limit_key": "MaxResults", "result_key": "LabelingJobSummaryList" }, + "ListModelBiasJobDefinitions": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "JobDefinitionSummaries" + }, + "ListModelExplainabilityJobDefinitions": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "JobDefinitionSummaries" + }, "ListModelPackageGroups": { "input_token": "NextToken", "output_token": "NextToken", @@ -150,6 +186,12 @@ "limit_key": "MaxResults", "result_key": "ModelPackageSummaryList" }, + "ListModelQualityJobDefinitions": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "JobDefinitionSummaries" + }, "ListModels": { "input_token": "NextToken", "output_token": "NextToken", diff --git a/service/auditmanager/api.go b/service/auditmanager/api.go new file mode 100644 index 00000000000..ec6f53e6ec1 --- /dev/null +++ b/service/auditmanager/api.go @@ -0,0 +1,13474 @@ +// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT. + +package auditmanager + +import ( + "fmt" + "time" + + "github.com/aws/aws-sdk-go/aws" + "github.com/aws/aws-sdk-go/aws/awsutil" + "github.com/aws/aws-sdk-go/aws/request" + "github.com/aws/aws-sdk-go/private/protocol" + "github.com/aws/aws-sdk-go/private/protocol/restjson" +) + +const opAssociateAssessmentReportEvidenceFolder = "AssociateAssessmentReportEvidenceFolder" + +// AssociateAssessmentReportEvidenceFolderRequest generates a "aws/request.Request" representing the +// client's request for the AssociateAssessmentReportEvidenceFolder operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See AssociateAssessmentReportEvidenceFolder for more information on using the AssociateAssessmentReportEvidenceFolder +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the AssociateAssessmentReportEvidenceFolderRequest method. +// req, resp := client.AssociateAssessmentReportEvidenceFolderRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/AssociateAssessmentReportEvidenceFolder +func (c *AuditManager) AssociateAssessmentReportEvidenceFolderRequest(input *AssociateAssessmentReportEvidenceFolderInput) (req *request.Request, output *AssociateAssessmentReportEvidenceFolderOutput) { + op := &request.Operation{ + Name: opAssociateAssessmentReportEvidenceFolder, + HTTPMethod: "PUT", + HTTPPath: "/assessments/{assessmentId}/associateToAssessmentReport", + } + + if input == nil { + input = &AssociateAssessmentReportEvidenceFolderInput{} + } + + output = &AssociateAssessmentReportEvidenceFolderOutput{} + req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(restjson.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) + return +} + +// AssociateAssessmentReportEvidenceFolder API operation for AWS Audit Manager. +// +// Associates an evidence folder to the specified assessment report in AWS Audit +// Manager. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Audit Manager's +// API operation AssociateAssessmentReportEvidenceFolder for usage and error information. +// +// Returned Error Types: +// * ValidationException +// The request has invalid or missing parameters. +// +// * AccessDeniedException +// You do not have sufficient access to perform this action. +// +// * InternalServerException +// An internal service error occurred during the processing of your request. +// Try again later. +// +// * ResourceNotFoundException +// The resource specified in the request cannot be found. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/AssociateAssessmentReportEvidenceFolder +func (c *AuditManager) AssociateAssessmentReportEvidenceFolder(input *AssociateAssessmentReportEvidenceFolderInput) (*AssociateAssessmentReportEvidenceFolderOutput, error) { + req, out := c.AssociateAssessmentReportEvidenceFolderRequest(input) + return out, req.Send() +} + +// AssociateAssessmentReportEvidenceFolderWithContext is the same as AssociateAssessmentReportEvidenceFolder with the addition of +// the ability to pass a context and additional request options. +// +// See AssociateAssessmentReportEvidenceFolder for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *AuditManager) AssociateAssessmentReportEvidenceFolderWithContext(ctx aws.Context, input *AssociateAssessmentReportEvidenceFolderInput, opts ...request.Option) (*AssociateAssessmentReportEvidenceFolderOutput, error) { + req, out := c.AssociateAssessmentReportEvidenceFolderRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opBatchAssociateAssessmentReportEvidence = "BatchAssociateAssessmentReportEvidence" + +// BatchAssociateAssessmentReportEvidenceRequest generates a "aws/request.Request" representing the +// client's request for the BatchAssociateAssessmentReportEvidence operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See BatchAssociateAssessmentReportEvidence for more information on using the BatchAssociateAssessmentReportEvidence +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the BatchAssociateAssessmentReportEvidenceRequest method. +// req, resp := client.BatchAssociateAssessmentReportEvidenceRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/BatchAssociateAssessmentReportEvidence +func (c *AuditManager) BatchAssociateAssessmentReportEvidenceRequest(input *BatchAssociateAssessmentReportEvidenceInput) (req *request.Request, output *BatchAssociateAssessmentReportEvidenceOutput) { + op := &request.Operation{ + Name: opBatchAssociateAssessmentReportEvidence, + HTTPMethod: "PUT", + HTTPPath: "/assessments/{assessmentId}/batchAssociateToAssessmentReport", + } + + if input == nil { + input = &BatchAssociateAssessmentReportEvidenceInput{} + } + + output = &BatchAssociateAssessmentReportEvidenceOutput{} + req = c.newRequest(op, input, output) + return +} + +// BatchAssociateAssessmentReportEvidence API operation for AWS Audit Manager. +// +// Associates a list of evidence to an assessment report in an AWS Audit Manager +// assessment. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Audit Manager's +// API operation BatchAssociateAssessmentReportEvidence for usage and error information. +// +// Returned Error Types: +// * ValidationException +// The request has invalid or missing parameters. +// +// * AccessDeniedException +// You do not have sufficient access to perform this action. +// +// * InternalServerException +// An internal service error occurred during the processing of your request. +// Try again later. +// +// * ResourceNotFoundException +// The resource specified in the request cannot be found. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/BatchAssociateAssessmentReportEvidence +func (c *AuditManager) BatchAssociateAssessmentReportEvidence(input *BatchAssociateAssessmentReportEvidenceInput) (*BatchAssociateAssessmentReportEvidenceOutput, error) { + req, out := c.BatchAssociateAssessmentReportEvidenceRequest(input) + return out, req.Send() +} + +// BatchAssociateAssessmentReportEvidenceWithContext is the same as BatchAssociateAssessmentReportEvidence with the addition of +// the ability to pass a context and additional request options. +// +// See BatchAssociateAssessmentReportEvidence for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *AuditManager) BatchAssociateAssessmentReportEvidenceWithContext(ctx aws.Context, input *BatchAssociateAssessmentReportEvidenceInput, opts ...request.Option) (*BatchAssociateAssessmentReportEvidenceOutput, error) { + req, out := c.BatchAssociateAssessmentReportEvidenceRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opBatchCreateDelegationByAssessment = "BatchCreateDelegationByAssessment" + +// BatchCreateDelegationByAssessmentRequest generates a "aws/request.Request" representing the +// client's request for the BatchCreateDelegationByAssessment operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See BatchCreateDelegationByAssessment for more information on using the BatchCreateDelegationByAssessment +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the BatchCreateDelegationByAssessmentRequest method. +// req, resp := client.BatchCreateDelegationByAssessmentRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/BatchCreateDelegationByAssessment +func (c *AuditManager) BatchCreateDelegationByAssessmentRequest(input *BatchCreateDelegationByAssessmentInput) (req *request.Request, output *BatchCreateDelegationByAssessmentOutput) { + op := &request.Operation{ + Name: opBatchCreateDelegationByAssessment, + HTTPMethod: "POST", + HTTPPath: "/assessments/{assessmentId}/delegations", + } + + if input == nil { + input = &BatchCreateDelegationByAssessmentInput{} + } + + output = &BatchCreateDelegationByAssessmentOutput{} + req = c.newRequest(op, input, output) + return +} + +// BatchCreateDelegationByAssessment API operation for AWS Audit Manager. +// +// Create a batch of delegations for a specified assessment in AWS Audit Manager. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Audit Manager's +// API operation BatchCreateDelegationByAssessment for usage and error information. +// +// Returned Error Types: +// * ResourceNotFoundException +// The resource specified in the request cannot be found. +// +// * AccessDeniedException +// You do not have sufficient access to perform this action. +// +// * ValidationException +// The request has invalid or missing parameters. +// +// * InternalServerException +// An internal service error occurred during the processing of your request. +// Try again later. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/BatchCreateDelegationByAssessment +func (c *AuditManager) BatchCreateDelegationByAssessment(input *BatchCreateDelegationByAssessmentInput) (*BatchCreateDelegationByAssessmentOutput, error) { + req, out := c.BatchCreateDelegationByAssessmentRequest(input) + return out, req.Send() +} + +// BatchCreateDelegationByAssessmentWithContext is the same as BatchCreateDelegationByAssessment with the addition of +// the ability to pass a context and additional request options. +// +// See BatchCreateDelegationByAssessment for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *AuditManager) BatchCreateDelegationByAssessmentWithContext(ctx aws.Context, input *BatchCreateDelegationByAssessmentInput, opts ...request.Option) (*BatchCreateDelegationByAssessmentOutput, error) { + req, out := c.BatchCreateDelegationByAssessmentRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opBatchDeleteDelegationByAssessment = "BatchDeleteDelegationByAssessment" + +// BatchDeleteDelegationByAssessmentRequest generates a "aws/request.Request" representing the +// client's request for the BatchDeleteDelegationByAssessment operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See BatchDeleteDelegationByAssessment for more information on using the BatchDeleteDelegationByAssessment +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the BatchDeleteDelegationByAssessmentRequest method. +// req, resp := client.BatchDeleteDelegationByAssessmentRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/BatchDeleteDelegationByAssessment +func (c *AuditManager) BatchDeleteDelegationByAssessmentRequest(input *BatchDeleteDelegationByAssessmentInput) (req *request.Request, output *BatchDeleteDelegationByAssessmentOutput) { + op := &request.Operation{ + Name: opBatchDeleteDelegationByAssessment, + HTTPMethod: "PUT", + HTTPPath: "/assessments/{assessmentId}/delegations", + } + + if input == nil { + input = &BatchDeleteDelegationByAssessmentInput{} + } + + output = &BatchDeleteDelegationByAssessmentOutput{} + req = c.newRequest(op, input, output) + return +} + +// BatchDeleteDelegationByAssessment API operation for AWS Audit Manager. +// +// Deletes the delegations in the specified AWS Audit Manager assessment. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Audit Manager's +// API operation BatchDeleteDelegationByAssessment for usage and error information. +// +// Returned Error Types: +// * ResourceNotFoundException +// The resource specified in the request cannot be found. +// +// * AccessDeniedException +// You do not have sufficient access to perform this action. +// +// * ValidationException +// The request has invalid or missing parameters. +// +// * InternalServerException +// An internal service error occurred during the processing of your request. +// Try again later. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/BatchDeleteDelegationByAssessment +func (c *AuditManager) BatchDeleteDelegationByAssessment(input *BatchDeleteDelegationByAssessmentInput) (*BatchDeleteDelegationByAssessmentOutput, error) { + req, out := c.BatchDeleteDelegationByAssessmentRequest(input) + return out, req.Send() +} + +// BatchDeleteDelegationByAssessmentWithContext is the same as BatchDeleteDelegationByAssessment with the addition of +// the ability to pass a context and additional request options. +// +// See BatchDeleteDelegationByAssessment for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *AuditManager) BatchDeleteDelegationByAssessmentWithContext(ctx aws.Context, input *BatchDeleteDelegationByAssessmentInput, opts ...request.Option) (*BatchDeleteDelegationByAssessmentOutput, error) { + req, out := c.BatchDeleteDelegationByAssessmentRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opBatchDisassociateAssessmentReportEvidence = "BatchDisassociateAssessmentReportEvidence" + +// BatchDisassociateAssessmentReportEvidenceRequest generates a "aws/request.Request" representing the +// client's request for the BatchDisassociateAssessmentReportEvidence operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See BatchDisassociateAssessmentReportEvidence for more information on using the BatchDisassociateAssessmentReportEvidence +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the BatchDisassociateAssessmentReportEvidenceRequest method. +// req, resp := client.BatchDisassociateAssessmentReportEvidenceRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/BatchDisassociateAssessmentReportEvidence +func (c *AuditManager) BatchDisassociateAssessmentReportEvidenceRequest(input *BatchDisassociateAssessmentReportEvidenceInput) (req *request.Request, output *BatchDisassociateAssessmentReportEvidenceOutput) { + op := &request.Operation{ + Name: opBatchDisassociateAssessmentReportEvidence, + HTTPMethod: "PUT", + HTTPPath: "/assessments/{assessmentId}/batchDisassociateFromAssessmentReport", + } + + if input == nil { + input = &BatchDisassociateAssessmentReportEvidenceInput{} + } + + output = &BatchDisassociateAssessmentReportEvidenceOutput{} + req = c.newRequest(op, input, output) + return +} + +// BatchDisassociateAssessmentReportEvidence API operation for AWS Audit Manager. +// +// Disassociates a list of evidence from the specified assessment report in +// AWS Audit Manager. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Audit Manager's +// API operation BatchDisassociateAssessmentReportEvidence for usage and error information. +// +// Returned Error Types: +// * ValidationException +// The request has invalid or missing parameters. +// +// * AccessDeniedException +// You do not have sufficient access to perform this action. +// +// * InternalServerException +// An internal service error occurred during the processing of your request. +// Try again later. +// +// * ResourceNotFoundException +// The resource specified in the request cannot be found. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/BatchDisassociateAssessmentReportEvidence +func (c *AuditManager) BatchDisassociateAssessmentReportEvidence(input *BatchDisassociateAssessmentReportEvidenceInput) (*BatchDisassociateAssessmentReportEvidenceOutput, error) { + req, out := c.BatchDisassociateAssessmentReportEvidenceRequest(input) + return out, req.Send() +} + +// BatchDisassociateAssessmentReportEvidenceWithContext is the same as BatchDisassociateAssessmentReportEvidence with the addition of +// the ability to pass a context and additional request options. +// +// See BatchDisassociateAssessmentReportEvidence for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *AuditManager) BatchDisassociateAssessmentReportEvidenceWithContext(ctx aws.Context, input *BatchDisassociateAssessmentReportEvidenceInput, opts ...request.Option) (*BatchDisassociateAssessmentReportEvidenceOutput, error) { + req, out := c.BatchDisassociateAssessmentReportEvidenceRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opBatchImportEvidenceToAssessmentControl = "BatchImportEvidenceToAssessmentControl" + +// BatchImportEvidenceToAssessmentControlRequest generates a "aws/request.Request" representing the +// client's request for the BatchImportEvidenceToAssessmentControl operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See BatchImportEvidenceToAssessmentControl for more information on using the BatchImportEvidenceToAssessmentControl +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the BatchImportEvidenceToAssessmentControlRequest method. +// req, resp := client.BatchImportEvidenceToAssessmentControlRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/BatchImportEvidenceToAssessmentControl +func (c *AuditManager) BatchImportEvidenceToAssessmentControlRequest(input *BatchImportEvidenceToAssessmentControlInput) (req *request.Request, output *BatchImportEvidenceToAssessmentControlOutput) { + op := &request.Operation{ + Name: opBatchImportEvidenceToAssessmentControl, + HTTPMethod: "POST", + HTTPPath: "/assessments/{assessmentId}/controlSets/{controlSetId}/controls/{controlId}/evidence", + } + + if input == nil { + input = &BatchImportEvidenceToAssessmentControlInput{} + } + + output = &BatchImportEvidenceToAssessmentControlOutput{} + req = c.newRequest(op, input, output) + return +} + +// BatchImportEvidenceToAssessmentControl API operation for AWS Audit Manager. +// +// Uploads one or more pieces of evidence to the specified control in the assessment +// in AWS Audit Manager. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Audit Manager's +// API operation BatchImportEvidenceToAssessmentControl for usage and error information. +// +// Returned Error Types: +// * ResourceNotFoundException +// The resource specified in the request cannot be found. +// +// * AccessDeniedException +// You do not have sufficient access to perform this action. +// +// * ValidationException +// The request has invalid or missing parameters. +// +// * InternalServerException +// An internal service error occurred during the processing of your request. +// Try again later. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/BatchImportEvidenceToAssessmentControl +func (c *AuditManager) BatchImportEvidenceToAssessmentControl(input *BatchImportEvidenceToAssessmentControlInput) (*BatchImportEvidenceToAssessmentControlOutput, error) { + req, out := c.BatchImportEvidenceToAssessmentControlRequest(input) + return out, req.Send() +} + +// BatchImportEvidenceToAssessmentControlWithContext is the same as BatchImportEvidenceToAssessmentControl with the addition of +// the ability to pass a context and additional request options. +// +// See BatchImportEvidenceToAssessmentControl for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *AuditManager) BatchImportEvidenceToAssessmentControlWithContext(ctx aws.Context, input *BatchImportEvidenceToAssessmentControlInput, opts ...request.Option) (*BatchImportEvidenceToAssessmentControlOutput, error) { + req, out := c.BatchImportEvidenceToAssessmentControlRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opCreateAssessment = "CreateAssessment" + +// CreateAssessmentRequest generates a "aws/request.Request" representing the +// client's request for the CreateAssessment operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See CreateAssessment for more information on using the CreateAssessment +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the CreateAssessmentRequest method. +// req, resp := client.CreateAssessmentRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/CreateAssessment +func (c *AuditManager) CreateAssessmentRequest(input *CreateAssessmentInput) (req *request.Request, output *CreateAssessmentOutput) { + op := &request.Operation{ + Name: opCreateAssessment, + HTTPMethod: "POST", + HTTPPath: "/assessments", + } + + if input == nil { + input = &CreateAssessmentInput{} + } + + output = &CreateAssessmentOutput{} + req = c.newRequest(op, input, output) + return +} + +// CreateAssessment API operation for AWS Audit Manager. +// +// Creates an assessment in AWS Audit Manager. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Audit Manager's +// API operation CreateAssessment for usage and error information. +// +// Returned Error Types: +// * ResourceNotFoundException +// The resource specified in the request cannot be found. +// +// * ValidationException +// The request has invalid or missing parameters. +// +// * AccessDeniedException +// You do not have sufficient access to perform this action. +// +// * InternalServerException +// An internal service error occurred during the processing of your request. +// Try again later. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/CreateAssessment +func (c *AuditManager) CreateAssessment(input *CreateAssessmentInput) (*CreateAssessmentOutput, error) { + req, out := c.CreateAssessmentRequest(input) + return out, req.Send() +} + +// CreateAssessmentWithContext is the same as CreateAssessment with the addition of +// the ability to pass a context and additional request options. +// +// See CreateAssessment for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *AuditManager) CreateAssessmentWithContext(ctx aws.Context, input *CreateAssessmentInput, opts ...request.Option) (*CreateAssessmentOutput, error) { + req, out := c.CreateAssessmentRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opCreateAssessmentFramework = "CreateAssessmentFramework" + +// CreateAssessmentFrameworkRequest generates a "aws/request.Request" representing the +// client's request for the CreateAssessmentFramework operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See CreateAssessmentFramework for more information on using the CreateAssessmentFramework +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the CreateAssessmentFrameworkRequest method. +// req, resp := client.CreateAssessmentFrameworkRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/CreateAssessmentFramework +func (c *AuditManager) CreateAssessmentFrameworkRequest(input *CreateAssessmentFrameworkInput) (req *request.Request, output *CreateAssessmentFrameworkOutput) { + op := &request.Operation{ + Name: opCreateAssessmentFramework, + HTTPMethod: "POST", + HTTPPath: "/assessmentFrameworks", + } + + if input == nil { + input = &CreateAssessmentFrameworkInput{} + } + + output = &CreateAssessmentFrameworkOutput{} + req = c.newRequest(op, input, output) + return +} + +// CreateAssessmentFramework API operation for AWS Audit Manager. +// +// Creates a custom framework in AWS Audit Manager. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Audit Manager's +// API operation CreateAssessmentFramework for usage and error information. +// +// Returned Error Types: +// * ResourceNotFoundException +// The resource specified in the request cannot be found. +// +// * ValidationException +// The request has invalid or missing parameters. +// +// * AccessDeniedException +// You do not have sufficient access to perform this action. +// +// * InternalServerException +// An internal service error occurred during the processing of your request. +// Try again later. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/CreateAssessmentFramework +func (c *AuditManager) CreateAssessmentFramework(input *CreateAssessmentFrameworkInput) (*CreateAssessmentFrameworkOutput, error) { + req, out := c.CreateAssessmentFrameworkRequest(input) + return out, req.Send() +} + +// CreateAssessmentFrameworkWithContext is the same as CreateAssessmentFramework with the addition of +// the ability to pass a context and additional request options. +// +// See CreateAssessmentFramework for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *AuditManager) CreateAssessmentFrameworkWithContext(ctx aws.Context, input *CreateAssessmentFrameworkInput, opts ...request.Option) (*CreateAssessmentFrameworkOutput, error) { + req, out := c.CreateAssessmentFrameworkRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opCreateAssessmentReport = "CreateAssessmentReport" + +// CreateAssessmentReportRequest generates a "aws/request.Request" representing the +// client's request for the CreateAssessmentReport operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See CreateAssessmentReport for more information on using the CreateAssessmentReport +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the CreateAssessmentReportRequest method. +// req, resp := client.CreateAssessmentReportRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/CreateAssessmentReport +func (c *AuditManager) CreateAssessmentReportRequest(input *CreateAssessmentReportInput) (req *request.Request, output *CreateAssessmentReportOutput) { + op := &request.Operation{ + Name: opCreateAssessmentReport, + HTTPMethod: "POST", + HTTPPath: "/assessments/{assessmentId}/reports", + } + + if input == nil { + input = &CreateAssessmentReportInput{} + } + + output = &CreateAssessmentReportOutput{} + req = c.newRequest(op, input, output) + return +} + +// CreateAssessmentReport API operation for AWS Audit Manager. +// +// Creates an assessment report for the specified assessment. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Audit Manager's +// API operation CreateAssessmentReport for usage and error information. +// +// Returned Error Types: +// * ValidationException +// The request has invalid or missing parameters. +// +// * AccessDeniedException +// You do not have sufficient access to perform this action. +// +// * InternalServerException +// An internal service error occurred during the processing of your request. +// Try again later. +// +// * ResourceNotFoundException +// The resource specified in the request cannot be found. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/CreateAssessmentReport +func (c *AuditManager) CreateAssessmentReport(input *CreateAssessmentReportInput) (*CreateAssessmentReportOutput, error) { + req, out := c.CreateAssessmentReportRequest(input) + return out, req.Send() +} + +// CreateAssessmentReportWithContext is the same as CreateAssessmentReport with the addition of +// the ability to pass a context and additional request options. +// +// See CreateAssessmentReport for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *AuditManager) CreateAssessmentReportWithContext(ctx aws.Context, input *CreateAssessmentReportInput, opts ...request.Option) (*CreateAssessmentReportOutput, error) { + req, out := c.CreateAssessmentReportRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opCreateControl = "CreateControl" + +// CreateControlRequest generates a "aws/request.Request" representing the +// client's request for the CreateControl operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See CreateControl for more information on using the CreateControl +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the CreateControlRequest method. +// req, resp := client.CreateControlRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/CreateControl +func (c *AuditManager) CreateControlRequest(input *CreateControlInput) (req *request.Request, output *CreateControlOutput) { + op := &request.Operation{ + Name: opCreateControl, + HTTPMethod: "POST", + HTTPPath: "/controls", + } + + if input == nil { + input = &CreateControlInput{} + } + + output = &CreateControlOutput{} + req = c.newRequest(op, input, output) + return +} + +// CreateControl API operation for AWS Audit Manager. +// +// Creates a new custom control in AWS Audit Manager. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Audit Manager's +// API operation CreateControl for usage and error information. +// +// Returned Error Types: +// * ResourceNotFoundException +// The resource specified in the request cannot be found. +// +// * ValidationException +// The request has invalid or missing parameters. +// +// * AccessDeniedException +// You do not have sufficient access to perform this action. +// +// * InternalServerException +// An internal service error occurred during the processing of your request. +// Try again later. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/CreateControl +func (c *AuditManager) CreateControl(input *CreateControlInput) (*CreateControlOutput, error) { + req, out := c.CreateControlRequest(input) + return out, req.Send() +} + +// CreateControlWithContext is the same as CreateControl with the addition of +// the ability to pass a context and additional request options. +// +// See CreateControl for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *AuditManager) CreateControlWithContext(ctx aws.Context, input *CreateControlInput, opts ...request.Option) (*CreateControlOutput, error) { + req, out := c.CreateControlRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opDeleteAssessment = "DeleteAssessment" + +// DeleteAssessmentRequest generates a "aws/request.Request" representing the +// client's request for the DeleteAssessment operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See DeleteAssessment for more information on using the DeleteAssessment +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the DeleteAssessmentRequest method. +// req, resp := client.DeleteAssessmentRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/DeleteAssessment +func (c *AuditManager) DeleteAssessmentRequest(input *DeleteAssessmentInput) (req *request.Request, output *DeleteAssessmentOutput) { + op := &request.Operation{ + Name: opDeleteAssessment, + HTTPMethod: "DELETE", + HTTPPath: "/assessments/{assessmentId}", + } + + if input == nil { + input = &DeleteAssessmentInput{} + } + + output = &DeleteAssessmentOutput{} + req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(restjson.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) + return +} + +// DeleteAssessment API operation for AWS Audit Manager. +// +// Deletes an assessment in AWS Audit Manager. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Audit Manager's +// API operation DeleteAssessment for usage and error information. +// +// Returned Error Types: +// * ResourceNotFoundException +// The resource specified in the request cannot be found. +// +// * ValidationException +// The request has invalid or missing parameters. +// +// * AccessDeniedException +// You do not have sufficient access to perform this action. +// +// * InternalServerException +// An internal service error occurred during the processing of your request. +// Try again later. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/DeleteAssessment +func (c *AuditManager) DeleteAssessment(input *DeleteAssessmentInput) (*DeleteAssessmentOutput, error) { + req, out := c.DeleteAssessmentRequest(input) + return out, req.Send() +} + +// DeleteAssessmentWithContext is the same as DeleteAssessment with the addition of +// the ability to pass a context and additional request options. +// +// See DeleteAssessment for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *AuditManager) DeleteAssessmentWithContext(ctx aws.Context, input *DeleteAssessmentInput, opts ...request.Option) (*DeleteAssessmentOutput, error) { + req, out := c.DeleteAssessmentRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opDeleteAssessmentFramework = "DeleteAssessmentFramework" + +// DeleteAssessmentFrameworkRequest generates a "aws/request.Request" representing the +// client's request for the DeleteAssessmentFramework operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See DeleteAssessmentFramework for more information on using the DeleteAssessmentFramework +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the DeleteAssessmentFrameworkRequest method. +// req, resp := client.DeleteAssessmentFrameworkRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/DeleteAssessmentFramework +func (c *AuditManager) DeleteAssessmentFrameworkRequest(input *DeleteAssessmentFrameworkInput) (req *request.Request, output *DeleteAssessmentFrameworkOutput) { + op := &request.Operation{ + Name: opDeleteAssessmentFramework, + HTTPMethod: "DELETE", + HTTPPath: "/assessmentFrameworks/{frameworkId}", + } + + if input == nil { + input = &DeleteAssessmentFrameworkInput{} + } + + output = &DeleteAssessmentFrameworkOutput{} + req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(restjson.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) + return +} + +// DeleteAssessmentFramework API operation for AWS Audit Manager. +// +// Deletes a custom framework in AWS Audit Manager. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Audit Manager's +// API operation DeleteAssessmentFramework for usage and error information. +// +// Returned Error Types: +// * ResourceNotFoundException +// The resource specified in the request cannot be found. +// +// * ValidationException +// The request has invalid or missing parameters. +// +// * AccessDeniedException +// You do not have sufficient access to perform this action. +// +// * InternalServerException +// An internal service error occurred during the processing of your request. +// Try again later. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/DeleteAssessmentFramework +func (c *AuditManager) DeleteAssessmentFramework(input *DeleteAssessmentFrameworkInput) (*DeleteAssessmentFrameworkOutput, error) { + req, out := c.DeleteAssessmentFrameworkRequest(input) + return out, req.Send() +} + +// DeleteAssessmentFrameworkWithContext is the same as DeleteAssessmentFramework with the addition of +// the ability to pass a context and additional request options. +// +// See DeleteAssessmentFramework for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *AuditManager) DeleteAssessmentFrameworkWithContext(ctx aws.Context, input *DeleteAssessmentFrameworkInput, opts ...request.Option) (*DeleteAssessmentFrameworkOutput, error) { + req, out := c.DeleteAssessmentFrameworkRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opDeleteAssessmentReport = "DeleteAssessmentReport" + +// DeleteAssessmentReportRequest generates a "aws/request.Request" representing the +// client's request for the DeleteAssessmentReport operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See DeleteAssessmentReport for more information on using the DeleteAssessmentReport +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the DeleteAssessmentReportRequest method. +// req, resp := client.DeleteAssessmentReportRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/DeleteAssessmentReport +func (c *AuditManager) DeleteAssessmentReportRequest(input *DeleteAssessmentReportInput) (req *request.Request, output *DeleteAssessmentReportOutput) { + op := &request.Operation{ + Name: opDeleteAssessmentReport, + HTTPMethod: "DELETE", + HTTPPath: "/assessments/{assessmentId}/reports/{assessmentReportId}", + } + + if input == nil { + input = &DeleteAssessmentReportInput{} + } + + output = &DeleteAssessmentReportOutput{} + req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(restjson.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) + return +} + +// DeleteAssessmentReport API operation for AWS Audit Manager. +// +// Deletes an assessment report from an assessment in AWS Audit Manager. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Audit Manager's +// API operation DeleteAssessmentReport for usage and error information. +// +// Returned Error Types: +// * ValidationException +// The request has invalid or missing parameters. +// +// * AccessDeniedException +// You do not have sufficient access to perform this action. +// +// * InternalServerException +// An internal service error occurred during the processing of your request. +// Try again later. +// +// * ResourceNotFoundException +// The resource specified in the request cannot be found. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/DeleteAssessmentReport +func (c *AuditManager) DeleteAssessmentReport(input *DeleteAssessmentReportInput) (*DeleteAssessmentReportOutput, error) { + req, out := c.DeleteAssessmentReportRequest(input) + return out, req.Send() +} + +// DeleteAssessmentReportWithContext is the same as DeleteAssessmentReport with the addition of +// the ability to pass a context and additional request options. +// +// See DeleteAssessmentReport for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *AuditManager) DeleteAssessmentReportWithContext(ctx aws.Context, input *DeleteAssessmentReportInput, opts ...request.Option) (*DeleteAssessmentReportOutput, error) { + req, out := c.DeleteAssessmentReportRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opDeleteControl = "DeleteControl" + +// DeleteControlRequest generates a "aws/request.Request" representing the +// client's request for the DeleteControl operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See DeleteControl for more information on using the DeleteControl +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the DeleteControlRequest method. +// req, resp := client.DeleteControlRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/DeleteControl +func (c *AuditManager) DeleteControlRequest(input *DeleteControlInput) (req *request.Request, output *DeleteControlOutput) { + op := &request.Operation{ + Name: opDeleteControl, + HTTPMethod: "DELETE", + HTTPPath: "/controls/{controlId}", + } + + if input == nil { + input = &DeleteControlInput{} + } + + output = &DeleteControlOutput{} + req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(restjson.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) + return +} + +// DeleteControl API operation for AWS Audit Manager. +// +// Deletes a custom control in AWS Audit Manager. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Audit Manager's +// API operation DeleteControl for usage and error information. +// +// Returned Error Types: +// * ResourceNotFoundException +// The resource specified in the request cannot be found. +// +// * ValidationException +// The request has invalid or missing parameters. +// +// * AccessDeniedException +// You do not have sufficient access to perform this action. +// +// * InternalServerException +// An internal service error occurred during the processing of your request. +// Try again later. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/DeleteControl +func (c *AuditManager) DeleteControl(input *DeleteControlInput) (*DeleteControlOutput, error) { + req, out := c.DeleteControlRequest(input) + return out, req.Send() +} + +// DeleteControlWithContext is the same as DeleteControl with the addition of +// the ability to pass a context and additional request options. +// +// See DeleteControl for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *AuditManager) DeleteControlWithContext(ctx aws.Context, input *DeleteControlInput, opts ...request.Option) (*DeleteControlOutput, error) { + req, out := c.DeleteControlRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opDeregisterAccount = "DeregisterAccount" + +// DeregisterAccountRequest generates a "aws/request.Request" representing the +// client's request for the DeregisterAccount operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See DeregisterAccount for more information on using the DeregisterAccount +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the DeregisterAccountRequest method. +// req, resp := client.DeregisterAccountRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/DeregisterAccount +func (c *AuditManager) DeregisterAccountRequest(input *DeregisterAccountInput) (req *request.Request, output *DeregisterAccountOutput) { + op := &request.Operation{ + Name: opDeregisterAccount, + HTTPMethod: "POST", + HTTPPath: "/account/deregisterAccount", + } + + if input == nil { + input = &DeregisterAccountInput{} + } + + output = &DeregisterAccountOutput{} + req = c.newRequest(op, input, output) + return +} + +// DeregisterAccount API operation for AWS Audit Manager. +// +// Deregisters an account in AWS Audit Manager. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Audit Manager's +// API operation DeregisterAccount for usage and error information. +// +// Returned Error Types: +// * ValidationException +// The request has invalid or missing parameters. +// +// * AccessDeniedException +// You do not have sufficient access to perform this action. +// +// * InternalServerException +// An internal service error occurred during the processing of your request. +// Try again later. +// +// * ResourceNotFoundException +// The resource specified in the request cannot be found. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/DeregisterAccount +func (c *AuditManager) DeregisterAccount(input *DeregisterAccountInput) (*DeregisterAccountOutput, error) { + req, out := c.DeregisterAccountRequest(input) + return out, req.Send() +} + +// DeregisterAccountWithContext is the same as DeregisterAccount with the addition of +// the ability to pass a context and additional request options. +// +// See DeregisterAccount for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *AuditManager) DeregisterAccountWithContext(ctx aws.Context, input *DeregisterAccountInput, opts ...request.Option) (*DeregisterAccountOutput, error) { + req, out := c.DeregisterAccountRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opDeregisterOrganizationAdminAccount = "DeregisterOrganizationAdminAccount" + +// DeregisterOrganizationAdminAccountRequest generates a "aws/request.Request" representing the +// client's request for the DeregisterOrganizationAdminAccount operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See DeregisterOrganizationAdminAccount for more information on using the DeregisterOrganizationAdminAccount +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the DeregisterOrganizationAdminAccountRequest method. +// req, resp := client.DeregisterOrganizationAdminAccountRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/DeregisterOrganizationAdminAccount +func (c *AuditManager) DeregisterOrganizationAdminAccountRequest(input *DeregisterOrganizationAdminAccountInput) (req *request.Request, output *DeregisterOrganizationAdminAccountOutput) { + op := &request.Operation{ + Name: opDeregisterOrganizationAdminAccount, + HTTPMethod: "POST", + HTTPPath: "/account/deregisterOrganizationAdminAccount", + } + + if input == nil { + input = &DeregisterOrganizationAdminAccountInput{} + } + + output = &DeregisterOrganizationAdminAccountOutput{} + req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(restjson.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) + return +} + +// DeregisterOrganizationAdminAccount API operation for AWS Audit Manager. +// +// Deregisters the delegated AWS administrator account from the AWS organization. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Audit Manager's +// API operation DeregisterOrganizationAdminAccount for usage and error information. +// +// Returned Error Types: +// * ValidationException +// The request has invalid or missing parameters. +// +// * AccessDeniedException +// You do not have sufficient access to perform this action. +// +// * InternalServerException +// An internal service error occurred during the processing of your request. +// Try again later. +// +// * ResourceNotFoundException +// The resource specified in the request cannot be found. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/DeregisterOrganizationAdminAccount +func (c *AuditManager) DeregisterOrganizationAdminAccount(input *DeregisterOrganizationAdminAccountInput) (*DeregisterOrganizationAdminAccountOutput, error) { + req, out := c.DeregisterOrganizationAdminAccountRequest(input) + return out, req.Send() +} + +// DeregisterOrganizationAdminAccountWithContext is the same as DeregisterOrganizationAdminAccount with the addition of +// the ability to pass a context and additional request options. +// +// See DeregisterOrganizationAdminAccount for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *AuditManager) DeregisterOrganizationAdminAccountWithContext(ctx aws.Context, input *DeregisterOrganizationAdminAccountInput, opts ...request.Option) (*DeregisterOrganizationAdminAccountOutput, error) { + req, out := c.DeregisterOrganizationAdminAccountRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opDisassociateAssessmentReportEvidenceFolder = "DisassociateAssessmentReportEvidenceFolder" + +// DisassociateAssessmentReportEvidenceFolderRequest generates a "aws/request.Request" representing the +// client's request for the DisassociateAssessmentReportEvidenceFolder operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See DisassociateAssessmentReportEvidenceFolder for more information on using the DisassociateAssessmentReportEvidenceFolder +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the DisassociateAssessmentReportEvidenceFolderRequest method. +// req, resp := client.DisassociateAssessmentReportEvidenceFolderRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/DisassociateAssessmentReportEvidenceFolder +func (c *AuditManager) DisassociateAssessmentReportEvidenceFolderRequest(input *DisassociateAssessmentReportEvidenceFolderInput) (req *request.Request, output *DisassociateAssessmentReportEvidenceFolderOutput) { + op := &request.Operation{ + Name: opDisassociateAssessmentReportEvidenceFolder, + HTTPMethod: "PUT", + HTTPPath: "/assessments/{assessmentId}/disassociateFromAssessmentReport", + } + + if input == nil { + input = &DisassociateAssessmentReportEvidenceFolderInput{} + } + + output = &DisassociateAssessmentReportEvidenceFolderOutput{} + req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(restjson.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) + return +} + +// DisassociateAssessmentReportEvidenceFolder API operation for AWS Audit Manager. +// +// Disassociates an evidence folder from the specified assessment report in +// AWS Audit Manager. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Audit Manager's +// API operation DisassociateAssessmentReportEvidenceFolder for usage and error information. +// +// Returned Error Types: +// * ValidationException +// The request has invalid or missing parameters. +// +// * AccessDeniedException +// You do not have sufficient access to perform this action. +// +// * InternalServerException +// An internal service error occurred during the processing of your request. +// Try again later. +// +// * ResourceNotFoundException +// The resource specified in the request cannot be found. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/DisassociateAssessmentReportEvidenceFolder +func (c *AuditManager) DisassociateAssessmentReportEvidenceFolder(input *DisassociateAssessmentReportEvidenceFolderInput) (*DisassociateAssessmentReportEvidenceFolderOutput, error) { + req, out := c.DisassociateAssessmentReportEvidenceFolderRequest(input) + return out, req.Send() +} + +// DisassociateAssessmentReportEvidenceFolderWithContext is the same as DisassociateAssessmentReportEvidenceFolder with the addition of +// the ability to pass a context and additional request options. +// +// See DisassociateAssessmentReportEvidenceFolder for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *AuditManager) DisassociateAssessmentReportEvidenceFolderWithContext(ctx aws.Context, input *DisassociateAssessmentReportEvidenceFolderInput, opts ...request.Option) (*DisassociateAssessmentReportEvidenceFolderOutput, error) { + req, out := c.DisassociateAssessmentReportEvidenceFolderRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opGetAccountStatus = "GetAccountStatus" + +// GetAccountStatusRequest generates a "aws/request.Request" representing the +// client's request for the GetAccountStatus operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See GetAccountStatus for more information on using the GetAccountStatus +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the GetAccountStatusRequest method. +// req, resp := client.GetAccountStatusRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/GetAccountStatus +func (c *AuditManager) GetAccountStatusRequest(input *GetAccountStatusInput) (req *request.Request, output *GetAccountStatusOutput) { + op := &request.Operation{ + Name: opGetAccountStatus, + HTTPMethod: "GET", + HTTPPath: "/account/status", + } + + if input == nil { + input = &GetAccountStatusInput{} + } + + output = &GetAccountStatusOutput{} + req = c.newRequest(op, input, output) + return +} + +// GetAccountStatus API operation for AWS Audit Manager. +// +// Returns the registration status of an account in AWS Audit Manager. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Audit Manager's +// API operation GetAccountStatus for usage and error information. +// +// Returned Error Types: +// * InternalServerException +// An internal service error occurred during the processing of your request. +// Try again later. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/GetAccountStatus +func (c *AuditManager) GetAccountStatus(input *GetAccountStatusInput) (*GetAccountStatusOutput, error) { + req, out := c.GetAccountStatusRequest(input) + return out, req.Send() +} + +// GetAccountStatusWithContext is the same as GetAccountStatus with the addition of +// the ability to pass a context and additional request options. +// +// See GetAccountStatus for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *AuditManager) GetAccountStatusWithContext(ctx aws.Context, input *GetAccountStatusInput, opts ...request.Option) (*GetAccountStatusOutput, error) { + req, out := c.GetAccountStatusRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opGetAssessment = "GetAssessment" + +// GetAssessmentRequest generates a "aws/request.Request" representing the +// client's request for the GetAssessment operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See GetAssessment for more information on using the GetAssessment +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the GetAssessmentRequest method. +// req, resp := client.GetAssessmentRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/GetAssessment +func (c *AuditManager) GetAssessmentRequest(input *GetAssessmentInput) (req *request.Request, output *GetAssessmentOutput) { + op := &request.Operation{ + Name: opGetAssessment, + HTTPMethod: "GET", + HTTPPath: "/assessments/{assessmentId}", + } + + if input == nil { + input = &GetAssessmentInput{} + } + + output = &GetAssessmentOutput{} + req = c.newRequest(op, input, output) + return +} + +// GetAssessment API operation for AWS Audit Manager. +// +// Returns an assessment from AWS Audit Manager. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Audit Manager's +// API operation GetAssessment for usage and error information. +// +// Returned Error Types: +// * ResourceNotFoundException +// The resource specified in the request cannot be found. +// +// * ValidationException +// The request has invalid or missing parameters. +// +// * AccessDeniedException +// You do not have sufficient access to perform this action. +// +// * InternalServerException +// An internal service error occurred during the processing of your request. +// Try again later. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/GetAssessment +func (c *AuditManager) GetAssessment(input *GetAssessmentInput) (*GetAssessmentOutput, error) { + req, out := c.GetAssessmentRequest(input) + return out, req.Send() +} + +// GetAssessmentWithContext is the same as GetAssessment with the addition of +// the ability to pass a context and additional request options. +// +// See GetAssessment for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *AuditManager) GetAssessmentWithContext(ctx aws.Context, input *GetAssessmentInput, opts ...request.Option) (*GetAssessmentOutput, error) { + req, out := c.GetAssessmentRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opGetAssessmentFramework = "GetAssessmentFramework" + +// GetAssessmentFrameworkRequest generates a "aws/request.Request" representing the +// client's request for the GetAssessmentFramework operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See GetAssessmentFramework for more information on using the GetAssessmentFramework +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the GetAssessmentFrameworkRequest method. +// req, resp := client.GetAssessmentFrameworkRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/GetAssessmentFramework +func (c *AuditManager) GetAssessmentFrameworkRequest(input *GetAssessmentFrameworkInput) (req *request.Request, output *GetAssessmentFrameworkOutput) { + op := &request.Operation{ + Name: opGetAssessmentFramework, + HTTPMethod: "GET", + HTTPPath: "/assessmentFrameworks/{frameworkId}", + } + + if input == nil { + input = &GetAssessmentFrameworkInput{} + } + + output = &GetAssessmentFrameworkOutput{} + req = c.newRequest(op, input, output) + return +} + +// GetAssessmentFramework API operation for AWS Audit Manager. +// +// Returns a framework from AWS Audit Manager. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Audit Manager's +// API operation GetAssessmentFramework for usage and error information. +// +// Returned Error Types: +// * ResourceNotFoundException +// The resource specified in the request cannot be found. +// +// * ValidationException +// The request has invalid or missing parameters. +// +// * AccessDeniedException +// You do not have sufficient access to perform this action. +// +// * InternalServerException +// An internal service error occurred during the processing of your request. +// Try again later. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/GetAssessmentFramework +func (c *AuditManager) GetAssessmentFramework(input *GetAssessmentFrameworkInput) (*GetAssessmentFrameworkOutput, error) { + req, out := c.GetAssessmentFrameworkRequest(input) + return out, req.Send() +} + +// GetAssessmentFrameworkWithContext is the same as GetAssessmentFramework with the addition of +// the ability to pass a context and additional request options. +// +// See GetAssessmentFramework for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *AuditManager) GetAssessmentFrameworkWithContext(ctx aws.Context, input *GetAssessmentFrameworkInput, opts ...request.Option) (*GetAssessmentFrameworkOutput, error) { + req, out := c.GetAssessmentFrameworkRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opGetAssessmentReportUrl = "GetAssessmentReportUrl" + +// GetAssessmentReportUrlRequest generates a "aws/request.Request" representing the +// client's request for the GetAssessmentReportUrl operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See GetAssessmentReportUrl for more information on using the GetAssessmentReportUrl +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the GetAssessmentReportUrlRequest method. +// req, resp := client.GetAssessmentReportUrlRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/GetAssessmentReportUrl +func (c *AuditManager) GetAssessmentReportUrlRequest(input *GetAssessmentReportUrlInput) (req *request.Request, output *GetAssessmentReportUrlOutput) { + op := &request.Operation{ + Name: opGetAssessmentReportUrl, + HTTPMethod: "GET", + HTTPPath: "/assessments/{assessmentId}/reports/{assessmentReportId}/url", + } + + if input == nil { + input = &GetAssessmentReportUrlInput{} + } + + output = &GetAssessmentReportUrlOutput{} + req = c.newRequest(op, input, output) + return +} + +// GetAssessmentReportUrl API operation for AWS Audit Manager. +// +// Returns the URL of a specified assessment report in AWS Audit Manager. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Audit Manager's +// API operation GetAssessmentReportUrl for usage and error information. +// +// Returned Error Types: +// * ValidationException +// The request has invalid or missing parameters. +// +// * AccessDeniedException +// You do not have sufficient access to perform this action. +// +// * InternalServerException +// An internal service error occurred during the processing of your request. +// Try again later. +// +// * ResourceNotFoundException +// The resource specified in the request cannot be found. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/GetAssessmentReportUrl +func (c *AuditManager) GetAssessmentReportUrl(input *GetAssessmentReportUrlInput) (*GetAssessmentReportUrlOutput, error) { + req, out := c.GetAssessmentReportUrlRequest(input) + return out, req.Send() +} + +// GetAssessmentReportUrlWithContext is the same as GetAssessmentReportUrl with the addition of +// the ability to pass a context and additional request options. +// +// See GetAssessmentReportUrl for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *AuditManager) GetAssessmentReportUrlWithContext(ctx aws.Context, input *GetAssessmentReportUrlInput, opts ...request.Option) (*GetAssessmentReportUrlOutput, error) { + req, out := c.GetAssessmentReportUrlRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opGetChangeLogs = "GetChangeLogs" + +// GetChangeLogsRequest generates a "aws/request.Request" representing the +// client's request for the GetChangeLogs operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See GetChangeLogs for more information on using the GetChangeLogs +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the GetChangeLogsRequest method. +// req, resp := client.GetChangeLogsRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/GetChangeLogs +func (c *AuditManager) GetChangeLogsRequest(input *GetChangeLogsInput) (req *request.Request, output *GetChangeLogsOutput) { + op := &request.Operation{ + Name: opGetChangeLogs, + HTTPMethod: "GET", + HTTPPath: "/assessments/{assessmentId}/changelogs", + Paginator: &request.Paginator{ + InputTokens: []string{"nextToken"}, + OutputTokens: []string{"nextToken"}, + LimitToken: "maxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &GetChangeLogsInput{} + } + + output = &GetChangeLogsOutput{} + req = c.newRequest(op, input, output) + return +} + +// GetChangeLogs API operation for AWS Audit Manager. +// +// Returns a list of changelogs from AWS Audit Manager. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Audit Manager's +// API operation GetChangeLogs for usage and error information. +// +// Returned Error Types: +// * AccessDeniedException +// You do not have sufficient access to perform this action. +// +// * ResourceNotFoundException +// The resource specified in the request cannot be found. +// +// * ValidationException +// The request has invalid or missing parameters. +// +// * InternalServerException +// An internal service error occurred during the processing of your request. +// Try again later. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/GetChangeLogs +func (c *AuditManager) GetChangeLogs(input *GetChangeLogsInput) (*GetChangeLogsOutput, error) { + req, out := c.GetChangeLogsRequest(input) + return out, req.Send() +} + +// GetChangeLogsWithContext is the same as GetChangeLogs with the addition of +// the ability to pass a context and additional request options. +// +// See GetChangeLogs for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *AuditManager) GetChangeLogsWithContext(ctx aws.Context, input *GetChangeLogsInput, opts ...request.Option) (*GetChangeLogsOutput, error) { + req, out := c.GetChangeLogsRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// GetChangeLogsPages iterates over the pages of a GetChangeLogs operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See GetChangeLogs method for more information on how to use this operation. +// +// Note: This operation can generate multiple requests to a service. +// +// // Example iterating over at most 3 pages of a GetChangeLogs operation. +// pageNum := 0 +// err := client.GetChangeLogsPages(params, +// func(page *auditmanager.GetChangeLogsOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *AuditManager) GetChangeLogsPages(input *GetChangeLogsInput, fn func(*GetChangeLogsOutput, bool) bool) error { + return c.GetChangeLogsPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// GetChangeLogsPagesWithContext same as GetChangeLogsPages except +// it takes a Context and allows setting request options on the pages. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *AuditManager) GetChangeLogsPagesWithContext(ctx aws.Context, input *GetChangeLogsInput, fn func(*GetChangeLogsOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *GetChangeLogsInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.GetChangeLogsRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*GetChangeLogsOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + +const opGetControl = "GetControl" + +// GetControlRequest generates a "aws/request.Request" representing the +// client's request for the GetControl operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See GetControl for more information on using the GetControl +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the GetControlRequest method. +// req, resp := client.GetControlRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/GetControl +func (c *AuditManager) GetControlRequest(input *GetControlInput) (req *request.Request, output *GetControlOutput) { + op := &request.Operation{ + Name: opGetControl, + HTTPMethod: "GET", + HTTPPath: "/controls/{controlId}", + } + + if input == nil { + input = &GetControlInput{} + } + + output = &GetControlOutput{} + req = c.newRequest(op, input, output) + return +} + +// GetControl API operation for AWS Audit Manager. +// +// Returns a control from AWS Audit Manager. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Audit Manager's +// API operation GetControl for usage and error information. +// +// Returned Error Types: +// * ResourceNotFoundException +// The resource specified in the request cannot be found. +// +// * ValidationException +// The request has invalid or missing parameters. +// +// * AccessDeniedException +// You do not have sufficient access to perform this action. +// +// * InternalServerException +// An internal service error occurred during the processing of your request. +// Try again later. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/GetControl +func (c *AuditManager) GetControl(input *GetControlInput) (*GetControlOutput, error) { + req, out := c.GetControlRequest(input) + return out, req.Send() +} + +// GetControlWithContext is the same as GetControl with the addition of +// the ability to pass a context and additional request options. +// +// See GetControl for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *AuditManager) GetControlWithContext(ctx aws.Context, input *GetControlInput, opts ...request.Option) (*GetControlOutput, error) { + req, out := c.GetControlRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opGetDelegations = "GetDelegations" + +// GetDelegationsRequest generates a "aws/request.Request" representing the +// client's request for the GetDelegations operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See GetDelegations for more information on using the GetDelegations +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the GetDelegationsRequest method. +// req, resp := client.GetDelegationsRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/GetDelegations +func (c *AuditManager) GetDelegationsRequest(input *GetDelegationsInput) (req *request.Request, output *GetDelegationsOutput) { + op := &request.Operation{ + Name: opGetDelegations, + HTTPMethod: "GET", + HTTPPath: "/delegations", + Paginator: &request.Paginator{ + InputTokens: []string{"nextToken"}, + OutputTokens: []string{"nextToken"}, + LimitToken: "maxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &GetDelegationsInput{} + } + + output = &GetDelegationsOutput{} + req = c.newRequest(op, input, output) + return +} + +// GetDelegations API operation for AWS Audit Manager. +// +// Returns a list of delegations from an audit owner to a delegate. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Audit Manager's +// API operation GetDelegations for usage and error information. +// +// Returned Error Types: +// * ValidationException +// The request has invalid or missing parameters. +// +// * AccessDeniedException +// You do not have sufficient access to perform this action. +// +// * InternalServerException +// An internal service error occurred during the processing of your request. +// Try again later. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/GetDelegations +func (c *AuditManager) GetDelegations(input *GetDelegationsInput) (*GetDelegationsOutput, error) { + req, out := c.GetDelegationsRequest(input) + return out, req.Send() +} + +// GetDelegationsWithContext is the same as GetDelegations with the addition of +// the ability to pass a context and additional request options. +// +// See GetDelegations for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *AuditManager) GetDelegationsWithContext(ctx aws.Context, input *GetDelegationsInput, opts ...request.Option) (*GetDelegationsOutput, error) { + req, out := c.GetDelegationsRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// GetDelegationsPages iterates over the pages of a GetDelegations operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See GetDelegations method for more information on how to use this operation. +// +// Note: This operation can generate multiple requests to a service. +// +// // Example iterating over at most 3 pages of a GetDelegations operation. +// pageNum := 0 +// err := client.GetDelegationsPages(params, +// func(page *auditmanager.GetDelegationsOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *AuditManager) GetDelegationsPages(input *GetDelegationsInput, fn func(*GetDelegationsOutput, bool) bool) error { + return c.GetDelegationsPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// GetDelegationsPagesWithContext same as GetDelegationsPages except +// it takes a Context and allows setting request options on the pages. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *AuditManager) GetDelegationsPagesWithContext(ctx aws.Context, input *GetDelegationsInput, fn func(*GetDelegationsOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *GetDelegationsInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.GetDelegationsRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*GetDelegationsOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + +const opGetEvidence = "GetEvidence" + +// GetEvidenceRequest generates a "aws/request.Request" representing the +// client's request for the GetEvidence operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See GetEvidence for more information on using the GetEvidence +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the GetEvidenceRequest method. +// req, resp := client.GetEvidenceRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/GetEvidence +func (c *AuditManager) GetEvidenceRequest(input *GetEvidenceInput) (req *request.Request, output *GetEvidenceOutput) { + op := &request.Operation{ + Name: opGetEvidence, + HTTPMethod: "GET", + HTTPPath: "/assessments/{assessmentId}/controlSets/{controlSetId}/evidenceFolders/{evidenceFolderId}/evidence/{evidenceId}", + } + + if input == nil { + input = &GetEvidenceInput{} + } + + output = &GetEvidenceOutput{} + req = c.newRequest(op, input, output) + return +} + +// GetEvidence API operation for AWS Audit Manager. +// +// Returns evidence from AWS Audit Manager. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Audit Manager's +// API operation GetEvidence for usage and error information. +// +// Returned Error Types: +// * ResourceNotFoundException +// The resource specified in the request cannot be found. +// +// * ValidationException +// The request has invalid or missing parameters. +// +// * AccessDeniedException +// You do not have sufficient access to perform this action. +// +// * InternalServerException +// An internal service error occurred during the processing of your request. +// Try again later. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/GetEvidence +func (c *AuditManager) GetEvidence(input *GetEvidenceInput) (*GetEvidenceOutput, error) { + req, out := c.GetEvidenceRequest(input) + return out, req.Send() +} + +// GetEvidenceWithContext is the same as GetEvidence with the addition of +// the ability to pass a context and additional request options. +// +// See GetEvidence for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *AuditManager) GetEvidenceWithContext(ctx aws.Context, input *GetEvidenceInput, opts ...request.Option) (*GetEvidenceOutput, error) { + req, out := c.GetEvidenceRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opGetEvidenceByEvidenceFolder = "GetEvidenceByEvidenceFolder" + +// GetEvidenceByEvidenceFolderRequest generates a "aws/request.Request" representing the +// client's request for the GetEvidenceByEvidenceFolder operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See GetEvidenceByEvidenceFolder for more information on using the GetEvidenceByEvidenceFolder +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the GetEvidenceByEvidenceFolderRequest method. +// req, resp := client.GetEvidenceByEvidenceFolderRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/GetEvidenceByEvidenceFolder +func (c *AuditManager) GetEvidenceByEvidenceFolderRequest(input *GetEvidenceByEvidenceFolderInput) (req *request.Request, output *GetEvidenceByEvidenceFolderOutput) { + op := &request.Operation{ + Name: opGetEvidenceByEvidenceFolder, + HTTPMethod: "GET", + HTTPPath: "/assessments/{assessmentId}/controlSets/{controlSetId}/evidenceFolders/{evidenceFolderId}/evidence", + Paginator: &request.Paginator{ + InputTokens: []string{"nextToken"}, + OutputTokens: []string{"nextToken"}, + LimitToken: "maxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &GetEvidenceByEvidenceFolderInput{} + } + + output = &GetEvidenceByEvidenceFolderOutput{} + req = c.newRequest(op, input, output) + return +} + +// GetEvidenceByEvidenceFolder API operation for AWS Audit Manager. +// +// Returns all evidence from a specified evidence folder in AWS Audit Manager. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Audit Manager's +// API operation GetEvidenceByEvidenceFolder for usage and error information. +// +// Returned Error Types: +// * ResourceNotFoundException +// The resource specified in the request cannot be found. +// +// * ValidationException +// The request has invalid or missing parameters. +// +// * AccessDeniedException +// You do not have sufficient access to perform this action. +// +// * InternalServerException +// An internal service error occurred during the processing of your request. +// Try again later. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/GetEvidenceByEvidenceFolder +func (c *AuditManager) GetEvidenceByEvidenceFolder(input *GetEvidenceByEvidenceFolderInput) (*GetEvidenceByEvidenceFolderOutput, error) { + req, out := c.GetEvidenceByEvidenceFolderRequest(input) + return out, req.Send() +} + +// GetEvidenceByEvidenceFolderWithContext is the same as GetEvidenceByEvidenceFolder with the addition of +// the ability to pass a context and additional request options. +// +// See GetEvidenceByEvidenceFolder for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *AuditManager) GetEvidenceByEvidenceFolderWithContext(ctx aws.Context, input *GetEvidenceByEvidenceFolderInput, opts ...request.Option) (*GetEvidenceByEvidenceFolderOutput, error) { + req, out := c.GetEvidenceByEvidenceFolderRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// GetEvidenceByEvidenceFolderPages iterates over the pages of a GetEvidenceByEvidenceFolder operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See GetEvidenceByEvidenceFolder method for more information on how to use this operation. +// +// Note: This operation can generate multiple requests to a service. +// +// // Example iterating over at most 3 pages of a GetEvidenceByEvidenceFolder operation. +// pageNum := 0 +// err := client.GetEvidenceByEvidenceFolderPages(params, +// func(page *auditmanager.GetEvidenceByEvidenceFolderOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *AuditManager) GetEvidenceByEvidenceFolderPages(input *GetEvidenceByEvidenceFolderInput, fn func(*GetEvidenceByEvidenceFolderOutput, bool) bool) error { + return c.GetEvidenceByEvidenceFolderPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// GetEvidenceByEvidenceFolderPagesWithContext same as GetEvidenceByEvidenceFolderPages except +// it takes a Context and allows setting request options on the pages. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *AuditManager) GetEvidenceByEvidenceFolderPagesWithContext(ctx aws.Context, input *GetEvidenceByEvidenceFolderInput, fn func(*GetEvidenceByEvidenceFolderOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *GetEvidenceByEvidenceFolderInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.GetEvidenceByEvidenceFolderRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*GetEvidenceByEvidenceFolderOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + +const opGetEvidenceFolder = "GetEvidenceFolder" + +// GetEvidenceFolderRequest generates a "aws/request.Request" representing the +// client's request for the GetEvidenceFolder operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See GetEvidenceFolder for more information on using the GetEvidenceFolder +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the GetEvidenceFolderRequest method. +// req, resp := client.GetEvidenceFolderRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/GetEvidenceFolder +func (c *AuditManager) GetEvidenceFolderRequest(input *GetEvidenceFolderInput) (req *request.Request, output *GetEvidenceFolderOutput) { + op := &request.Operation{ + Name: opGetEvidenceFolder, + HTTPMethod: "GET", + HTTPPath: "/assessments/{assessmentId}/controlSets/{controlSetId}/evidenceFolders/{evidenceFolderId}", + } + + if input == nil { + input = &GetEvidenceFolderInput{} + } + + output = &GetEvidenceFolderOutput{} + req = c.newRequest(op, input, output) + return +} + +// GetEvidenceFolder API operation for AWS Audit Manager. +// +// Returns an evidence folder from the specified assessment in AWS Audit Manager. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Audit Manager's +// API operation GetEvidenceFolder for usage and error information. +// +// Returned Error Types: +// * ResourceNotFoundException +// The resource specified in the request cannot be found. +// +// * ValidationException +// The request has invalid or missing parameters. +// +// * AccessDeniedException +// You do not have sufficient access to perform this action. +// +// * InternalServerException +// An internal service error occurred during the processing of your request. +// Try again later. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/GetEvidenceFolder +func (c *AuditManager) GetEvidenceFolder(input *GetEvidenceFolderInput) (*GetEvidenceFolderOutput, error) { + req, out := c.GetEvidenceFolderRequest(input) + return out, req.Send() +} + +// GetEvidenceFolderWithContext is the same as GetEvidenceFolder with the addition of +// the ability to pass a context and additional request options. +// +// See GetEvidenceFolder for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *AuditManager) GetEvidenceFolderWithContext(ctx aws.Context, input *GetEvidenceFolderInput, opts ...request.Option) (*GetEvidenceFolderOutput, error) { + req, out := c.GetEvidenceFolderRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opGetEvidenceFoldersByAssessment = "GetEvidenceFoldersByAssessment" + +// GetEvidenceFoldersByAssessmentRequest generates a "aws/request.Request" representing the +// client's request for the GetEvidenceFoldersByAssessment operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See GetEvidenceFoldersByAssessment for more information on using the GetEvidenceFoldersByAssessment +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the GetEvidenceFoldersByAssessmentRequest method. +// req, resp := client.GetEvidenceFoldersByAssessmentRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/GetEvidenceFoldersByAssessment +func (c *AuditManager) GetEvidenceFoldersByAssessmentRequest(input *GetEvidenceFoldersByAssessmentInput) (req *request.Request, output *GetEvidenceFoldersByAssessmentOutput) { + op := &request.Operation{ + Name: opGetEvidenceFoldersByAssessment, + HTTPMethod: "GET", + HTTPPath: "/assessments/{assessmentId}/evidenceFolders", + Paginator: &request.Paginator{ + InputTokens: []string{"nextToken"}, + OutputTokens: []string{"nextToken"}, + LimitToken: "maxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &GetEvidenceFoldersByAssessmentInput{} + } + + output = &GetEvidenceFoldersByAssessmentOutput{} + req = c.newRequest(op, input, output) + return +} + +// GetEvidenceFoldersByAssessment API operation for AWS Audit Manager. +// +// Returns the evidence folders from a specified assessment in AWS Audit Manager. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Audit Manager's +// API operation GetEvidenceFoldersByAssessment for usage and error information. +// +// Returned Error Types: +// * ResourceNotFoundException +// The resource specified in the request cannot be found. +// +// * AccessDeniedException +// You do not have sufficient access to perform this action. +// +// * ValidationException +// The request has invalid or missing parameters. +// +// * InternalServerException +// An internal service error occurred during the processing of your request. +// Try again later. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/GetEvidenceFoldersByAssessment +func (c *AuditManager) GetEvidenceFoldersByAssessment(input *GetEvidenceFoldersByAssessmentInput) (*GetEvidenceFoldersByAssessmentOutput, error) { + req, out := c.GetEvidenceFoldersByAssessmentRequest(input) + return out, req.Send() +} + +// GetEvidenceFoldersByAssessmentWithContext is the same as GetEvidenceFoldersByAssessment with the addition of +// the ability to pass a context and additional request options. +// +// See GetEvidenceFoldersByAssessment for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *AuditManager) GetEvidenceFoldersByAssessmentWithContext(ctx aws.Context, input *GetEvidenceFoldersByAssessmentInput, opts ...request.Option) (*GetEvidenceFoldersByAssessmentOutput, error) { + req, out := c.GetEvidenceFoldersByAssessmentRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// GetEvidenceFoldersByAssessmentPages iterates over the pages of a GetEvidenceFoldersByAssessment operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See GetEvidenceFoldersByAssessment method for more information on how to use this operation. +// +// Note: This operation can generate multiple requests to a service. +// +// // Example iterating over at most 3 pages of a GetEvidenceFoldersByAssessment operation. +// pageNum := 0 +// err := client.GetEvidenceFoldersByAssessmentPages(params, +// func(page *auditmanager.GetEvidenceFoldersByAssessmentOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *AuditManager) GetEvidenceFoldersByAssessmentPages(input *GetEvidenceFoldersByAssessmentInput, fn func(*GetEvidenceFoldersByAssessmentOutput, bool) bool) error { + return c.GetEvidenceFoldersByAssessmentPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// GetEvidenceFoldersByAssessmentPagesWithContext same as GetEvidenceFoldersByAssessmentPages except +// it takes a Context and allows setting request options on the pages. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *AuditManager) GetEvidenceFoldersByAssessmentPagesWithContext(ctx aws.Context, input *GetEvidenceFoldersByAssessmentInput, fn func(*GetEvidenceFoldersByAssessmentOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *GetEvidenceFoldersByAssessmentInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.GetEvidenceFoldersByAssessmentRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*GetEvidenceFoldersByAssessmentOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + +const opGetEvidenceFoldersByAssessmentControl = "GetEvidenceFoldersByAssessmentControl" + +// GetEvidenceFoldersByAssessmentControlRequest generates a "aws/request.Request" representing the +// client's request for the GetEvidenceFoldersByAssessmentControl operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See GetEvidenceFoldersByAssessmentControl for more information on using the GetEvidenceFoldersByAssessmentControl +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the GetEvidenceFoldersByAssessmentControlRequest method. +// req, resp := client.GetEvidenceFoldersByAssessmentControlRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/GetEvidenceFoldersByAssessmentControl +func (c *AuditManager) GetEvidenceFoldersByAssessmentControlRequest(input *GetEvidenceFoldersByAssessmentControlInput) (req *request.Request, output *GetEvidenceFoldersByAssessmentControlOutput) { + op := &request.Operation{ + Name: opGetEvidenceFoldersByAssessmentControl, + HTTPMethod: "GET", + HTTPPath: "/assessments/{assessmentId}/evidenceFolders-by-assessment-control/{controlSetId}/{controlId}", + Paginator: &request.Paginator{ + InputTokens: []string{"nextToken"}, + OutputTokens: []string{"nextToken"}, + LimitToken: "maxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &GetEvidenceFoldersByAssessmentControlInput{} + } + + output = &GetEvidenceFoldersByAssessmentControlOutput{} + req = c.newRequest(op, input, output) + return +} + +// GetEvidenceFoldersByAssessmentControl API operation for AWS Audit Manager. +// +// Returns a list of evidence folders associated with a specified control of +// an assessment in AWS Audit Manager. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Audit Manager's +// API operation GetEvidenceFoldersByAssessmentControl for usage and error information. +// +// Returned Error Types: +// * ResourceNotFoundException +// The resource specified in the request cannot be found. +// +// * ValidationException +// The request has invalid or missing parameters. +// +// * AccessDeniedException +// You do not have sufficient access to perform this action. +// +// * InternalServerException +// An internal service error occurred during the processing of your request. +// Try again later. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/GetEvidenceFoldersByAssessmentControl +func (c *AuditManager) GetEvidenceFoldersByAssessmentControl(input *GetEvidenceFoldersByAssessmentControlInput) (*GetEvidenceFoldersByAssessmentControlOutput, error) { + req, out := c.GetEvidenceFoldersByAssessmentControlRequest(input) + return out, req.Send() +} + +// GetEvidenceFoldersByAssessmentControlWithContext is the same as GetEvidenceFoldersByAssessmentControl with the addition of +// the ability to pass a context and additional request options. +// +// See GetEvidenceFoldersByAssessmentControl for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *AuditManager) GetEvidenceFoldersByAssessmentControlWithContext(ctx aws.Context, input *GetEvidenceFoldersByAssessmentControlInput, opts ...request.Option) (*GetEvidenceFoldersByAssessmentControlOutput, error) { + req, out := c.GetEvidenceFoldersByAssessmentControlRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// GetEvidenceFoldersByAssessmentControlPages iterates over the pages of a GetEvidenceFoldersByAssessmentControl operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See GetEvidenceFoldersByAssessmentControl method for more information on how to use this operation. +// +// Note: This operation can generate multiple requests to a service. +// +// // Example iterating over at most 3 pages of a GetEvidenceFoldersByAssessmentControl operation. +// pageNum := 0 +// err := client.GetEvidenceFoldersByAssessmentControlPages(params, +// func(page *auditmanager.GetEvidenceFoldersByAssessmentControlOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *AuditManager) GetEvidenceFoldersByAssessmentControlPages(input *GetEvidenceFoldersByAssessmentControlInput, fn func(*GetEvidenceFoldersByAssessmentControlOutput, bool) bool) error { + return c.GetEvidenceFoldersByAssessmentControlPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// GetEvidenceFoldersByAssessmentControlPagesWithContext same as GetEvidenceFoldersByAssessmentControlPages except +// it takes a Context and allows setting request options on the pages. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *AuditManager) GetEvidenceFoldersByAssessmentControlPagesWithContext(ctx aws.Context, input *GetEvidenceFoldersByAssessmentControlInput, fn func(*GetEvidenceFoldersByAssessmentControlOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *GetEvidenceFoldersByAssessmentControlInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.GetEvidenceFoldersByAssessmentControlRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*GetEvidenceFoldersByAssessmentControlOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + +const opGetOrganizationAdminAccount = "GetOrganizationAdminAccount" + +// GetOrganizationAdminAccountRequest generates a "aws/request.Request" representing the +// client's request for the GetOrganizationAdminAccount operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See GetOrganizationAdminAccount for more information on using the GetOrganizationAdminAccount +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the GetOrganizationAdminAccountRequest method. +// req, resp := client.GetOrganizationAdminAccountRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/GetOrganizationAdminAccount +func (c *AuditManager) GetOrganizationAdminAccountRequest(input *GetOrganizationAdminAccountInput) (req *request.Request, output *GetOrganizationAdminAccountOutput) { + op := &request.Operation{ + Name: opGetOrganizationAdminAccount, + HTTPMethod: "GET", + HTTPPath: "/account/organizationAdminAccount", + } + + if input == nil { + input = &GetOrganizationAdminAccountInput{} + } + + output = &GetOrganizationAdminAccountOutput{} + req = c.newRequest(op, input, output) + return +} + +// GetOrganizationAdminAccount API operation for AWS Audit Manager. +// +// Returns the name of the delegated AWS administrator account for the AWS organization. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Audit Manager's +// API operation GetOrganizationAdminAccount for usage and error information. +// +// Returned Error Types: +// * ValidationException +// The request has invalid or missing parameters. +// +// * AccessDeniedException +// You do not have sufficient access to perform this action. +// +// * InternalServerException +// An internal service error occurred during the processing of your request. +// Try again later. +// +// * ResourceNotFoundException +// The resource specified in the request cannot be found. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/GetOrganizationAdminAccount +func (c *AuditManager) GetOrganizationAdminAccount(input *GetOrganizationAdminAccountInput) (*GetOrganizationAdminAccountOutput, error) { + req, out := c.GetOrganizationAdminAccountRequest(input) + return out, req.Send() +} + +// GetOrganizationAdminAccountWithContext is the same as GetOrganizationAdminAccount with the addition of +// the ability to pass a context and additional request options. +// +// See GetOrganizationAdminAccount for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *AuditManager) GetOrganizationAdminAccountWithContext(ctx aws.Context, input *GetOrganizationAdminAccountInput, opts ...request.Option) (*GetOrganizationAdminAccountOutput, error) { + req, out := c.GetOrganizationAdminAccountRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opGetServicesInScope = "GetServicesInScope" + +// GetServicesInScopeRequest generates a "aws/request.Request" representing the +// client's request for the GetServicesInScope operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See GetServicesInScope for more information on using the GetServicesInScope +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the GetServicesInScopeRequest method. +// req, resp := client.GetServicesInScopeRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/GetServicesInScope +func (c *AuditManager) GetServicesInScopeRequest(input *GetServicesInScopeInput) (req *request.Request, output *GetServicesInScopeOutput) { + op := &request.Operation{ + Name: opGetServicesInScope, + HTTPMethod: "GET", + HTTPPath: "/services", + } + + if input == nil { + input = &GetServicesInScopeInput{} + } + + output = &GetServicesInScopeOutput{} + req = c.newRequest(op, input, output) + return +} + +// GetServicesInScope API operation for AWS Audit Manager. +// +// Returns a list of the in-scope AWS services for the specified assessment. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Audit Manager's +// API operation GetServicesInScope for usage and error information. +// +// Returned Error Types: +// * ValidationException +// The request has invalid or missing parameters. +// +// * InternalServerException +// An internal service error occurred during the processing of your request. +// Try again later. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/GetServicesInScope +func (c *AuditManager) GetServicesInScope(input *GetServicesInScopeInput) (*GetServicesInScopeOutput, error) { + req, out := c.GetServicesInScopeRequest(input) + return out, req.Send() +} + +// GetServicesInScopeWithContext is the same as GetServicesInScope with the addition of +// the ability to pass a context and additional request options. +// +// See GetServicesInScope for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *AuditManager) GetServicesInScopeWithContext(ctx aws.Context, input *GetServicesInScopeInput, opts ...request.Option) (*GetServicesInScopeOutput, error) { + req, out := c.GetServicesInScopeRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opGetSettings = "GetSettings" + +// GetSettingsRequest generates a "aws/request.Request" representing the +// client's request for the GetSettings operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See GetSettings for more information on using the GetSettings +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the GetSettingsRequest method. +// req, resp := client.GetSettingsRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/GetSettings +func (c *AuditManager) GetSettingsRequest(input *GetSettingsInput) (req *request.Request, output *GetSettingsOutput) { + op := &request.Operation{ + Name: opGetSettings, + HTTPMethod: "GET", + HTTPPath: "/settings/{attribute}", + } + + if input == nil { + input = &GetSettingsInput{} + } + + output = &GetSettingsOutput{} + req = c.newRequest(op, input, output) + return +} + +// GetSettings API operation for AWS Audit Manager. +// +// Returns the settings for the specified AWS account. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Audit Manager's +// API operation GetSettings for usage and error information. +// +// Returned Error Types: +// * AccessDeniedException +// You do not have sufficient access to perform this action. +// +// * InternalServerException +// An internal service error occurred during the processing of your request. +// Try again later. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/GetSettings +func (c *AuditManager) GetSettings(input *GetSettingsInput) (*GetSettingsOutput, error) { + req, out := c.GetSettingsRequest(input) + return out, req.Send() +} + +// GetSettingsWithContext is the same as GetSettings with the addition of +// the ability to pass a context and additional request options. +// +// See GetSettings for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *AuditManager) GetSettingsWithContext(ctx aws.Context, input *GetSettingsInput, opts ...request.Option) (*GetSettingsOutput, error) { + req, out := c.GetSettingsRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opListAssessmentFrameworks = "ListAssessmentFrameworks" + +// ListAssessmentFrameworksRequest generates a "aws/request.Request" representing the +// client's request for the ListAssessmentFrameworks operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See ListAssessmentFrameworks for more information on using the ListAssessmentFrameworks +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the ListAssessmentFrameworksRequest method. +// req, resp := client.ListAssessmentFrameworksRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/ListAssessmentFrameworks +func (c *AuditManager) ListAssessmentFrameworksRequest(input *ListAssessmentFrameworksInput) (req *request.Request, output *ListAssessmentFrameworksOutput) { + op := &request.Operation{ + Name: opListAssessmentFrameworks, + HTTPMethod: "GET", + HTTPPath: "/assessmentFrameworks", + Paginator: &request.Paginator{ + InputTokens: []string{"nextToken"}, + OutputTokens: []string{"nextToken"}, + LimitToken: "maxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &ListAssessmentFrameworksInput{} + } + + output = &ListAssessmentFrameworksOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListAssessmentFrameworks API operation for AWS Audit Manager. +// +// Returns a list of the frameworks available in the AWS Audit Manager framework +// library. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Audit Manager's +// API operation ListAssessmentFrameworks for usage and error information. +// +// Returned Error Types: +// * ValidationException +// The request has invalid or missing parameters. +// +// * AccessDeniedException +// You do not have sufficient access to perform this action. +// +// * InternalServerException +// An internal service error occurred during the processing of your request. +// Try again later. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/ListAssessmentFrameworks +func (c *AuditManager) ListAssessmentFrameworks(input *ListAssessmentFrameworksInput) (*ListAssessmentFrameworksOutput, error) { + req, out := c.ListAssessmentFrameworksRequest(input) + return out, req.Send() +} + +// ListAssessmentFrameworksWithContext is the same as ListAssessmentFrameworks with the addition of +// the ability to pass a context and additional request options. +// +// See ListAssessmentFrameworks for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *AuditManager) ListAssessmentFrameworksWithContext(ctx aws.Context, input *ListAssessmentFrameworksInput, opts ...request.Option) (*ListAssessmentFrameworksOutput, error) { + req, out := c.ListAssessmentFrameworksRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// ListAssessmentFrameworksPages iterates over the pages of a ListAssessmentFrameworks operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListAssessmentFrameworks method for more information on how to use this operation. +// +// Note: This operation can generate multiple requests to a service. +// +// // Example iterating over at most 3 pages of a ListAssessmentFrameworks operation. +// pageNum := 0 +// err := client.ListAssessmentFrameworksPages(params, +// func(page *auditmanager.ListAssessmentFrameworksOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *AuditManager) ListAssessmentFrameworksPages(input *ListAssessmentFrameworksInput, fn func(*ListAssessmentFrameworksOutput, bool) bool) error { + return c.ListAssessmentFrameworksPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// ListAssessmentFrameworksPagesWithContext same as ListAssessmentFrameworksPages except +// it takes a Context and allows setting request options on the pages. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *AuditManager) ListAssessmentFrameworksPagesWithContext(ctx aws.Context, input *ListAssessmentFrameworksInput, fn func(*ListAssessmentFrameworksOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListAssessmentFrameworksInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListAssessmentFrameworksRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListAssessmentFrameworksOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + +const opListAssessmentReports = "ListAssessmentReports" + +// ListAssessmentReportsRequest generates a "aws/request.Request" representing the +// client's request for the ListAssessmentReports operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See ListAssessmentReports for more information on using the ListAssessmentReports +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the ListAssessmentReportsRequest method. +// req, resp := client.ListAssessmentReportsRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/ListAssessmentReports +func (c *AuditManager) ListAssessmentReportsRequest(input *ListAssessmentReportsInput) (req *request.Request, output *ListAssessmentReportsOutput) { + op := &request.Operation{ + Name: opListAssessmentReports, + HTTPMethod: "GET", + HTTPPath: "/assessmentReports", + Paginator: &request.Paginator{ + InputTokens: []string{"nextToken"}, + OutputTokens: []string{"nextToken"}, + LimitToken: "maxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &ListAssessmentReportsInput{} + } + + output = &ListAssessmentReportsOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListAssessmentReports API operation for AWS Audit Manager. +// +// Returns a list of assessment reports created in AWS Audit Manager. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Audit Manager's +// API operation ListAssessmentReports for usage and error information. +// +// Returned Error Types: +// * ValidationException +// The request has invalid or missing parameters. +// +// * AccessDeniedException +// You do not have sufficient access to perform this action. +// +// * InternalServerException +// An internal service error occurred during the processing of your request. +// Try again later. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/ListAssessmentReports +func (c *AuditManager) ListAssessmentReports(input *ListAssessmentReportsInput) (*ListAssessmentReportsOutput, error) { + req, out := c.ListAssessmentReportsRequest(input) + return out, req.Send() +} + +// ListAssessmentReportsWithContext is the same as ListAssessmentReports with the addition of +// the ability to pass a context and additional request options. +// +// See ListAssessmentReports for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *AuditManager) ListAssessmentReportsWithContext(ctx aws.Context, input *ListAssessmentReportsInput, opts ...request.Option) (*ListAssessmentReportsOutput, error) { + req, out := c.ListAssessmentReportsRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// ListAssessmentReportsPages iterates over the pages of a ListAssessmentReports operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListAssessmentReports method for more information on how to use this operation. +// +// Note: This operation can generate multiple requests to a service. +// +// // Example iterating over at most 3 pages of a ListAssessmentReports operation. +// pageNum := 0 +// err := client.ListAssessmentReportsPages(params, +// func(page *auditmanager.ListAssessmentReportsOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *AuditManager) ListAssessmentReportsPages(input *ListAssessmentReportsInput, fn func(*ListAssessmentReportsOutput, bool) bool) error { + return c.ListAssessmentReportsPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// ListAssessmentReportsPagesWithContext same as ListAssessmentReportsPages except +// it takes a Context and allows setting request options on the pages. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *AuditManager) ListAssessmentReportsPagesWithContext(ctx aws.Context, input *ListAssessmentReportsInput, fn func(*ListAssessmentReportsOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListAssessmentReportsInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListAssessmentReportsRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListAssessmentReportsOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + +const opListAssessments = "ListAssessments" + +// ListAssessmentsRequest generates a "aws/request.Request" representing the +// client's request for the ListAssessments operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See ListAssessments for more information on using the ListAssessments +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the ListAssessmentsRequest method. +// req, resp := client.ListAssessmentsRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/ListAssessments +func (c *AuditManager) ListAssessmentsRequest(input *ListAssessmentsInput) (req *request.Request, output *ListAssessmentsOutput) { + op := &request.Operation{ + Name: opListAssessments, + HTTPMethod: "GET", + HTTPPath: "/assessments", + Paginator: &request.Paginator{ + InputTokens: []string{"nextToken"}, + OutputTokens: []string{"nextToken"}, + LimitToken: "maxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &ListAssessmentsInput{} + } + + output = &ListAssessmentsOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListAssessments API operation for AWS Audit Manager. +// +// Returns a list of current and past assessments from AWS Audit Manager. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Audit Manager's +// API operation ListAssessments for usage and error information. +// +// Returned Error Types: +// * AccessDeniedException +// You do not have sufficient access to perform this action. +// +// * ValidationException +// The request has invalid or missing parameters. +// +// * InternalServerException +// An internal service error occurred during the processing of your request. +// Try again later. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/ListAssessments +func (c *AuditManager) ListAssessments(input *ListAssessmentsInput) (*ListAssessmentsOutput, error) { + req, out := c.ListAssessmentsRequest(input) + return out, req.Send() +} + +// ListAssessmentsWithContext is the same as ListAssessments with the addition of +// the ability to pass a context and additional request options. +// +// See ListAssessments for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *AuditManager) ListAssessmentsWithContext(ctx aws.Context, input *ListAssessmentsInput, opts ...request.Option) (*ListAssessmentsOutput, error) { + req, out := c.ListAssessmentsRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// ListAssessmentsPages iterates over the pages of a ListAssessments operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListAssessments method for more information on how to use this operation. +// +// Note: This operation can generate multiple requests to a service. +// +// // Example iterating over at most 3 pages of a ListAssessments operation. +// pageNum := 0 +// err := client.ListAssessmentsPages(params, +// func(page *auditmanager.ListAssessmentsOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *AuditManager) ListAssessmentsPages(input *ListAssessmentsInput, fn func(*ListAssessmentsOutput, bool) bool) error { + return c.ListAssessmentsPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// ListAssessmentsPagesWithContext same as ListAssessmentsPages except +// it takes a Context and allows setting request options on the pages. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *AuditManager) ListAssessmentsPagesWithContext(ctx aws.Context, input *ListAssessmentsInput, fn func(*ListAssessmentsOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListAssessmentsInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListAssessmentsRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListAssessmentsOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + +const opListControls = "ListControls" + +// ListControlsRequest generates a "aws/request.Request" representing the +// client's request for the ListControls operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See ListControls for more information on using the ListControls +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the ListControlsRequest method. +// req, resp := client.ListControlsRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/ListControls +func (c *AuditManager) ListControlsRequest(input *ListControlsInput) (req *request.Request, output *ListControlsOutput) { + op := &request.Operation{ + Name: opListControls, + HTTPMethod: "GET", + HTTPPath: "/controls", + Paginator: &request.Paginator{ + InputTokens: []string{"nextToken"}, + OutputTokens: []string{"nextToken"}, + LimitToken: "maxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &ListControlsInput{} + } + + output = &ListControlsOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListControls API operation for AWS Audit Manager. +// +// Returns a list of controls from AWS Audit Manager. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Audit Manager's +// API operation ListControls for usage and error information. +// +// Returned Error Types: +// * AccessDeniedException +// You do not have sufficient access to perform this action. +// +// * ValidationException +// The request has invalid or missing parameters. +// +// * InternalServerException +// An internal service error occurred during the processing of your request. +// Try again later. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/ListControls +func (c *AuditManager) ListControls(input *ListControlsInput) (*ListControlsOutput, error) { + req, out := c.ListControlsRequest(input) + return out, req.Send() +} + +// ListControlsWithContext is the same as ListControls with the addition of +// the ability to pass a context and additional request options. +// +// See ListControls for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *AuditManager) ListControlsWithContext(ctx aws.Context, input *ListControlsInput, opts ...request.Option) (*ListControlsOutput, error) { + req, out := c.ListControlsRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// ListControlsPages iterates over the pages of a ListControls operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListControls method for more information on how to use this operation. +// +// Note: This operation can generate multiple requests to a service. +// +// // Example iterating over at most 3 pages of a ListControls operation. +// pageNum := 0 +// err := client.ListControlsPages(params, +// func(page *auditmanager.ListControlsOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *AuditManager) ListControlsPages(input *ListControlsInput, fn func(*ListControlsOutput, bool) bool) error { + return c.ListControlsPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// ListControlsPagesWithContext same as ListControlsPages except +// it takes a Context and allows setting request options on the pages. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *AuditManager) ListControlsPagesWithContext(ctx aws.Context, input *ListControlsInput, fn func(*ListControlsOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListControlsInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListControlsRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListControlsOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + +const opListKeywordsForDataSource = "ListKeywordsForDataSource" + +// ListKeywordsForDataSourceRequest generates a "aws/request.Request" representing the +// client's request for the ListKeywordsForDataSource operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See ListKeywordsForDataSource for more information on using the ListKeywordsForDataSource +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the ListKeywordsForDataSourceRequest method. +// req, resp := client.ListKeywordsForDataSourceRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/ListKeywordsForDataSource +func (c *AuditManager) ListKeywordsForDataSourceRequest(input *ListKeywordsForDataSourceInput) (req *request.Request, output *ListKeywordsForDataSourceOutput) { + op := &request.Operation{ + Name: opListKeywordsForDataSource, + HTTPMethod: "GET", + HTTPPath: "/dataSourceKeywords", + Paginator: &request.Paginator{ + InputTokens: []string{"nextToken"}, + OutputTokens: []string{"nextToken"}, + LimitToken: "maxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &ListKeywordsForDataSourceInput{} + } + + output = &ListKeywordsForDataSourceOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListKeywordsForDataSource API operation for AWS Audit Manager. +// +// Returns a list of keywords that pre-mapped to the specified control data +// source. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Audit Manager's +// API operation ListKeywordsForDataSource for usage and error information. +// +// Returned Error Types: +// * AccessDeniedException +// You do not have sufficient access to perform this action. +// +// * ValidationException +// The request has invalid or missing parameters. +// +// * InternalServerException +// An internal service error occurred during the processing of your request. +// Try again later. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/ListKeywordsForDataSource +func (c *AuditManager) ListKeywordsForDataSource(input *ListKeywordsForDataSourceInput) (*ListKeywordsForDataSourceOutput, error) { + req, out := c.ListKeywordsForDataSourceRequest(input) + return out, req.Send() +} + +// ListKeywordsForDataSourceWithContext is the same as ListKeywordsForDataSource with the addition of +// the ability to pass a context and additional request options. +// +// See ListKeywordsForDataSource for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *AuditManager) ListKeywordsForDataSourceWithContext(ctx aws.Context, input *ListKeywordsForDataSourceInput, opts ...request.Option) (*ListKeywordsForDataSourceOutput, error) { + req, out := c.ListKeywordsForDataSourceRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// ListKeywordsForDataSourcePages iterates over the pages of a ListKeywordsForDataSource operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListKeywordsForDataSource method for more information on how to use this operation. +// +// Note: This operation can generate multiple requests to a service. +// +// // Example iterating over at most 3 pages of a ListKeywordsForDataSource operation. +// pageNum := 0 +// err := client.ListKeywordsForDataSourcePages(params, +// func(page *auditmanager.ListKeywordsForDataSourceOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *AuditManager) ListKeywordsForDataSourcePages(input *ListKeywordsForDataSourceInput, fn func(*ListKeywordsForDataSourceOutput, bool) bool) error { + return c.ListKeywordsForDataSourcePagesWithContext(aws.BackgroundContext(), input, fn) +} + +// ListKeywordsForDataSourcePagesWithContext same as ListKeywordsForDataSourcePages except +// it takes a Context and allows setting request options on the pages. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *AuditManager) ListKeywordsForDataSourcePagesWithContext(ctx aws.Context, input *ListKeywordsForDataSourceInput, fn func(*ListKeywordsForDataSourceOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListKeywordsForDataSourceInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListKeywordsForDataSourceRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListKeywordsForDataSourceOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + +const opListNotifications = "ListNotifications" + +// ListNotificationsRequest generates a "aws/request.Request" representing the +// client's request for the ListNotifications operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See ListNotifications for more information on using the ListNotifications +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the ListNotificationsRequest method. +// req, resp := client.ListNotificationsRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/ListNotifications +func (c *AuditManager) ListNotificationsRequest(input *ListNotificationsInput) (req *request.Request, output *ListNotificationsOutput) { + op := &request.Operation{ + Name: opListNotifications, + HTTPMethod: "GET", + HTTPPath: "/notifications", + Paginator: &request.Paginator{ + InputTokens: []string{"nextToken"}, + OutputTokens: []string{"nextToken"}, + LimitToken: "maxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &ListNotificationsInput{} + } + + output = &ListNotificationsOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListNotifications API operation for AWS Audit Manager. +// +// Returns a list of all AWS Audit Manager notifications. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Audit Manager's +// API operation ListNotifications for usage and error information. +// +// Returned Error Types: +// * AccessDeniedException +// You do not have sufficient access to perform this action. +// +// * ValidationException +// The request has invalid or missing parameters. +// +// * InternalServerException +// An internal service error occurred during the processing of your request. +// Try again later. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/ListNotifications +func (c *AuditManager) ListNotifications(input *ListNotificationsInput) (*ListNotificationsOutput, error) { + req, out := c.ListNotificationsRequest(input) + return out, req.Send() +} + +// ListNotificationsWithContext is the same as ListNotifications with the addition of +// the ability to pass a context and additional request options. +// +// See ListNotifications for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *AuditManager) ListNotificationsWithContext(ctx aws.Context, input *ListNotificationsInput, opts ...request.Option) (*ListNotificationsOutput, error) { + req, out := c.ListNotificationsRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// ListNotificationsPages iterates over the pages of a ListNotifications operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListNotifications method for more information on how to use this operation. +// +// Note: This operation can generate multiple requests to a service. +// +// // Example iterating over at most 3 pages of a ListNotifications operation. +// pageNum := 0 +// err := client.ListNotificationsPages(params, +// func(page *auditmanager.ListNotificationsOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *AuditManager) ListNotificationsPages(input *ListNotificationsInput, fn func(*ListNotificationsOutput, bool) bool) error { + return c.ListNotificationsPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// ListNotificationsPagesWithContext same as ListNotificationsPages except +// it takes a Context and allows setting request options on the pages. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *AuditManager) ListNotificationsPagesWithContext(ctx aws.Context, input *ListNotificationsInput, fn func(*ListNotificationsOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListNotificationsInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListNotificationsRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListNotificationsOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + +const opListTagsForResource = "ListTagsForResource" + +// ListTagsForResourceRequest generates a "aws/request.Request" representing the +// client's request for the ListTagsForResource operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See ListTagsForResource for more information on using the ListTagsForResource +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the ListTagsForResourceRequest method. +// req, resp := client.ListTagsForResourceRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/ListTagsForResource +func (c *AuditManager) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput) { + op := &request.Operation{ + Name: opListTagsForResource, + HTTPMethod: "GET", + HTTPPath: "/tags/{resourceArn}", + } + + if input == nil { + input = &ListTagsForResourceInput{} + } + + output = &ListTagsForResourceOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListTagsForResource API operation for AWS Audit Manager. +// +// Returns a list of tags for the specified resource in AWS Audit Manager. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Audit Manager's +// API operation ListTagsForResource for usage and error information. +// +// Returned Error Types: +// * InternalServerException +// An internal service error occurred during the processing of your request. +// Try again later. +// +// * ValidationException +// The request has invalid or missing parameters. +// +// * ResourceNotFoundException +// The resource specified in the request cannot be found. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/ListTagsForResource +func (c *AuditManager) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error) { + req, out := c.ListTagsForResourceRequest(input) + return out, req.Send() +} + +// ListTagsForResourceWithContext is the same as ListTagsForResource with the addition of +// the ability to pass a context and additional request options. +// +// See ListTagsForResource for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *AuditManager) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error) { + req, out := c.ListTagsForResourceRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opRegisterAccount = "RegisterAccount" + +// RegisterAccountRequest generates a "aws/request.Request" representing the +// client's request for the RegisterAccount operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See RegisterAccount for more information on using the RegisterAccount +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the RegisterAccountRequest method. +// req, resp := client.RegisterAccountRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/RegisterAccount +func (c *AuditManager) RegisterAccountRequest(input *RegisterAccountInput) (req *request.Request, output *RegisterAccountOutput) { + op := &request.Operation{ + Name: opRegisterAccount, + HTTPMethod: "POST", + HTTPPath: "/account/registerAccount", + } + + if input == nil { + input = &RegisterAccountInput{} + } + + output = &RegisterAccountOutput{} + req = c.newRequest(op, input, output) + return +} + +// RegisterAccount API operation for AWS Audit Manager. +// +// Enables AWS Audit Manager for the specified AWS account. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Audit Manager's +// API operation RegisterAccount for usage and error information. +// +// Returned Error Types: +// * ValidationException +// The request has invalid or missing parameters. +// +// * AccessDeniedException +// You do not have sufficient access to perform this action. +// +// * InternalServerException +// An internal service error occurred during the processing of your request. +// Try again later. +// +// * ResourceNotFoundException +// The resource specified in the request cannot be found. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/RegisterAccount +func (c *AuditManager) RegisterAccount(input *RegisterAccountInput) (*RegisterAccountOutput, error) { + req, out := c.RegisterAccountRequest(input) + return out, req.Send() +} + +// RegisterAccountWithContext is the same as RegisterAccount with the addition of +// the ability to pass a context and additional request options. +// +// See RegisterAccount for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *AuditManager) RegisterAccountWithContext(ctx aws.Context, input *RegisterAccountInput, opts ...request.Option) (*RegisterAccountOutput, error) { + req, out := c.RegisterAccountRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opRegisterOrganizationAdminAccount = "RegisterOrganizationAdminAccount" + +// RegisterOrganizationAdminAccountRequest generates a "aws/request.Request" representing the +// client's request for the RegisterOrganizationAdminAccount operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See RegisterOrganizationAdminAccount for more information on using the RegisterOrganizationAdminAccount +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the RegisterOrganizationAdminAccountRequest method. +// req, resp := client.RegisterOrganizationAdminAccountRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/RegisterOrganizationAdminAccount +func (c *AuditManager) RegisterOrganizationAdminAccountRequest(input *RegisterOrganizationAdminAccountInput) (req *request.Request, output *RegisterOrganizationAdminAccountOutput) { + op := &request.Operation{ + Name: opRegisterOrganizationAdminAccount, + HTTPMethod: "POST", + HTTPPath: "/account/registerOrganizationAdminAccount", + } + + if input == nil { + input = &RegisterOrganizationAdminAccountInput{} + } + + output = &RegisterOrganizationAdminAccountOutput{} + req = c.newRequest(op, input, output) + return +} + +// RegisterOrganizationAdminAccount API operation for AWS Audit Manager. +// +// Enables an AWS account within the organization as the delegated administrator +// for AWS Audit Manager. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Audit Manager's +// API operation RegisterOrganizationAdminAccount for usage and error information. +// +// Returned Error Types: +// * ValidationException +// The request has invalid or missing parameters. +// +// * AccessDeniedException +// You do not have sufficient access to perform this action. +// +// * InternalServerException +// An internal service error occurred during the processing of your request. +// Try again later. +// +// * ResourceNotFoundException +// The resource specified in the request cannot be found. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/RegisterOrganizationAdminAccount +func (c *AuditManager) RegisterOrganizationAdminAccount(input *RegisterOrganizationAdminAccountInput) (*RegisterOrganizationAdminAccountOutput, error) { + req, out := c.RegisterOrganizationAdminAccountRequest(input) + return out, req.Send() +} + +// RegisterOrganizationAdminAccountWithContext is the same as RegisterOrganizationAdminAccount with the addition of +// the ability to pass a context and additional request options. +// +// See RegisterOrganizationAdminAccount for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *AuditManager) RegisterOrganizationAdminAccountWithContext(ctx aws.Context, input *RegisterOrganizationAdminAccountInput, opts ...request.Option) (*RegisterOrganizationAdminAccountOutput, error) { + req, out := c.RegisterOrganizationAdminAccountRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opTagResource = "TagResource" + +// TagResourceRequest generates a "aws/request.Request" representing the +// client's request for the TagResource operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See TagResource for more information on using the TagResource +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the TagResourceRequest method. +// req, resp := client.TagResourceRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/TagResource +func (c *AuditManager) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput) { + op := &request.Operation{ + Name: opTagResource, + HTTPMethod: "POST", + HTTPPath: "/tags/{resourceArn}", + } + + if input == nil { + input = &TagResourceInput{} + } + + output = &TagResourceOutput{} + req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(restjson.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) + return +} + +// TagResource API operation for AWS Audit Manager. +// +// Tags the specified resource in AWS Audit Manager. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Audit Manager's +// API operation TagResource for usage and error information. +// +// Returned Error Types: +// * InternalServerException +// An internal service error occurred during the processing of your request. +// Try again later. +// +// * ValidationException +// The request has invalid or missing parameters. +// +// * ResourceNotFoundException +// The resource specified in the request cannot be found. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/TagResource +func (c *AuditManager) TagResource(input *TagResourceInput) (*TagResourceOutput, error) { + req, out := c.TagResourceRequest(input) + return out, req.Send() +} + +// TagResourceWithContext is the same as TagResource with the addition of +// the ability to pass a context and additional request options. +// +// See TagResource for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *AuditManager) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error) { + req, out := c.TagResourceRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opUntagResource = "UntagResource" + +// UntagResourceRequest generates a "aws/request.Request" representing the +// client's request for the UntagResource operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See UntagResource for more information on using the UntagResource +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the UntagResourceRequest method. +// req, resp := client.UntagResourceRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/UntagResource +func (c *AuditManager) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput) { + op := &request.Operation{ + Name: opUntagResource, + HTTPMethod: "DELETE", + HTTPPath: "/tags/{resourceArn}", + } + + if input == nil { + input = &UntagResourceInput{} + } + + output = &UntagResourceOutput{} + req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(restjson.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) + return +} + +// UntagResource API operation for AWS Audit Manager. +// +// Removes a tag from a resource in AWS Audit Manager. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Audit Manager's +// API operation UntagResource for usage and error information. +// +// Returned Error Types: +// * InternalServerException +// An internal service error occurred during the processing of your request. +// Try again later. +// +// * ValidationException +// The request has invalid or missing parameters. +// +// * ResourceNotFoundException +// The resource specified in the request cannot be found. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/UntagResource +func (c *AuditManager) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error) { + req, out := c.UntagResourceRequest(input) + return out, req.Send() +} + +// UntagResourceWithContext is the same as UntagResource with the addition of +// the ability to pass a context and additional request options. +// +// See UntagResource for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *AuditManager) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error) { + req, out := c.UntagResourceRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opUpdateAssessment = "UpdateAssessment" + +// UpdateAssessmentRequest generates a "aws/request.Request" representing the +// client's request for the UpdateAssessment operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See UpdateAssessment for more information on using the UpdateAssessment +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the UpdateAssessmentRequest method. +// req, resp := client.UpdateAssessmentRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/UpdateAssessment +func (c *AuditManager) UpdateAssessmentRequest(input *UpdateAssessmentInput) (req *request.Request, output *UpdateAssessmentOutput) { + op := &request.Operation{ + Name: opUpdateAssessment, + HTTPMethod: "PUT", + HTTPPath: "/assessments/{assessmentId}", + } + + if input == nil { + input = &UpdateAssessmentInput{} + } + + output = &UpdateAssessmentOutput{} + req = c.newRequest(op, input, output) + return +} + +// UpdateAssessment API operation for AWS Audit Manager. +// +// Edits an AWS Audit Manager assessment. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Audit Manager's +// API operation UpdateAssessment for usage and error information. +// +// Returned Error Types: +// * ResourceNotFoundException +// The resource specified in the request cannot be found. +// +// * ValidationException +// The request has invalid or missing parameters. +// +// * AccessDeniedException +// You do not have sufficient access to perform this action. +// +// * InternalServerException +// An internal service error occurred during the processing of your request. +// Try again later. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/UpdateAssessment +func (c *AuditManager) UpdateAssessment(input *UpdateAssessmentInput) (*UpdateAssessmentOutput, error) { + req, out := c.UpdateAssessmentRequest(input) + return out, req.Send() +} + +// UpdateAssessmentWithContext is the same as UpdateAssessment with the addition of +// the ability to pass a context and additional request options. +// +// See UpdateAssessment for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *AuditManager) UpdateAssessmentWithContext(ctx aws.Context, input *UpdateAssessmentInput, opts ...request.Option) (*UpdateAssessmentOutput, error) { + req, out := c.UpdateAssessmentRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opUpdateAssessmentControl = "UpdateAssessmentControl" + +// UpdateAssessmentControlRequest generates a "aws/request.Request" representing the +// client's request for the UpdateAssessmentControl operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See UpdateAssessmentControl for more information on using the UpdateAssessmentControl +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the UpdateAssessmentControlRequest method. +// req, resp := client.UpdateAssessmentControlRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/UpdateAssessmentControl +func (c *AuditManager) UpdateAssessmentControlRequest(input *UpdateAssessmentControlInput) (req *request.Request, output *UpdateAssessmentControlOutput) { + op := &request.Operation{ + Name: opUpdateAssessmentControl, + HTTPMethod: "PUT", + HTTPPath: "/assessments/{assessmentId}/controlSets/{controlSetId}/controls/{controlId}", + } + + if input == nil { + input = &UpdateAssessmentControlInput{} + } + + output = &UpdateAssessmentControlOutput{} + req = c.newRequest(op, input, output) + return +} + +// UpdateAssessmentControl API operation for AWS Audit Manager. +// +// Updates a control within an assessment in AWS Audit Manager. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Audit Manager's +// API operation UpdateAssessmentControl for usage and error information. +// +// Returned Error Types: +// * ResourceNotFoundException +// The resource specified in the request cannot be found. +// +// * ValidationException +// The request has invalid or missing parameters. +// +// * AccessDeniedException +// You do not have sufficient access to perform this action. +// +// * InternalServerException +// An internal service error occurred during the processing of your request. +// Try again later. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/UpdateAssessmentControl +func (c *AuditManager) UpdateAssessmentControl(input *UpdateAssessmentControlInput) (*UpdateAssessmentControlOutput, error) { + req, out := c.UpdateAssessmentControlRequest(input) + return out, req.Send() +} + +// UpdateAssessmentControlWithContext is the same as UpdateAssessmentControl with the addition of +// the ability to pass a context and additional request options. +// +// See UpdateAssessmentControl for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *AuditManager) UpdateAssessmentControlWithContext(ctx aws.Context, input *UpdateAssessmentControlInput, opts ...request.Option) (*UpdateAssessmentControlOutput, error) { + req, out := c.UpdateAssessmentControlRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opUpdateAssessmentControlSetStatus = "UpdateAssessmentControlSetStatus" + +// UpdateAssessmentControlSetStatusRequest generates a "aws/request.Request" representing the +// client's request for the UpdateAssessmentControlSetStatus operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See UpdateAssessmentControlSetStatus for more information on using the UpdateAssessmentControlSetStatus +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the UpdateAssessmentControlSetStatusRequest method. +// req, resp := client.UpdateAssessmentControlSetStatusRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/UpdateAssessmentControlSetStatus +func (c *AuditManager) UpdateAssessmentControlSetStatusRequest(input *UpdateAssessmentControlSetStatusInput) (req *request.Request, output *UpdateAssessmentControlSetStatusOutput) { + op := &request.Operation{ + Name: opUpdateAssessmentControlSetStatus, + HTTPMethod: "PUT", + HTTPPath: "/assessments/{assessmentId}/controlSets/{controlSetId}/status", + } + + if input == nil { + input = &UpdateAssessmentControlSetStatusInput{} + } + + output = &UpdateAssessmentControlSetStatusOutput{} + req = c.newRequest(op, input, output) + return +} + +// UpdateAssessmentControlSetStatus API operation for AWS Audit Manager. +// +// Updates the status of a control set in an AWS Audit Manager assessment. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Audit Manager's +// API operation UpdateAssessmentControlSetStatus for usage and error information. +// +// Returned Error Types: +// * ResourceNotFoundException +// The resource specified in the request cannot be found. +// +// * ValidationException +// The request has invalid or missing parameters. +// +// * AccessDeniedException +// You do not have sufficient access to perform this action. +// +// * InternalServerException +// An internal service error occurred during the processing of your request. +// Try again later. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/UpdateAssessmentControlSetStatus +func (c *AuditManager) UpdateAssessmentControlSetStatus(input *UpdateAssessmentControlSetStatusInput) (*UpdateAssessmentControlSetStatusOutput, error) { + req, out := c.UpdateAssessmentControlSetStatusRequest(input) + return out, req.Send() +} + +// UpdateAssessmentControlSetStatusWithContext is the same as UpdateAssessmentControlSetStatus with the addition of +// the ability to pass a context and additional request options. +// +// See UpdateAssessmentControlSetStatus for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *AuditManager) UpdateAssessmentControlSetStatusWithContext(ctx aws.Context, input *UpdateAssessmentControlSetStatusInput, opts ...request.Option) (*UpdateAssessmentControlSetStatusOutput, error) { + req, out := c.UpdateAssessmentControlSetStatusRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opUpdateAssessmentFramework = "UpdateAssessmentFramework" + +// UpdateAssessmentFrameworkRequest generates a "aws/request.Request" representing the +// client's request for the UpdateAssessmentFramework operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See UpdateAssessmentFramework for more information on using the UpdateAssessmentFramework +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the UpdateAssessmentFrameworkRequest method. +// req, resp := client.UpdateAssessmentFrameworkRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/UpdateAssessmentFramework +func (c *AuditManager) UpdateAssessmentFrameworkRequest(input *UpdateAssessmentFrameworkInput) (req *request.Request, output *UpdateAssessmentFrameworkOutput) { + op := &request.Operation{ + Name: opUpdateAssessmentFramework, + HTTPMethod: "PUT", + HTTPPath: "/assessmentFrameworks/{frameworkId}", + } + + if input == nil { + input = &UpdateAssessmentFrameworkInput{} + } + + output = &UpdateAssessmentFrameworkOutput{} + req = c.newRequest(op, input, output) + return +} + +// UpdateAssessmentFramework API operation for AWS Audit Manager. +// +// Updates a custom framework in AWS Audit Manager. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Audit Manager's +// API operation UpdateAssessmentFramework for usage and error information. +// +// Returned Error Types: +// * ResourceNotFoundException +// The resource specified in the request cannot be found. +// +// * ValidationException +// The request has invalid or missing parameters. +// +// * AccessDeniedException +// You do not have sufficient access to perform this action. +// +// * InternalServerException +// An internal service error occurred during the processing of your request. +// Try again later. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/UpdateAssessmentFramework +func (c *AuditManager) UpdateAssessmentFramework(input *UpdateAssessmentFrameworkInput) (*UpdateAssessmentFrameworkOutput, error) { + req, out := c.UpdateAssessmentFrameworkRequest(input) + return out, req.Send() +} + +// UpdateAssessmentFrameworkWithContext is the same as UpdateAssessmentFramework with the addition of +// the ability to pass a context and additional request options. +// +// See UpdateAssessmentFramework for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *AuditManager) UpdateAssessmentFrameworkWithContext(ctx aws.Context, input *UpdateAssessmentFrameworkInput, opts ...request.Option) (*UpdateAssessmentFrameworkOutput, error) { + req, out := c.UpdateAssessmentFrameworkRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opUpdateAssessmentStatus = "UpdateAssessmentStatus" + +// UpdateAssessmentStatusRequest generates a "aws/request.Request" representing the +// client's request for the UpdateAssessmentStatus operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See UpdateAssessmentStatus for more information on using the UpdateAssessmentStatus +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the UpdateAssessmentStatusRequest method. +// req, resp := client.UpdateAssessmentStatusRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/UpdateAssessmentStatus +func (c *AuditManager) UpdateAssessmentStatusRequest(input *UpdateAssessmentStatusInput) (req *request.Request, output *UpdateAssessmentStatusOutput) { + op := &request.Operation{ + Name: opUpdateAssessmentStatus, + HTTPMethod: "PUT", + HTTPPath: "/assessments/{assessmentId}/status", + } + + if input == nil { + input = &UpdateAssessmentStatusInput{} + } + + output = &UpdateAssessmentStatusOutput{} + req = c.newRequest(op, input, output) + return +} + +// UpdateAssessmentStatus API operation for AWS Audit Manager. +// +// Updates the status of an assessment in AWS Audit Manager. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Audit Manager's +// API operation UpdateAssessmentStatus for usage and error information. +// +// Returned Error Types: +// * ResourceNotFoundException +// The resource specified in the request cannot be found. +// +// * ValidationException +// The request has invalid or missing parameters. +// +// * AccessDeniedException +// You do not have sufficient access to perform this action. +// +// * InternalServerException +// An internal service error occurred during the processing of your request. +// Try again later. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/UpdateAssessmentStatus +func (c *AuditManager) UpdateAssessmentStatus(input *UpdateAssessmentStatusInput) (*UpdateAssessmentStatusOutput, error) { + req, out := c.UpdateAssessmentStatusRequest(input) + return out, req.Send() +} + +// UpdateAssessmentStatusWithContext is the same as UpdateAssessmentStatus with the addition of +// the ability to pass a context and additional request options. +// +// See UpdateAssessmentStatus for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *AuditManager) UpdateAssessmentStatusWithContext(ctx aws.Context, input *UpdateAssessmentStatusInput, opts ...request.Option) (*UpdateAssessmentStatusOutput, error) { + req, out := c.UpdateAssessmentStatusRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opUpdateControl = "UpdateControl" + +// UpdateControlRequest generates a "aws/request.Request" representing the +// client's request for the UpdateControl operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See UpdateControl for more information on using the UpdateControl +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the UpdateControlRequest method. +// req, resp := client.UpdateControlRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/UpdateControl +func (c *AuditManager) UpdateControlRequest(input *UpdateControlInput) (req *request.Request, output *UpdateControlOutput) { + op := &request.Operation{ + Name: opUpdateControl, + HTTPMethod: "PUT", + HTTPPath: "/controls/{controlId}", + } + + if input == nil { + input = &UpdateControlInput{} + } + + output = &UpdateControlOutput{} + req = c.newRequest(op, input, output) + return +} + +// UpdateControl API operation for AWS Audit Manager. +// +// Updates a custom control in AWS Audit Manager. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Audit Manager's +// API operation UpdateControl for usage and error information. +// +// Returned Error Types: +// * ResourceNotFoundException +// The resource specified in the request cannot be found. +// +// * ValidationException +// The request has invalid or missing parameters. +// +// * AccessDeniedException +// You do not have sufficient access to perform this action. +// +// * InternalServerException +// An internal service error occurred during the processing of your request. +// Try again later. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/UpdateControl +func (c *AuditManager) UpdateControl(input *UpdateControlInput) (*UpdateControlOutput, error) { + req, out := c.UpdateControlRequest(input) + return out, req.Send() +} + +// UpdateControlWithContext is the same as UpdateControl with the addition of +// the ability to pass a context and additional request options. +// +// See UpdateControl for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *AuditManager) UpdateControlWithContext(ctx aws.Context, input *UpdateControlInput, opts ...request.Option) (*UpdateControlOutput, error) { + req, out := c.UpdateControlRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opUpdateSettings = "UpdateSettings" + +// UpdateSettingsRequest generates a "aws/request.Request" representing the +// client's request for the UpdateSettings operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See UpdateSettings for more information on using the UpdateSettings +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the UpdateSettingsRequest method. +// req, resp := client.UpdateSettingsRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/UpdateSettings +func (c *AuditManager) UpdateSettingsRequest(input *UpdateSettingsInput) (req *request.Request, output *UpdateSettingsOutput) { + op := &request.Operation{ + Name: opUpdateSettings, + HTTPMethod: "PUT", + HTTPPath: "/settings", + } + + if input == nil { + input = &UpdateSettingsInput{} + } + + output = &UpdateSettingsOutput{} + req = c.newRequest(op, input, output) + return +} + +// UpdateSettings API operation for AWS Audit Manager. +// +// Updates AWS Audit Manager settings for the current user account. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Audit Manager's +// API operation UpdateSettings for usage and error information. +// +// Returned Error Types: +// * ValidationException +// The request has invalid or missing parameters. +// +// * AccessDeniedException +// You do not have sufficient access to perform this action. +// +// * InternalServerException +// An internal service error occurred during the processing of your request. +// Try again later. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/UpdateSettings +func (c *AuditManager) UpdateSettings(input *UpdateSettingsInput) (*UpdateSettingsOutput, error) { + req, out := c.UpdateSettingsRequest(input) + return out, req.Send() +} + +// UpdateSettingsWithContext is the same as UpdateSettings with the addition of +// the ability to pass a context and additional request options. +// +// See UpdateSettings for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *AuditManager) UpdateSettingsWithContext(ctx aws.Context, input *UpdateSettingsInput, opts ...request.Option) (*UpdateSettingsOutput, error) { + req, out := c.UpdateSettingsRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opValidateAssessmentReportIntegrity = "ValidateAssessmentReportIntegrity" + +// ValidateAssessmentReportIntegrityRequest generates a "aws/request.Request" representing the +// client's request for the ValidateAssessmentReportIntegrity operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See ValidateAssessmentReportIntegrity for more information on using the ValidateAssessmentReportIntegrity +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the ValidateAssessmentReportIntegrityRequest method. +// req, resp := client.ValidateAssessmentReportIntegrityRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/ValidateAssessmentReportIntegrity +func (c *AuditManager) ValidateAssessmentReportIntegrityRequest(input *ValidateAssessmentReportIntegrityInput) (req *request.Request, output *ValidateAssessmentReportIntegrityOutput) { + op := &request.Operation{ + Name: opValidateAssessmentReportIntegrity, + HTTPMethod: "POST", + HTTPPath: "/assessmentReports/integrity", + } + + if input == nil { + input = &ValidateAssessmentReportIntegrityInput{} + } + + output = &ValidateAssessmentReportIntegrityOutput{} + req = c.newRequest(op, input, output) + return +} + +// ValidateAssessmentReportIntegrity API operation for AWS Audit Manager. +// +// Validates the integrity of an assessment report in AWS Audit Manager. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Audit Manager's +// API operation ValidateAssessmentReportIntegrity for usage and error information. +// +// Returned Error Types: +// * ValidationException +// The request has invalid or missing parameters. +// +// * AccessDeniedException +// You do not have sufficient access to perform this action. +// +// * InternalServerException +// An internal service error occurred during the processing of your request. +// Try again later. +// +// * ResourceNotFoundException +// The resource specified in the request cannot be found. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/ValidateAssessmentReportIntegrity +func (c *AuditManager) ValidateAssessmentReportIntegrity(input *ValidateAssessmentReportIntegrityInput) (*ValidateAssessmentReportIntegrityOutput, error) { + req, out := c.ValidateAssessmentReportIntegrityRequest(input) + return out, req.Send() +} + +// ValidateAssessmentReportIntegrityWithContext is the same as ValidateAssessmentReportIntegrity with the addition of +// the ability to pass a context and additional request options. +// +// See ValidateAssessmentReportIntegrity for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *AuditManager) ValidateAssessmentReportIntegrityWithContext(ctx aws.Context, input *ValidateAssessmentReportIntegrityInput, opts ...request.Option) (*ValidateAssessmentReportIntegrityOutput, error) { + req, out := c.ValidateAssessmentReportIntegrityRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// The wrapper of AWS account details, such as account ID, email address, and +// so on. +type AWSAccount struct { + _ struct{} `type:"structure"` + + // The email address associated with the specified AWS account. + EmailAddress *string `locationName:"emailAddress" min:"1" type:"string"` + + // The identifier for the specified AWS account. + Id *string `locationName:"id" min:"12" type:"string"` + + // The name of the specified AWS account. + Name *string `locationName:"name" min:"1" type:"string"` +} + +// String returns the string representation +func (s AWSAccount) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s AWSAccount) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *AWSAccount) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "AWSAccount"} + if s.EmailAddress != nil && len(*s.EmailAddress) < 1 { + invalidParams.Add(request.NewErrParamMinLen("EmailAddress", 1)) + } + if s.Id != nil && len(*s.Id) < 12 { + invalidParams.Add(request.NewErrParamMinLen("Id", 12)) + } + if s.Name != nil && len(*s.Name) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Name", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetEmailAddress sets the EmailAddress field's value. +func (s *AWSAccount) SetEmailAddress(v string) *AWSAccount { + s.EmailAddress = &v + return s +} + +// SetId sets the Id field's value. +func (s *AWSAccount) SetId(v string) *AWSAccount { + s.Id = &v + return s +} + +// SetName sets the Name field's value. +func (s *AWSAccount) SetName(v string) *AWSAccount { + s.Name = &v + return s +} + +// An AWS service such as Amazon S3, AWS CloudTrail, and so on. +type AWSService struct { + _ struct{} `type:"structure"` + + // The name of the AWS service. + ServiceName *string `locationName:"serviceName" min:"1" type:"string"` +} + +// String returns the string representation +func (s AWSService) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s AWSService) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *AWSService) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "AWSService"} + if s.ServiceName != nil && len(*s.ServiceName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ServiceName", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetServiceName sets the ServiceName field's value. +func (s *AWSService) SetServiceName(v string) *AWSService { + s.ServiceName = &v + return s +} + +// You do not have sufficient access to perform this action. +type AccessDeniedException struct { + _ struct{} `type:"structure"` + RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` + + Message_ *string `locationName:"message" type:"string"` +} + +// String returns the string representation +func (s AccessDeniedException) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s AccessDeniedException) GoString() string { + return s.String() +} + +func newErrorAccessDeniedException(v protocol.ResponseMetadata) error { + return &AccessDeniedException{ + RespMetadata: v, + } +} + +// Code returns the exception type name. +func (s *AccessDeniedException) Code() string { + return "AccessDeniedException" +} + +// Message returns the exception's message. +func (s *AccessDeniedException) Message() string { + if s.Message_ != nil { + return *s.Message_ + } + return "" +} + +// OrigErr always returns nil, satisfies awserr.Error interface. +func (s *AccessDeniedException) OrigErr() error { + return nil +} + +func (s *AccessDeniedException) Error() string { + return fmt.Sprintf("%s: %s", s.Code(), s.Message()) +} + +// Status code returns the HTTP status code for the request's response error. +func (s *AccessDeniedException) StatusCode() int { + return s.RespMetadata.StatusCode +} + +// RequestID returns the service's response RequestID for request. +func (s *AccessDeniedException) RequestID() string { + return s.RespMetadata.RequestID +} + +// An entity that defines the scope of audit evidence collected by AWS Audit +// Manager. An AWS Audit Manager assessment is an implementation of an AWS Audit +// Manager framework. +type Assessment struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the assessment. + Arn *string `locationName:"arn" min:"20" type:"string"` + + // The AWS account associated with the assessment. + AwsAccount *AWSAccount `locationName:"awsAccount" type:"structure"` + + // The framework from which the assessment was created. + Framework *AssessmentFramework `locationName:"framework" type:"structure"` + + // The metadata for the specified assessment. + Metadata *AssessmentMetadata `locationName:"metadata" type:"structure"` + + // The tags associated with the assessment. + Tags map[string]*string `locationName:"tags" type:"map"` +} + +// String returns the string representation +func (s Assessment) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s Assessment) GoString() string { + return s.String() +} + +// SetArn sets the Arn field's value. +func (s *Assessment) SetArn(v string) *Assessment { + s.Arn = &v + return s +} + +// SetAwsAccount sets the AwsAccount field's value. +func (s *Assessment) SetAwsAccount(v *AWSAccount) *Assessment { + s.AwsAccount = v + return s +} + +// SetFramework sets the Framework field's value. +func (s *Assessment) SetFramework(v *AssessmentFramework) *Assessment { + s.Framework = v + return s +} + +// SetMetadata sets the Metadata field's value. +func (s *Assessment) SetMetadata(v *AssessmentMetadata) *Assessment { + s.Metadata = v + return s +} + +// SetTags sets the Tags field's value. +func (s *Assessment) SetTags(v map[string]*string) *Assessment { + s.Tags = v + return s +} + +// The control entity that represents a standard or custom control used in an +// AWS Audit Manager assessment. +type AssessmentControl struct { + _ struct{} `type:"structure"` + + // The amount of evidence in the assessment report. + AssessmentReportEvidenceCount *int64 `locationName:"assessmentReportEvidenceCount" type:"integer"` + + // The list of comments attached to the specified control. + Comments []*ControlComment `locationName:"comments" type:"list"` + + // The description of the specified control. + Description *string `locationName:"description" type:"string"` + + // The amount of evidence generated for the control. + EvidenceCount *int64 `locationName:"evidenceCount" type:"integer"` + + // The list of data sources for the specified evidence. + EvidenceSources []*string `locationName:"evidenceSources" type:"list"` + + // The identifier for the specified control. + Id *string `locationName:"id" min:"36" type:"string"` + + // The name of the specified control. + Name *string `locationName:"name" min:"1" type:"string"` + + // The response of the specified control. + Response *string `locationName:"response" type:"string" enum:"ControlResponse"` + + // The status of the specified control. + Status *string `locationName:"status" type:"string" enum:"ControlStatus"` +} + +// String returns the string representation +func (s AssessmentControl) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s AssessmentControl) GoString() string { + return s.String() +} + +// SetAssessmentReportEvidenceCount sets the AssessmentReportEvidenceCount field's value. +func (s *AssessmentControl) SetAssessmentReportEvidenceCount(v int64) *AssessmentControl { + s.AssessmentReportEvidenceCount = &v + return s +} + +// SetComments sets the Comments field's value. +func (s *AssessmentControl) SetComments(v []*ControlComment) *AssessmentControl { + s.Comments = v + return s +} + +// SetDescription sets the Description field's value. +func (s *AssessmentControl) SetDescription(v string) *AssessmentControl { + s.Description = &v + return s +} + +// SetEvidenceCount sets the EvidenceCount field's value. +func (s *AssessmentControl) SetEvidenceCount(v int64) *AssessmentControl { + s.EvidenceCount = &v + return s +} + +// SetEvidenceSources sets the EvidenceSources field's value. +func (s *AssessmentControl) SetEvidenceSources(v []*string) *AssessmentControl { + s.EvidenceSources = v + return s +} + +// SetId sets the Id field's value. +func (s *AssessmentControl) SetId(v string) *AssessmentControl { + s.Id = &v + return s +} + +// SetName sets the Name field's value. +func (s *AssessmentControl) SetName(v string) *AssessmentControl { + s.Name = &v + return s +} + +// SetResponse sets the Response field's value. +func (s *AssessmentControl) SetResponse(v string) *AssessmentControl { + s.Response = &v + return s +} + +// SetStatus sets the Status field's value. +func (s *AssessmentControl) SetStatus(v string) *AssessmentControl { + s.Status = &v + return s +} + +// Represents a set of controls in an AWS Audit Manager assessment. +type AssessmentControlSet struct { + _ struct{} `type:"structure"` + + // The list of controls contained with the control set. + Controls []*AssessmentControl `locationName:"controls" type:"list"` + + // The delegations associated with the control set. + Delegations []*Delegation `locationName:"delegations" type:"list"` + + // The description for the control set. + Description *string `locationName:"description" min:"1" type:"string"` + + // The identifier of the control set in the assessment. This is the control + // set name in a plain string format. + Id *string `locationName:"id" min:"1" type:"string"` + + // The total number of evidence objects uploaded manually to the control set. + ManualEvidenceCount *int64 `locationName:"manualEvidenceCount" type:"integer"` + + // The roles associated with the control set. + Roles []*Role `locationName:"roles" type:"list"` + + // Specifies the current status of the control set. + Status *string `locationName:"status" type:"string" enum:"ControlSetStatus"` + + // The total number of evidence objects retrieved automatically for the control + // set. + SystemEvidenceCount *int64 `locationName:"systemEvidenceCount" type:"integer"` +} + +// String returns the string representation +func (s AssessmentControlSet) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s AssessmentControlSet) GoString() string { + return s.String() +} + +// SetControls sets the Controls field's value. +func (s *AssessmentControlSet) SetControls(v []*AssessmentControl) *AssessmentControlSet { + s.Controls = v + return s +} + +// SetDelegations sets the Delegations field's value. +func (s *AssessmentControlSet) SetDelegations(v []*Delegation) *AssessmentControlSet { + s.Delegations = v + return s +} + +// SetDescription sets the Description field's value. +func (s *AssessmentControlSet) SetDescription(v string) *AssessmentControlSet { + s.Description = &v + return s +} + +// SetId sets the Id field's value. +func (s *AssessmentControlSet) SetId(v string) *AssessmentControlSet { + s.Id = &v + return s +} + +// SetManualEvidenceCount sets the ManualEvidenceCount field's value. +func (s *AssessmentControlSet) SetManualEvidenceCount(v int64) *AssessmentControlSet { + s.ManualEvidenceCount = &v + return s +} + +// SetRoles sets the Roles field's value. +func (s *AssessmentControlSet) SetRoles(v []*Role) *AssessmentControlSet { + s.Roles = v + return s +} + +// SetStatus sets the Status field's value. +func (s *AssessmentControlSet) SetStatus(v string) *AssessmentControlSet { + s.Status = &v + return s +} + +// SetSystemEvidenceCount sets the SystemEvidenceCount field's value. +func (s *AssessmentControlSet) SetSystemEvidenceCount(v int64) *AssessmentControlSet { + s.SystemEvidenceCount = &v + return s +} + +// The folder in which AWS Audit Manager stores evidence for an assessment. +type AssessmentEvidenceFolder struct { + _ struct{} `type:"structure"` + + // The identifier for the specified assessment. + AssessmentId *string `locationName:"assessmentId" min:"36" type:"string"` + + // The total count of evidence included in the assessment report. + AssessmentReportSelectionCount *int64 `locationName:"assessmentReportSelectionCount" type:"integer"` + + // The name of the user who created the evidence folder. + Author *string `locationName:"author" type:"string"` + + // The unique identifier for the specified control. + ControlId *string `locationName:"controlId" min:"36" type:"string"` + + // The name of the control. + ControlName *string `locationName:"controlName" min:"1" type:"string"` + + // The identifier for the control set. + ControlSetId *string `locationName:"controlSetId" min:"1" type:"string"` + + // The AWS service from which the evidence was collected. + DataSource *string `locationName:"dataSource" type:"string"` + + // The date when the first evidence was added to the evidence folder. + Date *time.Time `locationName:"date" type:"timestamp"` + + // The total number of AWS resources assessed to generate the evidence. + EvidenceAwsServiceSourceCount *int64 `locationName:"evidenceAwsServiceSourceCount" type:"integer"` + + // The number of evidence that falls under the compliance check category. This + // evidence is collected from AWS Config or AWS Security Hub. + EvidenceByTypeComplianceCheckCount *int64 `locationName:"evidenceByTypeComplianceCheckCount" type:"integer"` + + // The total number of issues that were reported directly from AWS Security + // Hub, AWS Config, or both. + EvidenceByTypeComplianceCheckIssuesCount *int64 `locationName:"evidenceByTypeComplianceCheckIssuesCount" type:"integer"` + + // The number of evidence that falls under the configuration data category. + // This evidence is collected from configuration snapshots of other AWS services + // such as Amazon EC2, Amazon S3, or IAM. + EvidenceByTypeConfigurationDataCount *int64 `locationName:"evidenceByTypeConfigurationDataCount" type:"integer"` + + // The number of evidence that falls under the manual category. This evidence + // is imported manually. + EvidenceByTypeManualCount *int64 `locationName:"evidenceByTypeManualCount" type:"integer"` + + // The number of evidence that falls under the user activity category. This + // evidence is collected from AWS CloudTrail logs. + EvidenceByTypeUserActivityCount *int64 `locationName:"evidenceByTypeUserActivityCount" type:"integer"` + + // The amount of evidence included in the evidence folder. + EvidenceResourcesIncludedCount *int64 `locationName:"evidenceResourcesIncludedCount" type:"integer"` + + // The identifier for the folder in which evidence is stored. + Id *string `locationName:"id" min:"36" type:"string"` + + // The name of the specified evidence folder. + Name *string `locationName:"name" min:"1" type:"string"` + + // The total amount of evidence in the evidence folder. + TotalEvidence *int64 `locationName:"totalEvidence" type:"integer"` +} + +// String returns the string representation +func (s AssessmentEvidenceFolder) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s AssessmentEvidenceFolder) GoString() string { + return s.String() +} + +// SetAssessmentId sets the AssessmentId field's value. +func (s *AssessmentEvidenceFolder) SetAssessmentId(v string) *AssessmentEvidenceFolder { + s.AssessmentId = &v + return s +} + +// SetAssessmentReportSelectionCount sets the AssessmentReportSelectionCount field's value. +func (s *AssessmentEvidenceFolder) SetAssessmentReportSelectionCount(v int64) *AssessmentEvidenceFolder { + s.AssessmentReportSelectionCount = &v + return s +} + +// SetAuthor sets the Author field's value. +func (s *AssessmentEvidenceFolder) SetAuthor(v string) *AssessmentEvidenceFolder { + s.Author = &v + return s +} + +// SetControlId sets the ControlId field's value. +func (s *AssessmentEvidenceFolder) SetControlId(v string) *AssessmentEvidenceFolder { + s.ControlId = &v + return s +} + +// SetControlName sets the ControlName field's value. +func (s *AssessmentEvidenceFolder) SetControlName(v string) *AssessmentEvidenceFolder { + s.ControlName = &v + return s +} + +// SetControlSetId sets the ControlSetId field's value. +func (s *AssessmentEvidenceFolder) SetControlSetId(v string) *AssessmentEvidenceFolder { + s.ControlSetId = &v + return s +} + +// SetDataSource sets the DataSource field's value. +func (s *AssessmentEvidenceFolder) SetDataSource(v string) *AssessmentEvidenceFolder { + s.DataSource = &v + return s +} + +// SetDate sets the Date field's value. +func (s *AssessmentEvidenceFolder) SetDate(v time.Time) *AssessmentEvidenceFolder { + s.Date = &v + return s +} + +// SetEvidenceAwsServiceSourceCount sets the EvidenceAwsServiceSourceCount field's value. +func (s *AssessmentEvidenceFolder) SetEvidenceAwsServiceSourceCount(v int64) *AssessmentEvidenceFolder { + s.EvidenceAwsServiceSourceCount = &v + return s +} + +// SetEvidenceByTypeComplianceCheckCount sets the EvidenceByTypeComplianceCheckCount field's value. +func (s *AssessmentEvidenceFolder) SetEvidenceByTypeComplianceCheckCount(v int64) *AssessmentEvidenceFolder { + s.EvidenceByTypeComplianceCheckCount = &v + return s +} + +// SetEvidenceByTypeComplianceCheckIssuesCount sets the EvidenceByTypeComplianceCheckIssuesCount field's value. +func (s *AssessmentEvidenceFolder) SetEvidenceByTypeComplianceCheckIssuesCount(v int64) *AssessmentEvidenceFolder { + s.EvidenceByTypeComplianceCheckIssuesCount = &v + return s +} + +// SetEvidenceByTypeConfigurationDataCount sets the EvidenceByTypeConfigurationDataCount field's value. +func (s *AssessmentEvidenceFolder) SetEvidenceByTypeConfigurationDataCount(v int64) *AssessmentEvidenceFolder { + s.EvidenceByTypeConfigurationDataCount = &v + return s +} + +// SetEvidenceByTypeManualCount sets the EvidenceByTypeManualCount field's value. +func (s *AssessmentEvidenceFolder) SetEvidenceByTypeManualCount(v int64) *AssessmentEvidenceFolder { + s.EvidenceByTypeManualCount = &v + return s +} + +// SetEvidenceByTypeUserActivityCount sets the EvidenceByTypeUserActivityCount field's value. +func (s *AssessmentEvidenceFolder) SetEvidenceByTypeUserActivityCount(v int64) *AssessmentEvidenceFolder { + s.EvidenceByTypeUserActivityCount = &v + return s +} + +// SetEvidenceResourcesIncludedCount sets the EvidenceResourcesIncludedCount field's value. +func (s *AssessmentEvidenceFolder) SetEvidenceResourcesIncludedCount(v int64) *AssessmentEvidenceFolder { + s.EvidenceResourcesIncludedCount = &v + return s +} + +// SetId sets the Id field's value. +func (s *AssessmentEvidenceFolder) SetId(v string) *AssessmentEvidenceFolder { + s.Id = &v + return s +} + +// SetName sets the Name field's value. +func (s *AssessmentEvidenceFolder) SetName(v string) *AssessmentEvidenceFolder { + s.Name = &v + return s +} + +// SetTotalEvidence sets the TotalEvidence field's value. +func (s *AssessmentEvidenceFolder) SetTotalEvidence(v int64) *AssessmentEvidenceFolder { + s.TotalEvidence = &v + return s +} + +// The file used to structure and automate AWS Audit Manager assessments for +// a given compliance standard. +type AssessmentFramework struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the specified framework. + Arn *string `locationName:"arn" min:"20" type:"string"` + + // The control sets associated with the framework. + ControlSets []*AssessmentControlSet `locationName:"controlSets" type:"list"` + + // The unique identifier for the framework. + Id *string `locationName:"id" min:"36" type:"string"` + + // The metadata of a framework, such as the name, ID, description, and so on. + Metadata *FrameworkMetadata `locationName:"metadata" type:"structure"` +} + +// String returns the string representation +func (s AssessmentFramework) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s AssessmentFramework) GoString() string { + return s.String() +} + +// SetArn sets the Arn field's value. +func (s *AssessmentFramework) SetArn(v string) *AssessmentFramework { + s.Arn = &v + return s +} + +// SetControlSets sets the ControlSets field's value. +func (s *AssessmentFramework) SetControlSets(v []*AssessmentControlSet) *AssessmentFramework { + s.ControlSets = v + return s +} + +// SetId sets the Id field's value. +func (s *AssessmentFramework) SetId(v string) *AssessmentFramework { + s.Id = &v + return s +} + +// SetMetadata sets the Metadata field's value. +func (s *AssessmentFramework) SetMetadata(v *FrameworkMetadata) *AssessmentFramework { + s.Metadata = v + return s +} + +// The metadata associated with a standard or custom framework. +type AssessmentFrameworkMetadata struct { + _ struct{} `type:"structure"` + + // The compliance type that the new custom framework supports, such as CIS or + // HIPAA. + ComplianceType *string `locationName:"complianceType" type:"string"` + + // The number of control sets associated with the specified framework. + ControlSetsCount *int64 `locationName:"controlSetsCount" type:"integer"` + + // The number of controls associated with the specified framework. + ControlsCount *int64 `locationName:"controlsCount" type:"integer"` + + // Specifies when the framework was created. + CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"` + + // The description of the specified framework. + Description *string `locationName:"description" min:"1" type:"string"` + + // The unique identified for the specified framework. + Id *string `locationName:"id" min:"36" type:"string"` + + // Specifies when the framework was most recently updated. + LastUpdatedAt *time.Time `locationName:"lastUpdatedAt" type:"timestamp"` + + // The logo associated with the framework. + Logo *string `locationName:"logo" min:"1" type:"string"` + + // The name of the specified framework. + Name *string `locationName:"name" min:"1" type:"string"` + + // The framework type, such as standard or custom. + Type *string `locationName:"type" type:"string" enum:"FrameworkType"` +} + +// String returns the string representation +func (s AssessmentFrameworkMetadata) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s AssessmentFrameworkMetadata) GoString() string { + return s.String() +} + +// SetComplianceType sets the ComplianceType field's value. +func (s *AssessmentFrameworkMetadata) SetComplianceType(v string) *AssessmentFrameworkMetadata { + s.ComplianceType = &v + return s +} + +// SetControlSetsCount sets the ControlSetsCount field's value. +func (s *AssessmentFrameworkMetadata) SetControlSetsCount(v int64) *AssessmentFrameworkMetadata { + s.ControlSetsCount = &v + return s +} + +// SetControlsCount sets the ControlsCount field's value. +func (s *AssessmentFrameworkMetadata) SetControlsCount(v int64) *AssessmentFrameworkMetadata { + s.ControlsCount = &v + return s +} + +// SetCreatedAt sets the CreatedAt field's value. +func (s *AssessmentFrameworkMetadata) SetCreatedAt(v time.Time) *AssessmentFrameworkMetadata { + s.CreatedAt = &v + return s +} + +// SetDescription sets the Description field's value. +func (s *AssessmentFrameworkMetadata) SetDescription(v string) *AssessmentFrameworkMetadata { + s.Description = &v + return s +} + +// SetId sets the Id field's value. +func (s *AssessmentFrameworkMetadata) SetId(v string) *AssessmentFrameworkMetadata { + s.Id = &v + return s +} + +// SetLastUpdatedAt sets the LastUpdatedAt field's value. +func (s *AssessmentFrameworkMetadata) SetLastUpdatedAt(v time.Time) *AssessmentFrameworkMetadata { + s.LastUpdatedAt = &v + return s +} + +// SetLogo sets the Logo field's value. +func (s *AssessmentFrameworkMetadata) SetLogo(v string) *AssessmentFrameworkMetadata { + s.Logo = &v + return s +} + +// SetName sets the Name field's value. +func (s *AssessmentFrameworkMetadata) SetName(v string) *AssessmentFrameworkMetadata { + s.Name = &v + return s +} + +// SetType sets the Type field's value. +func (s *AssessmentFrameworkMetadata) SetType(v string) *AssessmentFrameworkMetadata { + s.Type = &v + return s +} + +// The metadata associated with the specified assessment. +type AssessmentMetadata struct { + _ struct{} `type:"structure"` + + // The destination in which evidence reports are stored for the specified assessment. + AssessmentReportsDestination *AssessmentReportsDestination `locationName:"assessmentReportsDestination" type:"structure"` + + // The name of a compliance standard related to the assessment, such as PCI-DSS. + ComplianceType *string `locationName:"complianceType" type:"string"` + + // Specifies when the assessment was created. + CreationTime *time.Time `locationName:"creationTime" type:"timestamp"` + + // The delegations associated with the assessment. + Delegations []*Delegation `locationName:"delegations" type:"list"` + + // The description of the assessment. + Description *string `locationName:"description" type:"string"` + + // The unique identifier for the assessment. + Id *string `locationName:"id" min:"36" type:"string"` + + // The time of the most recent update. + LastUpdated *time.Time `locationName:"lastUpdated" type:"timestamp"` + + // The name of the assessment. + Name *string `locationName:"name" min:"1" type:"string"` + + // The roles associated with the assessment. + Roles []*Role `locationName:"roles" type:"list"` + + // The wrapper of AWS accounts and services in scope for the assessment. + Scope *Scope `locationName:"scope" type:"structure"` + + // The overall status of the assessment. + Status *string `locationName:"status" type:"string" enum:"AssessmentStatus"` +} + +// String returns the string representation +func (s AssessmentMetadata) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s AssessmentMetadata) GoString() string { + return s.String() +} + +// SetAssessmentReportsDestination sets the AssessmentReportsDestination field's value. +func (s *AssessmentMetadata) SetAssessmentReportsDestination(v *AssessmentReportsDestination) *AssessmentMetadata { + s.AssessmentReportsDestination = v + return s +} + +// SetComplianceType sets the ComplianceType field's value. +func (s *AssessmentMetadata) SetComplianceType(v string) *AssessmentMetadata { + s.ComplianceType = &v + return s +} + +// SetCreationTime sets the CreationTime field's value. +func (s *AssessmentMetadata) SetCreationTime(v time.Time) *AssessmentMetadata { + s.CreationTime = &v + return s +} + +// SetDelegations sets the Delegations field's value. +func (s *AssessmentMetadata) SetDelegations(v []*Delegation) *AssessmentMetadata { + s.Delegations = v + return s +} + +// SetDescription sets the Description field's value. +func (s *AssessmentMetadata) SetDescription(v string) *AssessmentMetadata { + s.Description = &v + return s +} + +// SetId sets the Id field's value. +func (s *AssessmentMetadata) SetId(v string) *AssessmentMetadata { + s.Id = &v + return s +} + +// SetLastUpdated sets the LastUpdated field's value. +func (s *AssessmentMetadata) SetLastUpdated(v time.Time) *AssessmentMetadata { + s.LastUpdated = &v + return s +} + +// SetName sets the Name field's value. +func (s *AssessmentMetadata) SetName(v string) *AssessmentMetadata { + s.Name = &v + return s +} + +// SetRoles sets the Roles field's value. +func (s *AssessmentMetadata) SetRoles(v []*Role) *AssessmentMetadata { + s.Roles = v + return s +} + +// SetScope sets the Scope field's value. +func (s *AssessmentMetadata) SetScope(v *Scope) *AssessmentMetadata { + s.Scope = v + return s +} + +// SetStatus sets the Status field's value. +func (s *AssessmentMetadata) SetStatus(v string) *AssessmentMetadata { + s.Status = &v + return s +} + +// A metadata object associated with an assessment in AWS Audit Manager. +type AssessmentMetadataItem struct { + _ struct{} `type:"structure"` + + // The name of the compliance standard related to the assessment, such as PCI-DSS. + ComplianceType *string `locationName:"complianceType" type:"string"` + + // Specifies when the assessment was created. + CreationTime *time.Time `locationName:"creationTime" type:"timestamp"` + + // The delegations associated with the assessment. + Delegations []*Delegation `locationName:"delegations" type:"list"` + + // The unique identifier for the assessment. + Id *string `locationName:"id" min:"36" type:"string"` + + // The time of the most recent update. + LastUpdated *time.Time `locationName:"lastUpdated" type:"timestamp"` + + // The name of the assessment. + Name *string `locationName:"name" min:"1" type:"string"` + + // The roles associated with the assessment. + Roles []*Role `locationName:"roles" type:"list"` + + // The current status of the assessment. + Status *string `locationName:"status" type:"string" enum:"AssessmentStatus"` +} + +// String returns the string representation +func (s AssessmentMetadataItem) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s AssessmentMetadataItem) GoString() string { + return s.String() +} + +// SetComplianceType sets the ComplianceType field's value. +func (s *AssessmentMetadataItem) SetComplianceType(v string) *AssessmentMetadataItem { + s.ComplianceType = &v + return s +} + +// SetCreationTime sets the CreationTime field's value. +func (s *AssessmentMetadataItem) SetCreationTime(v time.Time) *AssessmentMetadataItem { + s.CreationTime = &v + return s +} + +// SetDelegations sets the Delegations field's value. +func (s *AssessmentMetadataItem) SetDelegations(v []*Delegation) *AssessmentMetadataItem { + s.Delegations = v + return s +} + +// SetId sets the Id field's value. +func (s *AssessmentMetadataItem) SetId(v string) *AssessmentMetadataItem { + s.Id = &v + return s +} + +// SetLastUpdated sets the LastUpdated field's value. +func (s *AssessmentMetadataItem) SetLastUpdated(v time.Time) *AssessmentMetadataItem { + s.LastUpdated = &v + return s +} + +// SetName sets the Name field's value. +func (s *AssessmentMetadataItem) SetName(v string) *AssessmentMetadataItem { + s.Name = &v + return s +} + +// SetRoles sets the Roles field's value. +func (s *AssessmentMetadataItem) SetRoles(v []*Role) *AssessmentMetadataItem { + s.Roles = v + return s +} + +// SetStatus sets the Status field's value. +func (s *AssessmentMetadataItem) SetStatus(v string) *AssessmentMetadataItem { + s.Status = &v + return s +} + +// A finalized document generated from an AWS Audit Manager assessment. These +// reports summarize the relevant evidence collected for your audit, and link +// to the relevant evidence folders which are named and organized according +// to the controls specified in your assessment. +type AssessmentReport struct { + _ struct{} `type:"structure"` + + // The identifier for the specified assessment. + AssessmentId *string `locationName:"assessmentId" min:"36" type:"string"` + + // The name of the associated assessment. + AssessmentName *string `locationName:"assessmentName" min:"1" type:"string"` + + // The name of the user who created the assessment report. + Author *string `locationName:"author" min:"1" type:"string"` + + // The identifier for the specified AWS account. + AwsAccountId *string `locationName:"awsAccountId" min:"12" type:"string"` + + // Specifies when the assessment report was created. + CreationTime *time.Time `locationName:"creationTime" type:"timestamp"` + + // The description of the specified assessment report. + Description *string `locationName:"description" type:"string"` + + // The unique identifier for the specified assessment report. + Id *string `locationName:"id" min:"36" type:"string"` + + // The name given to the assessment report. + Name *string `locationName:"name" min:"1" type:"string"` + + // The current status of the specified assessment report. + Status *string `locationName:"status" type:"string" enum:"AssessmentReportStatus"` +} + +// String returns the string representation +func (s AssessmentReport) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s AssessmentReport) GoString() string { + return s.String() +} + +// SetAssessmentId sets the AssessmentId field's value. +func (s *AssessmentReport) SetAssessmentId(v string) *AssessmentReport { + s.AssessmentId = &v + return s +} + +// SetAssessmentName sets the AssessmentName field's value. +func (s *AssessmentReport) SetAssessmentName(v string) *AssessmentReport { + s.AssessmentName = &v + return s +} + +// SetAuthor sets the Author field's value. +func (s *AssessmentReport) SetAuthor(v string) *AssessmentReport { + s.Author = &v + return s +} + +// SetAwsAccountId sets the AwsAccountId field's value. +func (s *AssessmentReport) SetAwsAccountId(v string) *AssessmentReport { + s.AwsAccountId = &v + return s +} + +// SetCreationTime sets the CreationTime field's value. +func (s *AssessmentReport) SetCreationTime(v time.Time) *AssessmentReport { + s.CreationTime = &v + return s +} + +// SetDescription sets the Description field's value. +func (s *AssessmentReport) SetDescription(v string) *AssessmentReport { + s.Description = &v + return s +} + +// SetId sets the Id field's value. +func (s *AssessmentReport) SetId(v string) *AssessmentReport { + s.Id = &v + return s +} + +// SetName sets the Name field's value. +func (s *AssessmentReport) SetName(v string) *AssessmentReport { + s.Name = &v + return s +} + +// SetStatus sets the Status field's value. +func (s *AssessmentReport) SetStatus(v string) *AssessmentReport { + s.Status = &v + return s +} + +// An error entity for the AssessmentReportEvidence API. This is used to provide +// more meaningful errors than a simple string message. +type AssessmentReportEvidenceError struct { + _ struct{} `type:"structure"` + + // The error code returned by the AssessmentReportEvidence API. + ErrorCode *string `locationName:"errorCode" min:"3" type:"string"` + + // The error message returned by the AssessmentReportEvidence API. + ErrorMessage *string `locationName:"errorMessage" type:"string"` + + // The identifier for the evidence. + EvidenceId *string `locationName:"evidenceId" min:"36" type:"string"` +} + +// String returns the string representation +func (s AssessmentReportEvidenceError) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s AssessmentReportEvidenceError) GoString() string { + return s.String() +} + +// SetErrorCode sets the ErrorCode field's value. +func (s *AssessmentReportEvidenceError) SetErrorCode(v string) *AssessmentReportEvidenceError { + s.ErrorCode = &v + return s +} + +// SetErrorMessage sets the ErrorMessage field's value. +func (s *AssessmentReportEvidenceError) SetErrorMessage(v string) *AssessmentReportEvidenceError { + s.ErrorMessage = &v + return s +} + +// SetEvidenceId sets the EvidenceId field's value. +func (s *AssessmentReportEvidenceError) SetEvidenceId(v string) *AssessmentReportEvidenceError { + s.EvidenceId = &v + return s +} + +// The metadata objects associated with the specified assessment report. +type AssessmentReportMetadata struct { + _ struct{} `type:"structure"` + + // The unique identifier for the associated assessment. + AssessmentId *string `locationName:"assessmentId" min:"36" type:"string"` + + // The name of the associated assessment. + AssessmentName *string `locationName:"assessmentName" min:"1" type:"string"` + + // The name of the user who created the assessment report. + Author *string `locationName:"author" min:"1" type:"string"` + + // Specifies when the assessment report was created. + CreationTime *time.Time `locationName:"creationTime" type:"timestamp"` + + // The description of the specified assessment report. + Description *string `locationName:"description" type:"string"` + + // The unique identifier for the assessment report. + Id *string `locationName:"id" min:"36" type:"string"` + + // The name of the assessment report. + Name *string `locationName:"name" min:"1" type:"string"` + + // The current status of the assessment report. + Status *string `locationName:"status" type:"string" enum:"AssessmentReportStatus"` +} + +// String returns the string representation +func (s AssessmentReportMetadata) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s AssessmentReportMetadata) GoString() string { + return s.String() +} + +// SetAssessmentId sets the AssessmentId field's value. +func (s *AssessmentReportMetadata) SetAssessmentId(v string) *AssessmentReportMetadata { + s.AssessmentId = &v + return s +} + +// SetAssessmentName sets the AssessmentName field's value. +func (s *AssessmentReportMetadata) SetAssessmentName(v string) *AssessmentReportMetadata { + s.AssessmentName = &v + return s +} + +// SetAuthor sets the Author field's value. +func (s *AssessmentReportMetadata) SetAuthor(v string) *AssessmentReportMetadata { + s.Author = &v + return s +} + +// SetCreationTime sets the CreationTime field's value. +func (s *AssessmentReportMetadata) SetCreationTime(v time.Time) *AssessmentReportMetadata { + s.CreationTime = &v + return s +} + +// SetDescription sets the Description field's value. +func (s *AssessmentReportMetadata) SetDescription(v string) *AssessmentReportMetadata { + s.Description = &v + return s +} + +// SetId sets the Id field's value. +func (s *AssessmentReportMetadata) SetId(v string) *AssessmentReportMetadata { + s.Id = &v + return s +} + +// SetName sets the Name field's value. +func (s *AssessmentReportMetadata) SetName(v string) *AssessmentReportMetadata { + s.Name = &v + return s +} + +// SetStatus sets the Status field's value. +func (s *AssessmentReportMetadata) SetStatus(v string) *AssessmentReportMetadata { + s.Status = &v + return s +} + +// The location in which AWS Audit Manager saves assessment reports for the +// given assessment. +type AssessmentReportsDestination struct { + _ struct{} `type:"structure"` + + // The destination of the assessment report. + Destination *string `locationName:"destination" min:"1" type:"string"` + + // The destination type, such as Amazon S3. + DestinationType *string `locationName:"destinationType" type:"string" enum:"AssessmentReportDestinationType"` +} + +// String returns the string representation +func (s AssessmentReportsDestination) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s AssessmentReportsDestination) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *AssessmentReportsDestination) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "AssessmentReportsDestination"} + if s.Destination != nil && len(*s.Destination) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Destination", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDestination sets the Destination field's value. +func (s *AssessmentReportsDestination) SetDestination(v string) *AssessmentReportsDestination { + s.Destination = &v + return s +} + +// SetDestinationType sets the DestinationType field's value. +func (s *AssessmentReportsDestination) SetDestinationType(v string) *AssessmentReportsDestination { + s.DestinationType = &v + return s +} + +type AssociateAssessmentReportEvidenceFolderInput struct { + _ struct{} `type:"structure"` + + // The identifier for the specified assessment. + // + // AssessmentId is a required field + AssessmentId *string `location:"uri" locationName:"assessmentId" min:"36" type:"string" required:"true"` + + // The identifier for the folder in which evidence is stored. + // + // EvidenceFolderId is a required field + EvidenceFolderId *string `locationName:"evidenceFolderId" min:"36" type:"string" required:"true"` +} + +// String returns the string representation +func (s AssociateAssessmentReportEvidenceFolderInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s AssociateAssessmentReportEvidenceFolderInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *AssociateAssessmentReportEvidenceFolderInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "AssociateAssessmentReportEvidenceFolderInput"} + if s.AssessmentId == nil { + invalidParams.Add(request.NewErrParamRequired("AssessmentId")) + } + if s.AssessmentId != nil && len(*s.AssessmentId) < 36 { + invalidParams.Add(request.NewErrParamMinLen("AssessmentId", 36)) + } + if s.EvidenceFolderId == nil { + invalidParams.Add(request.NewErrParamRequired("EvidenceFolderId")) + } + if s.EvidenceFolderId != nil && len(*s.EvidenceFolderId) < 36 { + invalidParams.Add(request.NewErrParamMinLen("EvidenceFolderId", 36)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAssessmentId sets the AssessmentId field's value. +func (s *AssociateAssessmentReportEvidenceFolderInput) SetAssessmentId(v string) *AssociateAssessmentReportEvidenceFolderInput { + s.AssessmentId = &v + return s +} + +// SetEvidenceFolderId sets the EvidenceFolderId field's value. +func (s *AssociateAssessmentReportEvidenceFolderInput) SetEvidenceFolderId(v string) *AssociateAssessmentReportEvidenceFolderInput { + s.EvidenceFolderId = &v + return s +} + +type AssociateAssessmentReportEvidenceFolderOutput struct { + _ struct{} `type:"structure"` +} + +// String returns the string representation +func (s AssociateAssessmentReportEvidenceFolderOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s AssociateAssessmentReportEvidenceFolderOutput) GoString() string { + return s.String() +} + +type BatchAssociateAssessmentReportEvidenceInput struct { + _ struct{} `type:"structure"` + + // The unique identifier for the specified assessment. + // + // AssessmentId is a required field + AssessmentId *string `location:"uri" locationName:"assessmentId" min:"36" type:"string" required:"true"` + + // The identifier for the folder in which the evidence is stored. + // + // EvidenceFolderId is a required field + EvidenceFolderId *string `locationName:"evidenceFolderId" min:"36" type:"string" required:"true"` + + // The list of evidence identifiers. + // + // EvidenceIds is a required field + EvidenceIds []*string `locationName:"evidenceIds" type:"list" required:"true"` +} + +// String returns the string representation +func (s BatchAssociateAssessmentReportEvidenceInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s BatchAssociateAssessmentReportEvidenceInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *BatchAssociateAssessmentReportEvidenceInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "BatchAssociateAssessmentReportEvidenceInput"} + if s.AssessmentId == nil { + invalidParams.Add(request.NewErrParamRequired("AssessmentId")) + } + if s.AssessmentId != nil && len(*s.AssessmentId) < 36 { + invalidParams.Add(request.NewErrParamMinLen("AssessmentId", 36)) + } + if s.EvidenceFolderId == nil { + invalidParams.Add(request.NewErrParamRequired("EvidenceFolderId")) + } + if s.EvidenceFolderId != nil && len(*s.EvidenceFolderId) < 36 { + invalidParams.Add(request.NewErrParamMinLen("EvidenceFolderId", 36)) + } + if s.EvidenceIds == nil { + invalidParams.Add(request.NewErrParamRequired("EvidenceIds")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAssessmentId sets the AssessmentId field's value. +func (s *BatchAssociateAssessmentReportEvidenceInput) SetAssessmentId(v string) *BatchAssociateAssessmentReportEvidenceInput { + s.AssessmentId = &v + return s +} + +// SetEvidenceFolderId sets the EvidenceFolderId field's value. +func (s *BatchAssociateAssessmentReportEvidenceInput) SetEvidenceFolderId(v string) *BatchAssociateAssessmentReportEvidenceInput { + s.EvidenceFolderId = &v + return s +} + +// SetEvidenceIds sets the EvidenceIds field's value. +func (s *BatchAssociateAssessmentReportEvidenceInput) SetEvidenceIds(v []*string) *BatchAssociateAssessmentReportEvidenceInput { + s.EvidenceIds = v + return s +} + +type BatchAssociateAssessmentReportEvidenceOutput struct { + _ struct{} `type:"structure"` + + // A list of errors returned by the BatchAssociateAssessmentReportEvidence API. + Errors []*AssessmentReportEvidenceError `locationName:"errors" type:"list"` + + // The identifier for the evidence. + EvidenceIds []*string `locationName:"evidenceIds" type:"list"` +} + +// String returns the string representation +func (s BatchAssociateAssessmentReportEvidenceOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s BatchAssociateAssessmentReportEvidenceOutput) GoString() string { + return s.String() +} + +// SetErrors sets the Errors field's value. +func (s *BatchAssociateAssessmentReportEvidenceOutput) SetErrors(v []*AssessmentReportEvidenceError) *BatchAssociateAssessmentReportEvidenceOutput { + s.Errors = v + return s +} + +// SetEvidenceIds sets the EvidenceIds field's value. +func (s *BatchAssociateAssessmentReportEvidenceOutput) SetEvidenceIds(v []*string) *BatchAssociateAssessmentReportEvidenceOutput { + s.EvidenceIds = v + return s +} + +// An error entity for the BatchCreateDelegationByAssessment API. This is used +// to provide more meaningful errors than a simple string message. +type BatchCreateDelegationByAssessmentError struct { + _ struct{} `type:"structure"` + + // The API request to batch create delegations in AWS Audit Manager. + CreateDelegationRequest *CreateDelegationRequest `locationName:"createDelegationRequest" type:"structure"` + + // The error code returned by the BatchCreateDelegationByAssessment API. + ErrorCode *string `locationName:"errorCode" min:"3" type:"string"` + + // The error message returned by the BatchCreateDelegationByAssessment API. + ErrorMessage *string `locationName:"errorMessage" type:"string"` +} + +// String returns the string representation +func (s BatchCreateDelegationByAssessmentError) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s BatchCreateDelegationByAssessmentError) GoString() string { + return s.String() +} + +// SetCreateDelegationRequest sets the CreateDelegationRequest field's value. +func (s *BatchCreateDelegationByAssessmentError) SetCreateDelegationRequest(v *CreateDelegationRequest) *BatchCreateDelegationByAssessmentError { + s.CreateDelegationRequest = v + return s +} + +// SetErrorCode sets the ErrorCode field's value. +func (s *BatchCreateDelegationByAssessmentError) SetErrorCode(v string) *BatchCreateDelegationByAssessmentError { + s.ErrorCode = &v + return s +} + +// SetErrorMessage sets the ErrorMessage field's value. +func (s *BatchCreateDelegationByAssessmentError) SetErrorMessage(v string) *BatchCreateDelegationByAssessmentError { + s.ErrorMessage = &v + return s +} + +type BatchCreateDelegationByAssessmentInput struct { + _ struct{} `type:"structure"` + + // The identifier for the specified assessment. + // + // AssessmentId is a required field + AssessmentId *string `location:"uri" locationName:"assessmentId" min:"36" type:"string" required:"true"` + + // The API request to batch create delegations in AWS Audit Manager. + // + // CreateDelegationRequests is a required field + CreateDelegationRequests []*CreateDelegationRequest `locationName:"createDelegationRequests" min:"1" type:"list" required:"true"` +} + +// String returns the string representation +func (s BatchCreateDelegationByAssessmentInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s BatchCreateDelegationByAssessmentInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *BatchCreateDelegationByAssessmentInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "BatchCreateDelegationByAssessmentInput"} + if s.AssessmentId == nil { + invalidParams.Add(request.NewErrParamRequired("AssessmentId")) + } + if s.AssessmentId != nil && len(*s.AssessmentId) < 36 { + invalidParams.Add(request.NewErrParamMinLen("AssessmentId", 36)) + } + if s.CreateDelegationRequests == nil { + invalidParams.Add(request.NewErrParamRequired("CreateDelegationRequests")) + } + if s.CreateDelegationRequests != nil && len(s.CreateDelegationRequests) < 1 { + invalidParams.Add(request.NewErrParamMinLen("CreateDelegationRequests", 1)) + } + if s.CreateDelegationRequests != nil { + for i, v := range s.CreateDelegationRequests { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "CreateDelegationRequests", i), err.(request.ErrInvalidParams)) + } + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAssessmentId sets the AssessmentId field's value. +func (s *BatchCreateDelegationByAssessmentInput) SetAssessmentId(v string) *BatchCreateDelegationByAssessmentInput { + s.AssessmentId = &v + return s +} + +// SetCreateDelegationRequests sets the CreateDelegationRequests field's value. +func (s *BatchCreateDelegationByAssessmentInput) SetCreateDelegationRequests(v []*CreateDelegationRequest) *BatchCreateDelegationByAssessmentInput { + s.CreateDelegationRequests = v + return s +} + +type BatchCreateDelegationByAssessmentOutput struct { + _ struct{} `type:"structure"` + + // The delegations associated with the assessment. + Delegations []*Delegation `locationName:"delegations" type:"list"` + + // A list of errors returned by the BatchCreateDelegationByAssessment API. + Errors []*BatchCreateDelegationByAssessmentError `locationName:"errors" type:"list"` +} + +// String returns the string representation +func (s BatchCreateDelegationByAssessmentOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s BatchCreateDelegationByAssessmentOutput) GoString() string { + return s.String() +} + +// SetDelegations sets the Delegations field's value. +func (s *BatchCreateDelegationByAssessmentOutput) SetDelegations(v []*Delegation) *BatchCreateDelegationByAssessmentOutput { + s.Delegations = v + return s +} + +// SetErrors sets the Errors field's value. +func (s *BatchCreateDelegationByAssessmentOutput) SetErrors(v []*BatchCreateDelegationByAssessmentError) *BatchCreateDelegationByAssessmentOutput { + s.Errors = v + return s +} + +// An error entity for the BatchDeleteDelegationByAssessment API. This is used +// to provide more meaningful errors than a simple string message. +type BatchDeleteDelegationByAssessmentError struct { + _ struct{} `type:"structure"` + + // The identifier for the specified delegation. + DelegationId *string `locationName:"delegationId" min:"36" type:"string"` + + // The error code returned by the BatchDeleteDelegationByAssessment API. + ErrorCode *string `locationName:"errorCode" min:"3" type:"string"` + + // The error message returned by the BatchDeleteDelegationByAssessment API. + ErrorMessage *string `locationName:"errorMessage" type:"string"` +} + +// String returns the string representation +func (s BatchDeleteDelegationByAssessmentError) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s BatchDeleteDelegationByAssessmentError) GoString() string { + return s.String() +} + +// SetDelegationId sets the DelegationId field's value. +func (s *BatchDeleteDelegationByAssessmentError) SetDelegationId(v string) *BatchDeleteDelegationByAssessmentError { + s.DelegationId = &v + return s +} + +// SetErrorCode sets the ErrorCode field's value. +func (s *BatchDeleteDelegationByAssessmentError) SetErrorCode(v string) *BatchDeleteDelegationByAssessmentError { + s.ErrorCode = &v + return s +} + +// SetErrorMessage sets the ErrorMessage field's value. +func (s *BatchDeleteDelegationByAssessmentError) SetErrorMessage(v string) *BatchDeleteDelegationByAssessmentError { + s.ErrorMessage = &v + return s +} + +type BatchDeleteDelegationByAssessmentInput struct { + _ struct{} `type:"structure"` + + // The identifier for the specified assessment. + // + // AssessmentId is a required field + AssessmentId *string `location:"uri" locationName:"assessmentId" min:"36" type:"string" required:"true"` + + // The identifiers for the specified delegations. + // + // DelegationIds is a required field + DelegationIds []*string `locationName:"delegationIds" min:"1" type:"list" required:"true"` +} + +// String returns the string representation +func (s BatchDeleteDelegationByAssessmentInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s BatchDeleteDelegationByAssessmentInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *BatchDeleteDelegationByAssessmentInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "BatchDeleteDelegationByAssessmentInput"} + if s.AssessmentId == nil { + invalidParams.Add(request.NewErrParamRequired("AssessmentId")) + } + if s.AssessmentId != nil && len(*s.AssessmentId) < 36 { + invalidParams.Add(request.NewErrParamMinLen("AssessmentId", 36)) + } + if s.DelegationIds == nil { + invalidParams.Add(request.NewErrParamRequired("DelegationIds")) + } + if s.DelegationIds != nil && len(s.DelegationIds) < 1 { + invalidParams.Add(request.NewErrParamMinLen("DelegationIds", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAssessmentId sets the AssessmentId field's value. +func (s *BatchDeleteDelegationByAssessmentInput) SetAssessmentId(v string) *BatchDeleteDelegationByAssessmentInput { + s.AssessmentId = &v + return s +} + +// SetDelegationIds sets the DelegationIds field's value. +func (s *BatchDeleteDelegationByAssessmentInput) SetDelegationIds(v []*string) *BatchDeleteDelegationByAssessmentInput { + s.DelegationIds = v + return s +} + +type BatchDeleteDelegationByAssessmentOutput struct { + _ struct{} `type:"structure"` + + // A list of errors returned by the BatchDeleteDelegationByAssessment API. + Errors []*BatchDeleteDelegationByAssessmentError `locationName:"errors" type:"list"` +} + +// String returns the string representation +func (s BatchDeleteDelegationByAssessmentOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s BatchDeleteDelegationByAssessmentOutput) GoString() string { + return s.String() +} + +// SetErrors sets the Errors field's value. +func (s *BatchDeleteDelegationByAssessmentOutput) SetErrors(v []*BatchDeleteDelegationByAssessmentError) *BatchDeleteDelegationByAssessmentOutput { + s.Errors = v + return s +} + +type BatchDisassociateAssessmentReportEvidenceInput struct { + _ struct{} `type:"structure"` + + // The identifier for the specified assessment. + // + // AssessmentId is a required field + AssessmentId *string `location:"uri" locationName:"assessmentId" min:"36" type:"string" required:"true"` + + // The identifier for the folder in which evidence is stored. + // + // EvidenceFolderId is a required field + EvidenceFolderId *string `locationName:"evidenceFolderId" min:"36" type:"string" required:"true"` + + // The list of evidence identifiers. + // + // EvidenceIds is a required field + EvidenceIds []*string `locationName:"evidenceIds" type:"list" required:"true"` +} + +// String returns the string representation +func (s BatchDisassociateAssessmentReportEvidenceInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s BatchDisassociateAssessmentReportEvidenceInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *BatchDisassociateAssessmentReportEvidenceInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "BatchDisassociateAssessmentReportEvidenceInput"} + if s.AssessmentId == nil { + invalidParams.Add(request.NewErrParamRequired("AssessmentId")) + } + if s.AssessmentId != nil && len(*s.AssessmentId) < 36 { + invalidParams.Add(request.NewErrParamMinLen("AssessmentId", 36)) + } + if s.EvidenceFolderId == nil { + invalidParams.Add(request.NewErrParamRequired("EvidenceFolderId")) + } + if s.EvidenceFolderId != nil && len(*s.EvidenceFolderId) < 36 { + invalidParams.Add(request.NewErrParamMinLen("EvidenceFolderId", 36)) + } + if s.EvidenceIds == nil { + invalidParams.Add(request.NewErrParamRequired("EvidenceIds")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAssessmentId sets the AssessmentId field's value. +func (s *BatchDisassociateAssessmentReportEvidenceInput) SetAssessmentId(v string) *BatchDisassociateAssessmentReportEvidenceInput { + s.AssessmentId = &v + return s +} + +// SetEvidenceFolderId sets the EvidenceFolderId field's value. +func (s *BatchDisassociateAssessmentReportEvidenceInput) SetEvidenceFolderId(v string) *BatchDisassociateAssessmentReportEvidenceInput { + s.EvidenceFolderId = &v + return s +} + +// SetEvidenceIds sets the EvidenceIds field's value. +func (s *BatchDisassociateAssessmentReportEvidenceInput) SetEvidenceIds(v []*string) *BatchDisassociateAssessmentReportEvidenceInput { + s.EvidenceIds = v + return s +} + +type BatchDisassociateAssessmentReportEvidenceOutput struct { + _ struct{} `type:"structure"` + + // A list of errors returned by the BatchDisassociateAssessmentReportEvidence + // API. + Errors []*AssessmentReportEvidenceError `locationName:"errors" type:"list"` + + // The identifier for the evidence. + EvidenceIds []*string `locationName:"evidenceIds" type:"list"` +} + +// String returns the string representation +func (s BatchDisassociateAssessmentReportEvidenceOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s BatchDisassociateAssessmentReportEvidenceOutput) GoString() string { + return s.String() +} + +// SetErrors sets the Errors field's value. +func (s *BatchDisassociateAssessmentReportEvidenceOutput) SetErrors(v []*AssessmentReportEvidenceError) *BatchDisassociateAssessmentReportEvidenceOutput { + s.Errors = v + return s +} + +// SetEvidenceIds sets the EvidenceIds field's value. +func (s *BatchDisassociateAssessmentReportEvidenceOutput) SetEvidenceIds(v []*string) *BatchDisassociateAssessmentReportEvidenceOutput { + s.EvidenceIds = v + return s +} + +// An error entity for the BatchImportEvidenceToAssessmentControl API. This +// is used to provide more meaningful errors than a simple string message. +type BatchImportEvidenceToAssessmentControlError struct { + _ struct{} `type:"structure"` + + // The error code returned by the BatchImportEvidenceToAssessmentControl API. + ErrorCode *string `locationName:"errorCode" min:"3" type:"string"` + + // The error message returned by the BatchImportEvidenceToAssessmentControlError + // API. + ErrorMessage *string `locationName:"errorMessage" type:"string"` + + // Manual evidence that cannot be collected automatically by AWS Audit Manager. + ManualEvidence *ManualEvidence `locationName:"manualEvidence" type:"structure"` +} + +// String returns the string representation +func (s BatchImportEvidenceToAssessmentControlError) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s BatchImportEvidenceToAssessmentControlError) GoString() string { + return s.String() +} + +// SetErrorCode sets the ErrorCode field's value. +func (s *BatchImportEvidenceToAssessmentControlError) SetErrorCode(v string) *BatchImportEvidenceToAssessmentControlError { + s.ErrorCode = &v + return s +} + +// SetErrorMessage sets the ErrorMessage field's value. +func (s *BatchImportEvidenceToAssessmentControlError) SetErrorMessage(v string) *BatchImportEvidenceToAssessmentControlError { + s.ErrorMessage = &v + return s +} + +// SetManualEvidence sets the ManualEvidence field's value. +func (s *BatchImportEvidenceToAssessmentControlError) SetManualEvidence(v *ManualEvidence) *BatchImportEvidenceToAssessmentControlError { + s.ManualEvidence = v + return s +} + +type BatchImportEvidenceToAssessmentControlInput struct { + _ struct{} `type:"structure"` + + // The identifier for the specified assessment. + // + // AssessmentId is a required field + AssessmentId *string `location:"uri" locationName:"assessmentId" min:"36" type:"string" required:"true"` + + // The identifier for the specified control. + // + // ControlId is a required field + ControlId *string `location:"uri" locationName:"controlId" min:"36" type:"string" required:"true"` + + // The identifier for the specified control set. + // + // ControlSetId is a required field + ControlSetId *string `location:"uri" locationName:"controlSetId" min:"1" type:"string" required:"true"` + + // The list of manual evidence objects. + // + // ManualEvidence is a required field + ManualEvidence []*ManualEvidence `locationName:"manualEvidence" min:"1" type:"list" required:"true"` +} + +// String returns the string representation +func (s BatchImportEvidenceToAssessmentControlInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s BatchImportEvidenceToAssessmentControlInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *BatchImportEvidenceToAssessmentControlInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "BatchImportEvidenceToAssessmentControlInput"} + if s.AssessmentId == nil { + invalidParams.Add(request.NewErrParamRequired("AssessmentId")) + } + if s.AssessmentId != nil && len(*s.AssessmentId) < 36 { + invalidParams.Add(request.NewErrParamMinLen("AssessmentId", 36)) + } + if s.ControlId == nil { + invalidParams.Add(request.NewErrParamRequired("ControlId")) + } + if s.ControlId != nil && len(*s.ControlId) < 36 { + invalidParams.Add(request.NewErrParamMinLen("ControlId", 36)) + } + if s.ControlSetId == nil { + invalidParams.Add(request.NewErrParamRequired("ControlSetId")) + } + if s.ControlSetId != nil && len(*s.ControlSetId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ControlSetId", 1)) + } + if s.ManualEvidence == nil { + invalidParams.Add(request.NewErrParamRequired("ManualEvidence")) + } + if s.ManualEvidence != nil && len(s.ManualEvidence) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ManualEvidence", 1)) + } + if s.ManualEvidence != nil { + for i, v := range s.ManualEvidence { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "ManualEvidence", i), err.(request.ErrInvalidParams)) + } + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAssessmentId sets the AssessmentId field's value. +func (s *BatchImportEvidenceToAssessmentControlInput) SetAssessmentId(v string) *BatchImportEvidenceToAssessmentControlInput { + s.AssessmentId = &v + return s +} + +// SetControlId sets the ControlId field's value. +func (s *BatchImportEvidenceToAssessmentControlInput) SetControlId(v string) *BatchImportEvidenceToAssessmentControlInput { + s.ControlId = &v + return s +} + +// SetControlSetId sets the ControlSetId field's value. +func (s *BatchImportEvidenceToAssessmentControlInput) SetControlSetId(v string) *BatchImportEvidenceToAssessmentControlInput { + s.ControlSetId = &v + return s +} + +// SetManualEvidence sets the ManualEvidence field's value. +func (s *BatchImportEvidenceToAssessmentControlInput) SetManualEvidence(v []*ManualEvidence) *BatchImportEvidenceToAssessmentControlInput { + s.ManualEvidence = v + return s +} + +type BatchImportEvidenceToAssessmentControlOutput struct { + _ struct{} `type:"structure"` + + // A list of errors returned by the BatchImportEvidenceToAssessmentControl API. + Errors []*BatchImportEvidenceToAssessmentControlError `locationName:"errors" type:"list"` +} + +// String returns the string representation +func (s BatchImportEvidenceToAssessmentControlOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s BatchImportEvidenceToAssessmentControlOutput) GoString() string { + return s.String() +} + +// SetErrors sets the Errors field's value. +func (s *BatchImportEvidenceToAssessmentControlOutput) SetErrors(v []*BatchImportEvidenceToAssessmentControlError) *BatchImportEvidenceToAssessmentControlOutput { + s.Errors = v + return s +} + +// The record of a change within AWS Audit Manager, such as a modified assessment, +// a delegated control set, and so on. +type ChangeLog struct { + _ struct{} `type:"structure"` + + // The action performed. + Action *string `locationName:"action" type:"string" enum:"ActionEnum"` + + // The time of creation for the changelog object. + CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"` + + // The IAM user or role that performed the action. + CreatedBy *string `locationName:"createdBy" min:"20" type:"string"` + + // The name of the changelog object. + ObjectName *string `locationName:"objectName" min:"1" type:"string"` + + // The changelog object type, such as an assessment, control, or control set. + ObjectType *string `locationName:"objectType" type:"string" enum:"ObjectTypeEnum"` +} + +// String returns the string representation +func (s ChangeLog) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s ChangeLog) GoString() string { + return s.String() +} + +// SetAction sets the Action field's value. +func (s *ChangeLog) SetAction(v string) *ChangeLog { + s.Action = &v + return s +} + +// SetCreatedAt sets the CreatedAt field's value. +func (s *ChangeLog) SetCreatedAt(v time.Time) *ChangeLog { + s.CreatedAt = &v + return s +} + +// SetCreatedBy sets the CreatedBy field's value. +func (s *ChangeLog) SetCreatedBy(v string) *ChangeLog { + s.CreatedBy = &v + return s +} + +// SetObjectName sets the ObjectName field's value. +func (s *ChangeLog) SetObjectName(v string) *ChangeLog { + s.ObjectName = &v + return s +} + +// SetObjectType sets the ObjectType field's value. +func (s *ChangeLog) SetObjectType(v string) *ChangeLog { + s.ObjectType = &v + return s +} + +// A control in AWS Audit Manager. +type Control struct { + _ struct{} `type:"structure"` + + // The recommended actions to carry out if the control is not fulfilled. + ActionPlanInstructions *string `locationName:"actionPlanInstructions" type:"string"` + + // The title of the action plan for remediating the control. + ActionPlanTitle *string `locationName:"actionPlanTitle" type:"string"` + + // The Amazon Resource Name (ARN) of the specified control. + Arn *string `locationName:"arn" min:"20" type:"string"` + + // The data mapping sources for the specified control. + ControlMappingSources []*ControlMappingSource `locationName:"controlMappingSources" min:"1" type:"list"` + + // The data mapping sources for the specified control. + ControlSources *string `locationName:"controlSources" min:"1" type:"string"` + + // Specifies when the control was created. + CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"` + + // The IAM user or role that created the control. + CreatedBy *string `locationName:"createdBy" min:"1" type:"string"` + + // The description of the specified control. + Description *string `locationName:"description" type:"string"` + + // The unique identifier for the control. + Id *string `locationName:"id" min:"36" type:"string"` + + // Specifies when the control was most recently updated. + LastUpdatedAt *time.Time `locationName:"lastUpdatedAt" type:"timestamp"` + + // The IAM user or role that most recently updated the control. + LastUpdatedBy *string `locationName:"lastUpdatedBy" min:"1" type:"string"` + + // The name of the specified control. + Name *string `locationName:"name" min:"1" type:"string"` + + // The tags associated with the control. + Tags map[string]*string `locationName:"tags" type:"map"` + + // The steps to follow to determine if the control has been satisfied. + TestingInformation *string `locationName:"testingInformation" type:"string"` + + // The type of control, such as custom or standard. + Type *string `locationName:"type" type:"string" enum:"ControlType"` +} + +// String returns the string representation +func (s Control) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s Control) GoString() string { + return s.String() +} + +// SetActionPlanInstructions sets the ActionPlanInstructions field's value. +func (s *Control) SetActionPlanInstructions(v string) *Control { + s.ActionPlanInstructions = &v + return s +} + +// SetActionPlanTitle sets the ActionPlanTitle field's value. +func (s *Control) SetActionPlanTitle(v string) *Control { + s.ActionPlanTitle = &v + return s +} + +// SetArn sets the Arn field's value. +func (s *Control) SetArn(v string) *Control { + s.Arn = &v + return s +} + +// SetControlMappingSources sets the ControlMappingSources field's value. +func (s *Control) SetControlMappingSources(v []*ControlMappingSource) *Control { + s.ControlMappingSources = v + return s +} + +// SetControlSources sets the ControlSources field's value. +func (s *Control) SetControlSources(v string) *Control { + s.ControlSources = &v + return s +} + +// SetCreatedAt sets the CreatedAt field's value. +func (s *Control) SetCreatedAt(v time.Time) *Control { + s.CreatedAt = &v + return s +} + +// SetCreatedBy sets the CreatedBy field's value. +func (s *Control) SetCreatedBy(v string) *Control { + s.CreatedBy = &v + return s +} + +// SetDescription sets the Description field's value. +func (s *Control) SetDescription(v string) *Control { + s.Description = &v + return s +} + +// SetId sets the Id field's value. +func (s *Control) SetId(v string) *Control { + s.Id = &v + return s +} + +// SetLastUpdatedAt sets the LastUpdatedAt field's value. +func (s *Control) SetLastUpdatedAt(v time.Time) *Control { + s.LastUpdatedAt = &v + return s +} + +// SetLastUpdatedBy sets the LastUpdatedBy field's value. +func (s *Control) SetLastUpdatedBy(v string) *Control { + s.LastUpdatedBy = &v + return s +} + +// SetName sets the Name field's value. +func (s *Control) SetName(v string) *Control { + s.Name = &v + return s +} + +// SetTags sets the Tags field's value. +func (s *Control) SetTags(v map[string]*string) *Control { + s.Tags = v + return s +} + +// SetTestingInformation sets the TestingInformation field's value. +func (s *Control) SetTestingInformation(v string) *Control { + s.TestingInformation = &v + return s +} + +// SetType sets the Type field's value. +func (s *Control) SetType(v string) *Control { + s.Type = &v + return s +} + +// A comment posted by a user on a control. This includes the author's name, +// the comment text, and a timestamp. +type ControlComment struct { + _ struct{} `type:"structure"` + + // The name of the user who authored the comment. + AuthorName *string `locationName:"authorName" min:"1" type:"string"` + + // The body text of a control comment. + CommentBody *string `locationName:"commentBody" type:"string"` + + // The time when the comment was posted. + PostedDate *time.Time `locationName:"postedDate" type:"timestamp"` +} + +// String returns the string representation +func (s ControlComment) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s ControlComment) GoString() string { + return s.String() +} + +// SetAuthorName sets the AuthorName field's value. +func (s *ControlComment) SetAuthorName(v string) *ControlComment { + s.AuthorName = &v + return s +} + +// SetCommentBody sets the CommentBody field's value. +func (s *ControlComment) SetCommentBody(v string) *ControlComment { + s.CommentBody = &v + return s +} + +// SetPostedDate sets the PostedDate field's value. +func (s *ControlComment) SetPostedDate(v time.Time) *ControlComment { + s.PostedDate = &v + return s +} + +// The data source that determines from where AWS Audit Manager collects evidence +// for the control. +type ControlMappingSource struct { + _ struct{} `type:"structure"` + + // The description of the specified source. + SourceDescription *string `locationName:"sourceDescription" type:"string"` + + // The frequency of evidence collection for the specified control mapping source. + SourceFrequency *string `locationName:"sourceFrequency" type:"string" enum:"SourceFrequency"` + + // The unique identifier for the specified source. + SourceId *string `locationName:"sourceId" min:"36" type:"string"` + + // The keyword to search for in AWS CloudTrail logs. + SourceKeyword *SourceKeyword `locationName:"sourceKeyword" type:"structure"` + + // The name of the specified source. + SourceName *string `locationName:"sourceName" min:"1" type:"string"` + + // The setup option for the data source, which reflects if the evidence collection + // is automated or manual. + SourceSetUpOption *string `locationName:"sourceSetUpOption" type:"string" enum:"SourceSetUpOption"` + + // Specifies one of the five types of data sources for evidence collection. + SourceType *string `locationName:"sourceType" type:"string" enum:"SourceType"` + + // The instructions for troubleshooting the specified control. + TroubleshootingText *string `locationName:"troubleshootingText" type:"string"` +} + +// String returns the string representation +func (s ControlMappingSource) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s ControlMappingSource) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ControlMappingSource) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ControlMappingSource"} + if s.SourceId != nil && len(*s.SourceId) < 36 { + invalidParams.Add(request.NewErrParamMinLen("SourceId", 36)) + } + if s.SourceName != nil && len(*s.SourceName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("SourceName", 1)) + } + if s.SourceKeyword != nil { + if err := s.SourceKeyword.Validate(); err != nil { + invalidParams.AddNested("SourceKeyword", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetSourceDescription sets the SourceDescription field's value. +func (s *ControlMappingSource) SetSourceDescription(v string) *ControlMappingSource { + s.SourceDescription = &v + return s +} + +// SetSourceFrequency sets the SourceFrequency field's value. +func (s *ControlMappingSource) SetSourceFrequency(v string) *ControlMappingSource { + s.SourceFrequency = &v + return s +} + +// SetSourceId sets the SourceId field's value. +func (s *ControlMappingSource) SetSourceId(v string) *ControlMappingSource { + s.SourceId = &v + return s +} + +// SetSourceKeyword sets the SourceKeyword field's value. +func (s *ControlMappingSource) SetSourceKeyword(v *SourceKeyword) *ControlMappingSource { + s.SourceKeyword = v + return s +} + +// SetSourceName sets the SourceName field's value. +func (s *ControlMappingSource) SetSourceName(v string) *ControlMappingSource { + s.SourceName = &v + return s +} + +// SetSourceSetUpOption sets the SourceSetUpOption field's value. +func (s *ControlMappingSource) SetSourceSetUpOption(v string) *ControlMappingSource { + s.SourceSetUpOption = &v + return s +} + +// SetSourceType sets the SourceType field's value. +func (s *ControlMappingSource) SetSourceType(v string) *ControlMappingSource { + s.SourceType = &v + return s +} + +// SetTroubleshootingText sets the TroubleshootingText field's value. +func (s *ControlMappingSource) SetTroubleshootingText(v string) *ControlMappingSource { + s.TroubleshootingText = &v + return s +} + +// The metadata associated with the specified standard or custom control. +type ControlMetadata struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the specified control. + Arn *string `locationName:"arn" min:"20" type:"string"` + + // The data source that determines from where AWS Audit Manager collects evidence + // for the control. + ControlSources *string `locationName:"controlSources" min:"1" type:"string"` + + // Specifies when the control was created. + CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"` + + // The unique identifier for the specified control. + Id *string `locationName:"id" min:"36" type:"string"` + + // Specifies when the control was most recently updated. + LastUpdatedAt *time.Time `locationName:"lastUpdatedAt" type:"timestamp"` + + // The name of the specified control. + Name *string `locationName:"name" min:"1" type:"string"` +} + +// String returns the string representation +func (s ControlMetadata) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s ControlMetadata) GoString() string { + return s.String() +} + +// SetArn sets the Arn field's value. +func (s *ControlMetadata) SetArn(v string) *ControlMetadata { + s.Arn = &v + return s +} + +// SetControlSources sets the ControlSources field's value. +func (s *ControlMetadata) SetControlSources(v string) *ControlMetadata { + s.ControlSources = &v + return s +} + +// SetCreatedAt sets the CreatedAt field's value. +func (s *ControlMetadata) SetCreatedAt(v time.Time) *ControlMetadata { + s.CreatedAt = &v + return s +} + +// SetId sets the Id field's value. +func (s *ControlMetadata) SetId(v string) *ControlMetadata { + s.Id = &v + return s +} + +// SetLastUpdatedAt sets the LastUpdatedAt field's value. +func (s *ControlMetadata) SetLastUpdatedAt(v time.Time) *ControlMetadata { + s.LastUpdatedAt = &v + return s +} + +// SetName sets the Name field's value. +func (s *ControlMetadata) SetName(v string) *ControlMetadata { + s.Name = &v + return s +} + +// A set of controls in AWS Audit Manager. +type ControlSet struct { + _ struct{} `type:"structure"` + + // The list of controls within the control set. + Controls []*Control `locationName:"controls" min:"1" type:"list"` + + // The identifier of the control set in the assessment. This is the control + // set name in a plain string format. + Id *string `locationName:"id" min:"36" type:"string"` + + // The name of the control set. + Name *string `locationName:"name" min:"1" type:"string"` +} + +// String returns the string representation +func (s ControlSet) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s ControlSet) GoString() string { + return s.String() +} + +// SetControls sets the Controls field's value. +func (s *ControlSet) SetControls(v []*Control) *ControlSet { + s.Controls = v + return s +} + +// SetId sets the Id field's value. +func (s *ControlSet) SetId(v string) *ControlSet { + s.Id = &v + return s +} + +// SetName sets the Name field's value. +func (s *ControlSet) SetName(v string) *ControlSet { + s.Name = &v + return s +} + +// Control entity attributes that uniquely identify an existing control to be +// added to a framework in AWS Audit Manager. +type CreateAssessmentFrameworkControl struct { + _ struct{} `type:"structure"` + + // The unique identifier of the control. + Id *string `locationName:"id" min:"36" type:"string"` +} + +// String returns the string representation +func (s CreateAssessmentFrameworkControl) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s CreateAssessmentFrameworkControl) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CreateAssessmentFrameworkControl) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreateAssessmentFrameworkControl"} + if s.Id != nil && len(*s.Id) < 36 { + invalidParams.Add(request.NewErrParamMinLen("Id", 36)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetId sets the Id field's value. +func (s *CreateAssessmentFrameworkControl) SetId(v string) *CreateAssessmentFrameworkControl { + s.Id = &v + return s +} + +// A controlSet entity that represents a collection of controls in AWS Audit +// Manager. This does not contain the control set ID. +type CreateAssessmentFrameworkControlSet struct { + _ struct{} `type:"structure"` + + // The list of controls within the control set. This does not contain the control + // set ID. + Controls []*CreateAssessmentFrameworkControl `locationName:"controls" min:"1" type:"list"` + + // The name of the specified control set. + Name *string `locationName:"name" min:"1" type:"string"` +} + +// String returns the string representation +func (s CreateAssessmentFrameworkControlSet) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s CreateAssessmentFrameworkControlSet) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CreateAssessmentFrameworkControlSet) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreateAssessmentFrameworkControlSet"} + if s.Controls != nil && len(s.Controls) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Controls", 1)) + } + if s.Name != nil && len(*s.Name) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Name", 1)) + } + if s.Controls != nil { + for i, v := range s.Controls { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Controls", i), err.(request.ErrInvalidParams)) + } + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetControls sets the Controls field's value. +func (s *CreateAssessmentFrameworkControlSet) SetControls(v []*CreateAssessmentFrameworkControl) *CreateAssessmentFrameworkControlSet { + s.Controls = v + return s +} + +// SetName sets the Name field's value. +func (s *CreateAssessmentFrameworkControlSet) SetName(v string) *CreateAssessmentFrameworkControlSet { + s.Name = &v + return s +} + +type CreateAssessmentFrameworkInput struct { + _ struct{} `type:"structure"` + + // The compliance type that the new custom framework supports, such as CIS or + // HIPAA. + ComplianceType *string `locationName:"complianceType" type:"string"` + + // The control sets to be associated with the framework. + // + // ControlSets is a required field + ControlSets []*CreateAssessmentFrameworkControlSet `locationName:"controlSets" min:"1" type:"list" required:"true"` + + // An optional description for the new custom framework. + Description *string `locationName:"description" min:"1" type:"string"` + + // The name of the new custom framework. + // + // Name is a required field + Name *string `locationName:"name" min:"1" type:"string" required:"true"` +} + +// String returns the string representation +func (s CreateAssessmentFrameworkInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s CreateAssessmentFrameworkInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CreateAssessmentFrameworkInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreateAssessmentFrameworkInput"} + if s.ControlSets == nil { + invalidParams.Add(request.NewErrParamRequired("ControlSets")) + } + if s.ControlSets != nil && len(s.ControlSets) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ControlSets", 1)) + } + if s.Description != nil && len(*s.Description) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Description", 1)) + } + if s.Name == nil { + invalidParams.Add(request.NewErrParamRequired("Name")) + } + if s.Name != nil && len(*s.Name) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Name", 1)) + } + if s.ControlSets != nil { + for i, v := range s.ControlSets { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "ControlSets", i), err.(request.ErrInvalidParams)) + } + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetComplianceType sets the ComplianceType field's value. +func (s *CreateAssessmentFrameworkInput) SetComplianceType(v string) *CreateAssessmentFrameworkInput { + s.ComplianceType = &v + return s +} + +// SetControlSets sets the ControlSets field's value. +func (s *CreateAssessmentFrameworkInput) SetControlSets(v []*CreateAssessmentFrameworkControlSet) *CreateAssessmentFrameworkInput { + s.ControlSets = v + return s +} + +// SetDescription sets the Description field's value. +func (s *CreateAssessmentFrameworkInput) SetDescription(v string) *CreateAssessmentFrameworkInput { + s.Description = &v + return s +} + +// SetName sets the Name field's value. +func (s *CreateAssessmentFrameworkInput) SetName(v string) *CreateAssessmentFrameworkInput { + s.Name = &v + return s +} + +type CreateAssessmentFrameworkOutput struct { + _ struct{} `type:"structure"` + + // The name of the new framework returned by the CreateAssessmentFramework API. + Framework *Framework `locationName:"framework" type:"structure"` +} + +// String returns the string representation +func (s CreateAssessmentFrameworkOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s CreateAssessmentFrameworkOutput) GoString() string { + return s.String() +} + +// SetFramework sets the Framework field's value. +func (s *CreateAssessmentFrameworkOutput) SetFramework(v *Framework) *CreateAssessmentFrameworkOutput { + s.Framework = v + return s +} + +type CreateAssessmentInput struct { + _ struct{} `type:"structure"` + + // The assessment report storage destination for the specified assessment that + // is being created. + // + // AssessmentReportsDestination is a required field + AssessmentReportsDestination *AssessmentReportsDestination `locationName:"assessmentReportsDestination" type:"structure" required:"true"` + + // The optional description of the assessment to be created. + Description *string `locationName:"description" type:"string"` + + // The identifier for the specified framework. + // + // FrameworkId is a required field + FrameworkId *string `locationName:"frameworkId" min:"36" type:"string" required:"true"` + + // The name of the assessment to be created. + // + // Name is a required field + Name *string `locationName:"name" min:"1" type:"string" required:"true"` + + // The list of roles for the specified assessment. + // + // Roles is a required field + Roles []*Role `locationName:"roles" type:"list" required:"true"` + + // The wrapper that contains the AWS accounts and AWS services in scope for + // the assessment. + // + // Scope is a required field + Scope *Scope `locationName:"scope" type:"structure" required:"true"` + + // The tags associated with the assessment. + Tags map[string]*string `locationName:"tags" type:"map"` +} + +// String returns the string representation +func (s CreateAssessmentInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s CreateAssessmentInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CreateAssessmentInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreateAssessmentInput"} + if s.AssessmentReportsDestination == nil { + invalidParams.Add(request.NewErrParamRequired("AssessmentReportsDestination")) + } + if s.FrameworkId == nil { + invalidParams.Add(request.NewErrParamRequired("FrameworkId")) + } + if s.FrameworkId != nil && len(*s.FrameworkId) < 36 { + invalidParams.Add(request.NewErrParamMinLen("FrameworkId", 36)) + } + if s.Name == nil { + invalidParams.Add(request.NewErrParamRequired("Name")) + } + if s.Name != nil && len(*s.Name) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Name", 1)) + } + if s.Roles == nil { + invalidParams.Add(request.NewErrParamRequired("Roles")) + } + if s.Scope == nil { + invalidParams.Add(request.NewErrParamRequired("Scope")) + } + if s.AssessmentReportsDestination != nil { + if err := s.AssessmentReportsDestination.Validate(); err != nil { + invalidParams.AddNested("AssessmentReportsDestination", err.(request.ErrInvalidParams)) + } + } + if s.Roles != nil { + for i, v := range s.Roles { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Roles", i), err.(request.ErrInvalidParams)) + } + } + } + if s.Scope != nil { + if err := s.Scope.Validate(); err != nil { + invalidParams.AddNested("Scope", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAssessmentReportsDestination sets the AssessmentReportsDestination field's value. +func (s *CreateAssessmentInput) SetAssessmentReportsDestination(v *AssessmentReportsDestination) *CreateAssessmentInput { + s.AssessmentReportsDestination = v + return s +} + +// SetDescription sets the Description field's value. +func (s *CreateAssessmentInput) SetDescription(v string) *CreateAssessmentInput { + s.Description = &v + return s +} + +// SetFrameworkId sets the FrameworkId field's value. +func (s *CreateAssessmentInput) SetFrameworkId(v string) *CreateAssessmentInput { + s.FrameworkId = &v + return s +} + +// SetName sets the Name field's value. +func (s *CreateAssessmentInput) SetName(v string) *CreateAssessmentInput { + s.Name = &v + return s +} + +// SetRoles sets the Roles field's value. +func (s *CreateAssessmentInput) SetRoles(v []*Role) *CreateAssessmentInput { + s.Roles = v + return s +} + +// SetScope sets the Scope field's value. +func (s *CreateAssessmentInput) SetScope(v *Scope) *CreateAssessmentInput { + s.Scope = v + return s +} + +// SetTags sets the Tags field's value. +func (s *CreateAssessmentInput) SetTags(v map[string]*string) *CreateAssessmentInput { + s.Tags = v + return s +} + +type CreateAssessmentOutput struct { + _ struct{} `type:"structure"` + + // An entity that defines the scope of audit evidence collected by AWS Audit + // Manager. An AWS Audit Manager assessment is an implementation of an AWS Audit + // Manager framework. + Assessment *Assessment `locationName:"assessment" type:"structure"` +} + +// String returns the string representation +func (s CreateAssessmentOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s CreateAssessmentOutput) GoString() string { + return s.String() +} + +// SetAssessment sets the Assessment field's value. +func (s *CreateAssessmentOutput) SetAssessment(v *Assessment) *CreateAssessmentOutput { + s.Assessment = v + return s +} + +type CreateAssessmentReportInput struct { + _ struct{} `type:"structure"` + + // The identifier for the specified assessment. + // + // AssessmentId is a required field + AssessmentId *string `location:"uri" locationName:"assessmentId" min:"36" type:"string" required:"true"` + + // The description of the assessment report. + Description *string `locationName:"description" type:"string"` + + // The name of the new assessment report. + // + // Name is a required field + Name *string `locationName:"name" min:"1" type:"string" required:"true"` +} + +// String returns the string representation +func (s CreateAssessmentReportInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s CreateAssessmentReportInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CreateAssessmentReportInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreateAssessmentReportInput"} + if s.AssessmentId == nil { + invalidParams.Add(request.NewErrParamRequired("AssessmentId")) + } + if s.AssessmentId != nil && len(*s.AssessmentId) < 36 { + invalidParams.Add(request.NewErrParamMinLen("AssessmentId", 36)) + } + if s.Name == nil { + invalidParams.Add(request.NewErrParamRequired("Name")) + } + if s.Name != nil && len(*s.Name) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Name", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAssessmentId sets the AssessmentId field's value. +func (s *CreateAssessmentReportInput) SetAssessmentId(v string) *CreateAssessmentReportInput { + s.AssessmentId = &v + return s +} + +// SetDescription sets the Description field's value. +func (s *CreateAssessmentReportInput) SetDescription(v string) *CreateAssessmentReportInput { + s.Description = &v + return s +} + +// SetName sets the Name field's value. +func (s *CreateAssessmentReportInput) SetName(v string) *CreateAssessmentReportInput { + s.Name = &v + return s +} + +type CreateAssessmentReportOutput struct { + _ struct{} `type:"structure"` + + // The new assessment report returned by the CreateAssessmentReport API. + AssessmentReport *AssessmentReport `locationName:"assessmentReport" type:"structure"` +} + +// String returns the string representation +func (s CreateAssessmentReportOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s CreateAssessmentReportOutput) GoString() string { + return s.String() +} + +// SetAssessmentReport sets the AssessmentReport field's value. +func (s *CreateAssessmentReportOutput) SetAssessmentReport(v *AssessmentReport) *CreateAssessmentReportOutput { + s.AssessmentReport = v + return s +} + +type CreateControlInput struct { + _ struct{} `type:"structure"` + + // The recommended actions to carry out if the control is not fulfilled. + ActionPlanInstructions *string `locationName:"actionPlanInstructions" type:"string"` + + // The title of the action plan for remediating the control. + ActionPlanTitle *string `locationName:"actionPlanTitle" type:"string"` + + // The data source that determines from where AWS Audit Manager collects evidence + // for the control. + // + // ControlMappingSources is a required field + ControlMappingSources []*CreateControlMappingSource `locationName:"controlMappingSources" min:"1" type:"list" required:"true"` + + // The description of the control. + Description *string `locationName:"description" type:"string"` + + // The name of the control. + // + // Name is a required field + Name *string `locationName:"name" min:"1" type:"string" required:"true"` + + // The tags associated with the control. + Tags map[string]*string `locationName:"tags" type:"map"` + + // The steps to follow to determine if the control has been satisfied. + TestingInformation *string `locationName:"testingInformation" type:"string"` +} + +// String returns the string representation +func (s CreateControlInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s CreateControlInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CreateControlInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreateControlInput"} + if s.ControlMappingSources == nil { + invalidParams.Add(request.NewErrParamRequired("ControlMappingSources")) + } + if s.ControlMappingSources != nil && len(s.ControlMappingSources) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ControlMappingSources", 1)) + } + if s.Name == nil { + invalidParams.Add(request.NewErrParamRequired("Name")) + } + if s.Name != nil && len(*s.Name) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Name", 1)) + } + if s.ControlMappingSources != nil { + for i, v := range s.ControlMappingSources { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "ControlMappingSources", i), err.(request.ErrInvalidParams)) + } + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetActionPlanInstructions sets the ActionPlanInstructions field's value. +func (s *CreateControlInput) SetActionPlanInstructions(v string) *CreateControlInput { + s.ActionPlanInstructions = &v + return s +} + +// SetActionPlanTitle sets the ActionPlanTitle field's value. +func (s *CreateControlInput) SetActionPlanTitle(v string) *CreateControlInput { + s.ActionPlanTitle = &v + return s +} + +// SetControlMappingSources sets the ControlMappingSources field's value. +func (s *CreateControlInput) SetControlMappingSources(v []*CreateControlMappingSource) *CreateControlInput { + s.ControlMappingSources = v + return s +} + +// SetDescription sets the Description field's value. +func (s *CreateControlInput) SetDescription(v string) *CreateControlInput { + s.Description = &v + return s +} + +// SetName sets the Name field's value. +func (s *CreateControlInput) SetName(v string) *CreateControlInput { + s.Name = &v + return s +} + +// SetTags sets the Tags field's value. +func (s *CreateControlInput) SetTags(v map[string]*string) *CreateControlInput { + s.Tags = v + return s +} + +// SetTestingInformation sets the TestingInformation field's value. +func (s *CreateControlInput) SetTestingInformation(v string) *CreateControlInput { + s.TestingInformation = &v + return s +} + +// Control mapping fields that represent the source for evidence collection, +// along with related parameters and metadata. This does not contain mappingID. +type CreateControlMappingSource struct { + _ struct{} `type:"structure"` + + // The description of the data source that determines from where AWS Audit Manager + // collects evidence for the control. + SourceDescription *string `locationName:"sourceDescription" type:"string"` + + // The frequency of evidence collection for the specified control mapping source. + SourceFrequency *string `locationName:"sourceFrequency" type:"string" enum:"SourceFrequency"` + + // The keyword to search for in AWS CloudTrail logs. + SourceKeyword *SourceKeyword `locationName:"sourceKeyword" type:"structure"` + + // The name of the control mapping data source. + SourceName *string `locationName:"sourceName" min:"1" type:"string"` + + // The setup option for the data source, which reflects if the evidence collection + // is automated or manual. + SourceSetUpOption *string `locationName:"sourceSetUpOption" type:"string" enum:"SourceSetUpOption"` + + // Specifies one of the five types of data sources for evidence collection. + SourceType *string `locationName:"sourceType" type:"string" enum:"SourceType"` + + // The instructions for troubleshooting the specified control. + TroubleshootingText *string `locationName:"troubleshootingText" type:"string"` +} + +// String returns the string representation +func (s CreateControlMappingSource) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s CreateControlMappingSource) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CreateControlMappingSource) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreateControlMappingSource"} + if s.SourceName != nil && len(*s.SourceName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("SourceName", 1)) + } + if s.SourceKeyword != nil { + if err := s.SourceKeyword.Validate(); err != nil { + invalidParams.AddNested("SourceKeyword", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetSourceDescription sets the SourceDescription field's value. +func (s *CreateControlMappingSource) SetSourceDescription(v string) *CreateControlMappingSource { + s.SourceDescription = &v + return s +} + +// SetSourceFrequency sets the SourceFrequency field's value. +func (s *CreateControlMappingSource) SetSourceFrequency(v string) *CreateControlMappingSource { + s.SourceFrequency = &v + return s +} + +// SetSourceKeyword sets the SourceKeyword field's value. +func (s *CreateControlMappingSource) SetSourceKeyword(v *SourceKeyword) *CreateControlMappingSource { + s.SourceKeyword = v + return s +} + +// SetSourceName sets the SourceName field's value. +func (s *CreateControlMappingSource) SetSourceName(v string) *CreateControlMappingSource { + s.SourceName = &v + return s +} + +// SetSourceSetUpOption sets the SourceSetUpOption field's value. +func (s *CreateControlMappingSource) SetSourceSetUpOption(v string) *CreateControlMappingSource { + s.SourceSetUpOption = &v + return s +} + +// SetSourceType sets the SourceType field's value. +func (s *CreateControlMappingSource) SetSourceType(v string) *CreateControlMappingSource { + s.SourceType = &v + return s +} + +// SetTroubleshootingText sets the TroubleshootingText field's value. +func (s *CreateControlMappingSource) SetTroubleshootingText(v string) *CreateControlMappingSource { + s.TroubleshootingText = &v + return s +} + +type CreateControlOutput struct { + _ struct{} `type:"structure"` + + // The new control returned by the CreateControl API. + Control *Control `locationName:"control" type:"structure"` +} + +// String returns the string representation +func (s CreateControlOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s CreateControlOutput) GoString() string { + return s.String() +} + +// SetControl sets the Control field's value. +func (s *CreateControlOutput) SetControl(v *Control) *CreateControlOutput { + s.Control = v + return s +} + +// A collection of attributes used to create a delegation for an assessment +// in AWS Audit Manager. +type CreateDelegationRequest struct { + _ struct{} `type:"structure"` + + // A comment related to the delegation request. + Comment *string `locationName:"comment" type:"string"` + + // The unique identifier for the control set. + ControlSetId *string `locationName:"controlSetId" min:"1" type:"string"` + + // The Amazon Resource Name (ARN) of the IAM role. + RoleArn *string `locationName:"roleArn" min:"20" type:"string"` + + // 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. + RoleType *string `locationName:"roleType" type:"string" enum:"RoleType"` +} + +// String returns the string representation +func (s CreateDelegationRequest) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s CreateDelegationRequest) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CreateDelegationRequest) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreateDelegationRequest"} + if s.ControlSetId != nil && len(*s.ControlSetId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ControlSetId", 1)) + } + if s.RoleArn != nil && len(*s.RoleArn) < 20 { + invalidParams.Add(request.NewErrParamMinLen("RoleArn", 20)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetComment sets the Comment field's value. +func (s *CreateDelegationRequest) SetComment(v string) *CreateDelegationRequest { + s.Comment = &v + return s +} + +// SetControlSetId sets the ControlSetId field's value. +func (s *CreateDelegationRequest) SetControlSetId(v string) *CreateDelegationRequest { + s.ControlSetId = &v + return s +} + +// SetRoleArn sets the RoleArn field's value. +func (s *CreateDelegationRequest) SetRoleArn(v string) *CreateDelegationRequest { + s.RoleArn = &v + return s +} + +// SetRoleType sets the RoleType field's value. +func (s *CreateDelegationRequest) SetRoleType(v string) *CreateDelegationRequest { + s.RoleType = &v + return s +} + +// The assignment of a control set to a delegate for review. +type Delegation struct { + _ struct{} `type:"structure"` + + // The identifier for the associated assessment. + AssessmentId *string `locationName:"assessmentId" min:"36" type:"string"` + + // The name of the associated assessment. + AssessmentName *string `locationName:"assessmentName" min:"1" type:"string"` + + // The comment related to the delegation. + Comment *string `locationName:"comment" type:"string"` + + // The identifier for the associated control set. + ControlSetId *string `locationName:"controlSetId" min:"1" type:"string"` + + // The IAM user or role that created the delegation. + CreatedBy *string `locationName:"createdBy" min:"1" type:"string"` + + // Specifies when the delegation was created. + CreationTime *time.Time `locationName:"creationTime" type:"timestamp"` + + // The unique identifier for the delegation. + Id *string `locationName:"id" min:"36" type:"string"` + + // Specifies when the delegation was last updated. + LastUpdated *time.Time `locationName:"lastUpdated" type:"timestamp"` + + // The Amazon Resource Name (ARN) of the IAM role. + RoleArn *string `locationName:"roleArn" min:"20" type:"string"` + + // 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. + RoleType *string `locationName:"roleType" type:"string" enum:"RoleType"` + + // The status of the delegation. + Status *string `locationName:"status" type:"string" enum:"DelegationStatus"` +} + +// String returns the string representation +func (s Delegation) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s Delegation) GoString() string { + return s.String() +} + +// SetAssessmentId sets the AssessmentId field's value. +func (s *Delegation) SetAssessmentId(v string) *Delegation { + s.AssessmentId = &v + return s +} + +// SetAssessmentName sets the AssessmentName field's value. +func (s *Delegation) SetAssessmentName(v string) *Delegation { + s.AssessmentName = &v + return s +} + +// SetComment sets the Comment field's value. +func (s *Delegation) SetComment(v string) *Delegation { + s.Comment = &v + return s +} + +// SetControlSetId sets the ControlSetId field's value. +func (s *Delegation) SetControlSetId(v string) *Delegation { + s.ControlSetId = &v + return s +} + +// SetCreatedBy sets the CreatedBy field's value. +func (s *Delegation) SetCreatedBy(v string) *Delegation { + s.CreatedBy = &v + return s +} + +// SetCreationTime sets the CreationTime field's value. +func (s *Delegation) SetCreationTime(v time.Time) *Delegation { + s.CreationTime = &v + return s +} + +// SetId sets the Id field's value. +func (s *Delegation) SetId(v string) *Delegation { + s.Id = &v + return s +} + +// SetLastUpdated sets the LastUpdated field's value. +func (s *Delegation) SetLastUpdated(v time.Time) *Delegation { + s.LastUpdated = &v + return s +} + +// SetRoleArn sets the RoleArn field's value. +func (s *Delegation) SetRoleArn(v string) *Delegation { + s.RoleArn = &v + return s +} + +// SetRoleType sets the RoleType field's value. +func (s *Delegation) SetRoleType(v string) *Delegation { + s.RoleType = &v + return s +} + +// SetStatus sets the Status field's value. +func (s *Delegation) SetStatus(v string) *Delegation { + s.Status = &v + return s +} + +// The metadata associated with the specified delegation. +type DelegationMetadata struct { + _ struct{} `type:"structure"` + + // The unique identifier for the specified assessment. + AssessmentId *string `locationName:"assessmentId" min:"36" type:"string"` + + // The name of the associated assessment. + AssessmentName *string `locationName:"assessmentName" min:"1" type:"string"` + + // Specifies the name of the control set delegated for review. + ControlSetName *string `locationName:"controlSetName" min:"1" type:"string"` + + // Specifies when the delegation was created. + CreationTime *time.Time `locationName:"creationTime" type:"timestamp"` + + // The unique identifier for the delegation. + Id *string `locationName:"id" min:"36" type:"string"` + + // The Amazon Resource Name (ARN) of the IAM role. + RoleArn *string `locationName:"roleArn" min:"20" type:"string"` + + // The current status of the delgation. + Status *string `locationName:"status" type:"string" enum:"DelegationStatus"` +} + +// String returns the string representation +func (s DelegationMetadata) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s DelegationMetadata) GoString() string { + return s.String() +} + +// SetAssessmentId sets the AssessmentId field's value. +func (s *DelegationMetadata) SetAssessmentId(v string) *DelegationMetadata { + s.AssessmentId = &v + return s +} + +// SetAssessmentName sets the AssessmentName field's value. +func (s *DelegationMetadata) SetAssessmentName(v string) *DelegationMetadata { + s.AssessmentName = &v + return s +} + +// SetControlSetName sets the ControlSetName field's value. +func (s *DelegationMetadata) SetControlSetName(v string) *DelegationMetadata { + s.ControlSetName = &v + return s +} + +// SetCreationTime sets the CreationTime field's value. +func (s *DelegationMetadata) SetCreationTime(v time.Time) *DelegationMetadata { + s.CreationTime = &v + return s +} + +// SetId sets the Id field's value. +func (s *DelegationMetadata) SetId(v string) *DelegationMetadata { + s.Id = &v + return s +} + +// SetRoleArn sets the RoleArn field's value. +func (s *DelegationMetadata) SetRoleArn(v string) *DelegationMetadata { + s.RoleArn = &v + return s +} + +// SetStatus sets the Status field's value. +func (s *DelegationMetadata) SetStatus(v string) *DelegationMetadata { + s.Status = &v + return s +} + +type DeleteAssessmentFrameworkInput struct { + _ struct{} `type:"structure"` + + // The identifier for the specified framework. + // + // FrameworkId is a required field + FrameworkId *string `location:"uri" locationName:"frameworkId" min:"36" type:"string" required:"true"` +} + +// String returns the string representation +func (s DeleteAssessmentFrameworkInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s DeleteAssessmentFrameworkInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DeleteAssessmentFrameworkInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeleteAssessmentFrameworkInput"} + if s.FrameworkId == nil { + invalidParams.Add(request.NewErrParamRequired("FrameworkId")) + } + if s.FrameworkId != nil && len(*s.FrameworkId) < 36 { + invalidParams.Add(request.NewErrParamMinLen("FrameworkId", 36)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetFrameworkId sets the FrameworkId field's value. +func (s *DeleteAssessmentFrameworkInput) SetFrameworkId(v string) *DeleteAssessmentFrameworkInput { + s.FrameworkId = &v + return s +} + +type DeleteAssessmentFrameworkOutput struct { + _ struct{} `type:"structure"` +} + +// String returns the string representation +func (s DeleteAssessmentFrameworkOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s DeleteAssessmentFrameworkOutput) GoString() string { + return s.String() +} + +type DeleteAssessmentInput struct { + _ struct{} `type:"structure"` + + // The identifier for the specified assessment. + // + // AssessmentId is a required field + AssessmentId *string `location:"uri" locationName:"assessmentId" min:"36" type:"string" required:"true"` +} + +// String returns the string representation +func (s DeleteAssessmentInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s DeleteAssessmentInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DeleteAssessmentInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeleteAssessmentInput"} + if s.AssessmentId == nil { + invalidParams.Add(request.NewErrParamRequired("AssessmentId")) + } + if s.AssessmentId != nil && len(*s.AssessmentId) < 36 { + invalidParams.Add(request.NewErrParamMinLen("AssessmentId", 36)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAssessmentId sets the AssessmentId field's value. +func (s *DeleteAssessmentInput) SetAssessmentId(v string) *DeleteAssessmentInput { + s.AssessmentId = &v + return s +} + +type DeleteAssessmentOutput struct { + _ struct{} `type:"structure"` +} + +// String returns the string representation +func (s DeleteAssessmentOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s DeleteAssessmentOutput) GoString() string { + return s.String() +} + +type DeleteAssessmentReportInput struct { + _ struct{} `type:"structure"` + + // The identifier for the specified assessment. + // + // AssessmentId is a required field + AssessmentId *string `location:"uri" locationName:"assessmentId" min:"36" type:"string" required:"true"` + + // The unique identifier for the assessment report. + // + // AssessmentReportId is a required field + AssessmentReportId *string `location:"uri" locationName:"assessmentReportId" min:"36" type:"string" required:"true"` +} + +// String returns the string representation +func (s DeleteAssessmentReportInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s DeleteAssessmentReportInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DeleteAssessmentReportInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeleteAssessmentReportInput"} + if s.AssessmentId == nil { + invalidParams.Add(request.NewErrParamRequired("AssessmentId")) + } + if s.AssessmentId != nil && len(*s.AssessmentId) < 36 { + invalidParams.Add(request.NewErrParamMinLen("AssessmentId", 36)) + } + if s.AssessmentReportId == nil { + invalidParams.Add(request.NewErrParamRequired("AssessmentReportId")) + } + if s.AssessmentReportId != nil && len(*s.AssessmentReportId) < 36 { + invalidParams.Add(request.NewErrParamMinLen("AssessmentReportId", 36)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAssessmentId sets the AssessmentId field's value. +func (s *DeleteAssessmentReportInput) SetAssessmentId(v string) *DeleteAssessmentReportInput { + s.AssessmentId = &v + return s +} + +// SetAssessmentReportId sets the AssessmentReportId field's value. +func (s *DeleteAssessmentReportInput) SetAssessmentReportId(v string) *DeleteAssessmentReportInput { + s.AssessmentReportId = &v + return s +} + +type DeleteAssessmentReportOutput struct { + _ struct{} `type:"structure"` +} + +// String returns the string representation +func (s DeleteAssessmentReportOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s DeleteAssessmentReportOutput) GoString() string { + return s.String() +} + +type DeleteControlInput struct { + _ struct{} `type:"structure"` + + // The identifier for the specified control. + // + // ControlId is a required field + ControlId *string `location:"uri" locationName:"controlId" min:"36" type:"string" required:"true"` +} + +// String returns the string representation +func (s DeleteControlInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s DeleteControlInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DeleteControlInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeleteControlInput"} + if s.ControlId == nil { + invalidParams.Add(request.NewErrParamRequired("ControlId")) + } + if s.ControlId != nil && len(*s.ControlId) < 36 { + invalidParams.Add(request.NewErrParamMinLen("ControlId", 36)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetControlId sets the ControlId field's value. +func (s *DeleteControlInput) SetControlId(v string) *DeleteControlInput { + s.ControlId = &v + return s +} + +type DeleteControlOutput struct { + _ struct{} `type:"structure"` +} + +// String returns the string representation +func (s DeleteControlOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s DeleteControlOutput) GoString() string { + return s.String() +} + +type DeregisterAccountInput struct { + _ struct{} `type:"structure"` +} + +// String returns the string representation +func (s DeregisterAccountInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s DeregisterAccountInput) GoString() string { + return s.String() +} + +type DeregisterAccountOutput struct { + _ struct{} `type:"structure"` + + // The registration status of the account. + Status *string `locationName:"status" type:"string" enum:"AccountStatus"` +} + +// String returns the string representation +func (s DeregisterAccountOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s DeregisterAccountOutput) GoString() string { + return s.String() +} + +// SetStatus sets the Status field's value. +func (s *DeregisterAccountOutput) SetStatus(v string) *DeregisterAccountOutput { + s.Status = &v + return s +} + +type DeregisterOrganizationAdminAccountInput struct { + _ struct{} `type:"structure"` + + // The identifier for the specified administrator account. + AdminAccountId *string `locationName:"adminAccountId" min:"12" type:"string"` +} + +// String returns the string representation +func (s DeregisterOrganizationAdminAccountInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s DeregisterOrganizationAdminAccountInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DeregisterOrganizationAdminAccountInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeregisterOrganizationAdminAccountInput"} + if s.AdminAccountId != nil && len(*s.AdminAccountId) < 12 { + invalidParams.Add(request.NewErrParamMinLen("AdminAccountId", 12)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAdminAccountId sets the AdminAccountId field's value. +func (s *DeregisterOrganizationAdminAccountInput) SetAdminAccountId(v string) *DeregisterOrganizationAdminAccountInput { + s.AdminAccountId = &v + return s +} + +type DeregisterOrganizationAdminAccountOutput struct { + _ struct{} `type:"structure"` +} + +// String returns the string representation +func (s DeregisterOrganizationAdminAccountOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s DeregisterOrganizationAdminAccountOutput) GoString() string { + return s.String() +} + +type DisassociateAssessmentReportEvidenceFolderInput struct { + _ struct{} `type:"structure"` + + // The identifier for the specified assessment. + // + // AssessmentId is a required field + AssessmentId *string `location:"uri" locationName:"assessmentId" min:"36" type:"string" required:"true"` + + // The identifier for the folder in which evidence is stored. + // + // EvidenceFolderId is a required field + EvidenceFolderId *string `locationName:"evidenceFolderId" min:"36" type:"string" required:"true"` +} + +// String returns the string representation +func (s DisassociateAssessmentReportEvidenceFolderInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s DisassociateAssessmentReportEvidenceFolderInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DisassociateAssessmentReportEvidenceFolderInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DisassociateAssessmentReportEvidenceFolderInput"} + if s.AssessmentId == nil { + invalidParams.Add(request.NewErrParamRequired("AssessmentId")) + } + if s.AssessmentId != nil && len(*s.AssessmentId) < 36 { + invalidParams.Add(request.NewErrParamMinLen("AssessmentId", 36)) + } + if s.EvidenceFolderId == nil { + invalidParams.Add(request.NewErrParamRequired("EvidenceFolderId")) + } + if s.EvidenceFolderId != nil && len(*s.EvidenceFolderId) < 36 { + invalidParams.Add(request.NewErrParamMinLen("EvidenceFolderId", 36)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAssessmentId sets the AssessmentId field's value. +func (s *DisassociateAssessmentReportEvidenceFolderInput) SetAssessmentId(v string) *DisassociateAssessmentReportEvidenceFolderInput { + s.AssessmentId = &v + return s +} + +// SetEvidenceFolderId sets the EvidenceFolderId field's value. +func (s *DisassociateAssessmentReportEvidenceFolderInput) SetEvidenceFolderId(v string) *DisassociateAssessmentReportEvidenceFolderInput { + s.EvidenceFolderId = &v + return s +} + +type DisassociateAssessmentReportEvidenceFolderOutput struct { + _ struct{} `type:"structure"` +} + +// String returns the string representation +func (s DisassociateAssessmentReportEvidenceFolderOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s DisassociateAssessmentReportEvidenceFolderOutput) GoString() string { + return s.String() +} + +// A record that contains the information needed to demonstrate compliance with +// the requirements specified by a control. Examples of evidence include change +// activity triggered by a user, or a system configuration snapshot. +type Evidence struct { + _ struct{} `type:"structure"` + + // Specifies whether the evidence is inclded in the assessment report. + AssessmentReportSelection *string `locationName:"assessmentReportSelection" type:"string"` + + // The names and values used by the evidence event, including an attribute name + // (such as allowUsersToChangePassword) and value (such as true or false). + Attributes map[string]*string `locationName:"attributes" type:"map"` + + // The identifier for the specified AWS account. + AwsAccountId *string `locationName:"awsAccountId" min:"12" type:"string"` + + // The AWS account from which the evidence is collected, and its AWS organization + // path. + AwsOrganization *string `locationName:"awsOrganization" type:"string"` + + // The evaluation status for evidence that falls under the compliance check + // category. For evidence collected from AWS Security Hub, a Pass or Fail result + // is shown. For evidence collected from AWS Config, a Compliant or Noncompliant + // result is shown. + ComplianceCheck *string `locationName:"complianceCheck" type:"string"` + + // The data source from which the specified evidence was collected. + DataSource *string `locationName:"dataSource" type:"string"` + + // The name of the specified evidence event. + EventName *string `locationName:"eventName" type:"string"` + + // The AWS service from which the evidence is collected. + EventSource *string `locationName:"eventSource" min:"1" type:"string"` + + // The identifier for the specified AWS account. + EvidenceAwsAccountId *string `locationName:"evidenceAwsAccountId" min:"12" type:"string"` + + // The type of automated evidence. + EvidenceByType *string `locationName:"evidenceByType" type:"string"` + + // The identifier for the folder in which the evidence is stored. + EvidenceFolderId *string `locationName:"evidenceFolderId" min:"36" type:"string"` + + // The unique identifier for the IAM user or role associated with the evidence. + IamId *string `locationName:"iamId" min:"20" type:"string"` + + // The identifier for the evidence. + Id *string `locationName:"id" min:"36" type:"string"` + + // The list of resources assessed to generate the evidence. + ResourcesIncluded []*Resource `locationName:"resourcesIncluded" type:"list"` + + // The timestamp that represents when the evidence was collected. + Time *time.Time `locationName:"time" type:"timestamp"` +} + +// String returns the string representation +func (s Evidence) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s Evidence) GoString() string { + return s.String() +} + +// SetAssessmentReportSelection sets the AssessmentReportSelection field's value. +func (s *Evidence) SetAssessmentReportSelection(v string) *Evidence { + s.AssessmentReportSelection = &v + return s +} + +// SetAttributes sets the Attributes field's value. +func (s *Evidence) SetAttributes(v map[string]*string) *Evidence { + s.Attributes = v + return s +} + +// SetAwsAccountId sets the AwsAccountId field's value. +func (s *Evidence) SetAwsAccountId(v string) *Evidence { + s.AwsAccountId = &v + return s +} + +// SetAwsOrganization sets the AwsOrganization field's value. +func (s *Evidence) SetAwsOrganization(v string) *Evidence { + s.AwsOrganization = &v + return s +} + +// SetComplianceCheck sets the ComplianceCheck field's value. +func (s *Evidence) SetComplianceCheck(v string) *Evidence { + s.ComplianceCheck = &v + return s +} + +// SetDataSource sets the DataSource field's value. +func (s *Evidence) SetDataSource(v string) *Evidence { + s.DataSource = &v + return s +} + +// SetEventName sets the EventName field's value. +func (s *Evidence) SetEventName(v string) *Evidence { + s.EventName = &v + return s +} + +// SetEventSource sets the EventSource field's value. +func (s *Evidence) SetEventSource(v string) *Evidence { + s.EventSource = &v + return s +} + +// SetEvidenceAwsAccountId sets the EvidenceAwsAccountId field's value. +func (s *Evidence) SetEvidenceAwsAccountId(v string) *Evidence { + s.EvidenceAwsAccountId = &v + return s +} + +// SetEvidenceByType sets the EvidenceByType field's value. +func (s *Evidence) SetEvidenceByType(v string) *Evidence { + s.EvidenceByType = &v + return s +} + +// SetEvidenceFolderId sets the EvidenceFolderId field's value. +func (s *Evidence) SetEvidenceFolderId(v string) *Evidence { + s.EvidenceFolderId = &v + return s +} + +// SetIamId sets the IamId field's value. +func (s *Evidence) SetIamId(v string) *Evidence { + s.IamId = &v + return s +} + +// SetId sets the Id field's value. +func (s *Evidence) SetId(v string) *Evidence { + s.Id = &v + return s +} + +// SetResourcesIncluded sets the ResourcesIncluded field's value. +func (s *Evidence) SetResourcesIncluded(v []*Resource) *Evidence { + s.ResourcesIncluded = v + return s +} + +// SetTime sets the Time field's value. +func (s *Evidence) SetTime(v time.Time) *Evidence { + s.Time = &v + return s +} + +// The file used to structure and automate AWS Audit Manager assessments for +// a given compliance standard. +type Framework struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the specified framework. + Arn *string `locationName:"arn" min:"20" type:"string"` + + // The compliance type that the new custom framework supports, such as CIS or + // HIPAA. + ComplianceType *string `locationName:"complianceType" type:"string"` + + // The control sets associated with the framework. + ControlSets []*ControlSet `locationName:"controlSets" min:"1" type:"list"` + + // The sources from which AWS Audit Manager collects evidence for the control. + ControlSources *string `locationName:"controlSources" min:"1" type:"string"` + + // Specifies when the framework was created. + CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"` + + // The IAM user or role that created the framework. + CreatedBy *string `locationName:"createdBy" min:"1" type:"string"` + + // The description of the specified framework. + Description *string `locationName:"description" min:"1" type:"string"` + + // The unique identifier for the specified framework. + Id *string `locationName:"id" min:"36" type:"string"` + + // Specifies when the framework was most recently updated. + LastUpdatedAt *time.Time `locationName:"lastUpdatedAt" type:"timestamp"` + + // The IAM user or role that most recently updated the framework. + LastUpdatedBy *string `locationName:"lastUpdatedBy" min:"1" type:"string"` + + // The logo associated with the framework. + Logo *string `locationName:"logo" min:"1" type:"string"` + + // The name of the specified framework. + Name *string `locationName:"name" min:"1" type:"string"` + + // The framework type, such as custom or standard. + Type *string `locationName:"type" type:"string" enum:"FrameworkType"` +} + +// String returns the string representation +func (s Framework) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s Framework) GoString() string { + return s.String() +} + +// SetArn sets the Arn field's value. +func (s *Framework) SetArn(v string) *Framework { + s.Arn = &v + return s +} + +// SetComplianceType sets the ComplianceType field's value. +func (s *Framework) SetComplianceType(v string) *Framework { + s.ComplianceType = &v + return s +} + +// SetControlSets sets the ControlSets field's value. +func (s *Framework) SetControlSets(v []*ControlSet) *Framework { + s.ControlSets = v + return s +} + +// SetControlSources sets the ControlSources field's value. +func (s *Framework) SetControlSources(v string) *Framework { + s.ControlSources = &v + return s +} + +// SetCreatedAt sets the CreatedAt field's value. +func (s *Framework) SetCreatedAt(v time.Time) *Framework { + s.CreatedAt = &v + return s +} + +// SetCreatedBy sets the CreatedBy field's value. +func (s *Framework) SetCreatedBy(v string) *Framework { + s.CreatedBy = &v + return s +} + +// SetDescription sets the Description field's value. +func (s *Framework) SetDescription(v string) *Framework { + s.Description = &v + return s +} + +// SetId sets the Id field's value. +func (s *Framework) SetId(v string) *Framework { + s.Id = &v + return s +} + +// SetLastUpdatedAt sets the LastUpdatedAt field's value. +func (s *Framework) SetLastUpdatedAt(v time.Time) *Framework { + s.LastUpdatedAt = &v + return s +} + +// SetLastUpdatedBy sets the LastUpdatedBy field's value. +func (s *Framework) SetLastUpdatedBy(v string) *Framework { + s.LastUpdatedBy = &v + return s +} + +// SetLogo sets the Logo field's value. +func (s *Framework) SetLogo(v string) *Framework { + s.Logo = &v + return s +} + +// SetName sets the Name field's value. +func (s *Framework) SetName(v string) *Framework { + s.Name = &v + return s +} + +// SetType sets the Type field's value. +func (s *Framework) SetType(v string) *Framework { + s.Type = &v + return s +} + +// The metadata of a framework, such as the name, ID, description, and so on. +type FrameworkMetadata struct { + _ struct{} `type:"structure"` + + // The compliance standard associated with the framework, such as PCI-DSS or + // HIPAA. + ComplianceType *string `locationName:"complianceType" type:"string"` + + // The description of the framework. + Description *string `locationName:"description" min:"1" type:"string"` + + // The logo associated with the framework. + Logo *string `locationName:"logo" min:"1" type:"string"` + + // The name of the framework. + Name *string `locationName:"name" min:"1" type:"string"` +} + +// String returns the string representation +func (s FrameworkMetadata) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s FrameworkMetadata) GoString() string { + return s.String() +} + +// SetComplianceType sets the ComplianceType field's value. +func (s *FrameworkMetadata) SetComplianceType(v string) *FrameworkMetadata { + s.ComplianceType = &v + return s +} + +// SetDescription sets the Description field's value. +func (s *FrameworkMetadata) SetDescription(v string) *FrameworkMetadata { + s.Description = &v + return s +} + +// SetLogo sets the Logo field's value. +func (s *FrameworkMetadata) SetLogo(v string) *FrameworkMetadata { + s.Logo = &v + return s +} + +// SetName sets the Name field's value. +func (s *FrameworkMetadata) SetName(v string) *FrameworkMetadata { + s.Name = &v + return s +} + +type GetAccountStatusInput struct { + _ struct{} `type:"structure"` +} + +// String returns the string representation +func (s GetAccountStatusInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s GetAccountStatusInput) GoString() string { + return s.String() +} + +type GetAccountStatusOutput struct { + _ struct{} `type:"structure"` + + // The status of the specified AWS account. + Status *string `locationName:"status" type:"string" enum:"AccountStatus"` +} + +// String returns the string representation +func (s GetAccountStatusOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s GetAccountStatusOutput) GoString() string { + return s.String() +} + +// SetStatus sets the Status field's value. +func (s *GetAccountStatusOutput) SetStatus(v string) *GetAccountStatusOutput { + s.Status = &v + return s +} + +type GetAssessmentFrameworkInput struct { + _ struct{} `type:"structure"` + + // The identifier for the specified framework. + // + // FrameworkId is a required field + FrameworkId *string `location:"uri" locationName:"frameworkId" min:"36" type:"string" required:"true"` +} + +// String returns the string representation +func (s GetAssessmentFrameworkInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s GetAssessmentFrameworkInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *GetAssessmentFrameworkInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "GetAssessmentFrameworkInput"} + if s.FrameworkId == nil { + invalidParams.Add(request.NewErrParamRequired("FrameworkId")) + } + if s.FrameworkId != nil && len(*s.FrameworkId) < 36 { + invalidParams.Add(request.NewErrParamMinLen("FrameworkId", 36)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetFrameworkId sets the FrameworkId field's value. +func (s *GetAssessmentFrameworkInput) SetFrameworkId(v string) *GetAssessmentFrameworkInput { + s.FrameworkId = &v + return s +} + +type GetAssessmentFrameworkOutput struct { + _ struct{} `type:"structure"` + + // The framework returned by the GetAssessmentFramework API. + Framework *Framework `locationName:"framework" type:"structure"` +} + +// String returns the string representation +func (s GetAssessmentFrameworkOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s GetAssessmentFrameworkOutput) GoString() string { + return s.String() +} + +// SetFramework sets the Framework field's value. +func (s *GetAssessmentFrameworkOutput) SetFramework(v *Framework) *GetAssessmentFrameworkOutput { + s.Framework = v + return s +} + +type GetAssessmentInput struct { + _ struct{} `type:"structure"` + + // The identifier for the specified assessment. + // + // AssessmentId is a required field + AssessmentId *string `location:"uri" locationName:"assessmentId" min:"36" type:"string" required:"true"` +} + +// String returns the string representation +func (s GetAssessmentInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s GetAssessmentInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *GetAssessmentInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "GetAssessmentInput"} + if s.AssessmentId == nil { + invalidParams.Add(request.NewErrParamRequired("AssessmentId")) + } + if s.AssessmentId != nil && len(*s.AssessmentId) < 36 { + invalidParams.Add(request.NewErrParamMinLen("AssessmentId", 36)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAssessmentId sets the AssessmentId field's value. +func (s *GetAssessmentInput) SetAssessmentId(v string) *GetAssessmentInput { + s.AssessmentId = &v + return s +} + +type GetAssessmentOutput struct { + _ struct{} `type:"structure"` + + // An entity that defines the scope of audit evidence collected by AWS Audit + // Manager. An AWS Audit Manager assessment is an implementation of an AWS Audit + // Manager framework. + Assessment *Assessment `locationName:"assessment" type:"structure"` +} + +// String returns the string representation +func (s GetAssessmentOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s GetAssessmentOutput) GoString() string { + return s.String() +} + +// SetAssessment sets the Assessment field's value. +func (s *GetAssessmentOutput) SetAssessment(v *Assessment) *GetAssessmentOutput { + s.Assessment = v + return s +} + +type GetAssessmentReportUrlInput struct { + _ struct{} `type:"structure"` + + // The identifier for the specified assessment. + // + // AssessmentId is a required field + AssessmentId *string `location:"uri" locationName:"assessmentId" min:"36" type:"string" required:"true"` + + // The identifier for the assessment report. + // + // AssessmentReportId is a required field + AssessmentReportId *string `location:"uri" locationName:"assessmentReportId" min:"36" type:"string" required:"true"` +} + +// String returns the string representation +func (s GetAssessmentReportUrlInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s GetAssessmentReportUrlInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *GetAssessmentReportUrlInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "GetAssessmentReportUrlInput"} + if s.AssessmentId == nil { + invalidParams.Add(request.NewErrParamRequired("AssessmentId")) + } + if s.AssessmentId != nil && len(*s.AssessmentId) < 36 { + invalidParams.Add(request.NewErrParamMinLen("AssessmentId", 36)) + } + if s.AssessmentReportId == nil { + invalidParams.Add(request.NewErrParamRequired("AssessmentReportId")) + } + if s.AssessmentReportId != nil && len(*s.AssessmentReportId) < 36 { + invalidParams.Add(request.NewErrParamMinLen("AssessmentReportId", 36)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAssessmentId sets the AssessmentId field's value. +func (s *GetAssessmentReportUrlInput) SetAssessmentId(v string) *GetAssessmentReportUrlInput { + s.AssessmentId = &v + return s +} + +// SetAssessmentReportId sets the AssessmentReportId field's value. +func (s *GetAssessmentReportUrlInput) SetAssessmentReportId(v string) *GetAssessmentReportUrlInput { + s.AssessmentReportId = &v + return s +} + +type GetAssessmentReportUrlOutput struct { + _ struct{} `type:"structure"` + + // A uniform resource locator, used as a unique identifier to locate a resource + // on the internet. + PreSignedUrl *URL `locationName:"preSignedUrl" type:"structure"` +} + +// String returns the string representation +func (s GetAssessmentReportUrlOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s GetAssessmentReportUrlOutput) GoString() string { + return s.String() +} + +// SetPreSignedUrl sets the PreSignedUrl field's value. +func (s *GetAssessmentReportUrlOutput) SetPreSignedUrl(v *URL) *GetAssessmentReportUrlOutput { + s.PreSignedUrl = v + return s +} + +type GetChangeLogsInput struct { + _ struct{} `type:"structure"` + + // The identifier for the specified assessment. + // + // AssessmentId is a required field + AssessmentId *string `location:"uri" locationName:"assessmentId" min:"36" type:"string" required:"true"` + + // The identifier for the specified control. + ControlId *string `location:"querystring" locationName:"controlId" min:"36" type:"string"` + + // The identifier for the specified control set. + ControlSetId *string `location:"querystring" locationName:"controlSetId" min:"1" type:"string"` + + // Represents the maximum number of results per page, or per API request call. + MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"` + + // The pagination token used to fetch the next set of results. + NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"` +} + +// String returns the string representation +func (s GetChangeLogsInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s GetChangeLogsInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *GetChangeLogsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "GetChangeLogsInput"} + if s.AssessmentId == nil { + invalidParams.Add(request.NewErrParamRequired("AssessmentId")) + } + if s.AssessmentId != nil && len(*s.AssessmentId) < 36 { + invalidParams.Add(request.NewErrParamMinLen("AssessmentId", 36)) + } + if s.ControlId != nil && len(*s.ControlId) < 36 { + invalidParams.Add(request.NewErrParamMinLen("ControlId", 36)) + } + if s.ControlSetId != nil && len(*s.ControlSetId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ControlSetId", 1)) + } + if s.MaxResults != nil && *s.MaxResults < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) + } + if s.NextToken != nil && len(*s.NextToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("NextToken", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAssessmentId sets the AssessmentId field's value. +func (s *GetChangeLogsInput) SetAssessmentId(v string) *GetChangeLogsInput { + s.AssessmentId = &v + return s +} + +// SetControlId sets the ControlId field's value. +func (s *GetChangeLogsInput) SetControlId(v string) *GetChangeLogsInput { + s.ControlId = &v + return s +} + +// SetControlSetId sets the ControlSetId field's value. +func (s *GetChangeLogsInput) SetControlSetId(v string) *GetChangeLogsInput { + s.ControlSetId = &v + return s +} + +// SetMaxResults sets the MaxResults field's value. +func (s *GetChangeLogsInput) SetMaxResults(v int64) *GetChangeLogsInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *GetChangeLogsInput) SetNextToken(v string) *GetChangeLogsInput { + s.NextToken = &v + return s +} + +type GetChangeLogsOutput struct { + _ struct{} `type:"structure"` + + // The list of user activity for the control. + ChangeLogs []*ChangeLog `locationName:"changeLogs" type:"list"` + + // The pagination token used to fetch the next set of results. + NextToken *string `locationName:"nextToken" min:"1" type:"string"` +} + +// String returns the string representation +func (s GetChangeLogsOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s GetChangeLogsOutput) GoString() string { + return s.String() +} + +// SetChangeLogs sets the ChangeLogs field's value. +func (s *GetChangeLogsOutput) SetChangeLogs(v []*ChangeLog) *GetChangeLogsOutput { + s.ChangeLogs = v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *GetChangeLogsOutput) SetNextToken(v string) *GetChangeLogsOutput { + s.NextToken = &v + return s +} + +type GetControlInput struct { + _ struct{} `type:"structure"` + + // The identifier for the specified control. + // + // ControlId is a required field + ControlId *string `location:"uri" locationName:"controlId" min:"36" type:"string" required:"true"` +} + +// String returns the string representation +func (s GetControlInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s GetControlInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *GetControlInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "GetControlInput"} + if s.ControlId == nil { + invalidParams.Add(request.NewErrParamRequired("ControlId")) + } + if s.ControlId != nil && len(*s.ControlId) < 36 { + invalidParams.Add(request.NewErrParamMinLen("ControlId", 36)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetControlId sets the ControlId field's value. +func (s *GetControlInput) SetControlId(v string) *GetControlInput { + s.ControlId = &v + return s +} + +type GetControlOutput struct { + _ struct{} `type:"structure"` + + // The name of the control returned by the GetControl API. + Control *Control `locationName:"control" type:"structure"` +} + +// String returns the string representation +func (s GetControlOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s GetControlOutput) GoString() string { + return s.String() +} + +// SetControl sets the Control field's value. +func (s *GetControlOutput) SetControl(v *Control) *GetControlOutput { + s.Control = v + return s +} + +type GetDelegationsInput struct { + _ struct{} `type:"structure"` + + // Represents the maximum number of results per page, or per API request call. + MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"` + + // The pagination token used to fetch the next set of results. + NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"` +} + +// String returns the string representation +func (s GetDelegationsInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s GetDelegationsInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *GetDelegationsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "GetDelegationsInput"} + if s.MaxResults != nil && *s.MaxResults < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) + } + if s.NextToken != nil && len(*s.NextToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("NextToken", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetMaxResults sets the MaxResults field's value. +func (s *GetDelegationsInput) SetMaxResults(v int64) *GetDelegationsInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *GetDelegationsInput) SetNextToken(v string) *GetDelegationsInput { + s.NextToken = &v + return s +} + +type GetDelegationsOutput struct { + _ struct{} `type:"structure"` + + // The list of delegations returned by the GetDelegations API. + Delegations []*DelegationMetadata `locationName:"delegations" type:"list"` + + // The pagination token used to fetch the next set of results. + NextToken *string `locationName:"nextToken" min:"1" type:"string"` +} + +// String returns the string representation +func (s GetDelegationsOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s GetDelegationsOutput) GoString() string { + return s.String() +} + +// SetDelegations sets the Delegations field's value. +func (s *GetDelegationsOutput) SetDelegations(v []*DelegationMetadata) *GetDelegationsOutput { + s.Delegations = v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *GetDelegationsOutput) SetNextToken(v string) *GetDelegationsOutput { + s.NextToken = &v + return s +} + +type GetEvidenceByEvidenceFolderInput struct { + _ struct{} `type:"structure"` + + // The identifier for the specified assessment. + // + // AssessmentId is a required field + AssessmentId *string `location:"uri" locationName:"assessmentId" min:"36" type:"string" required:"true"` + + // The identifier for the control set. + // + // ControlSetId is a required field + ControlSetId *string `location:"uri" locationName:"controlSetId" min:"1" type:"string" required:"true"` + + // The unique identifier for the folder in which the evidence is stored. + // + // EvidenceFolderId is a required field + EvidenceFolderId *string `location:"uri" locationName:"evidenceFolderId" min:"36" type:"string" required:"true"` + + // Represents the maximum number of results per page, or per API request call. + MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"` + + // The pagination token used to fetch the next set of results. + NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"` +} + +// String returns the string representation +func (s GetEvidenceByEvidenceFolderInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s GetEvidenceByEvidenceFolderInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *GetEvidenceByEvidenceFolderInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "GetEvidenceByEvidenceFolderInput"} + if s.AssessmentId == nil { + invalidParams.Add(request.NewErrParamRequired("AssessmentId")) + } + if s.AssessmentId != nil && len(*s.AssessmentId) < 36 { + invalidParams.Add(request.NewErrParamMinLen("AssessmentId", 36)) + } + if s.ControlSetId == nil { + invalidParams.Add(request.NewErrParamRequired("ControlSetId")) + } + if s.ControlSetId != nil && len(*s.ControlSetId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ControlSetId", 1)) + } + if s.EvidenceFolderId == nil { + invalidParams.Add(request.NewErrParamRequired("EvidenceFolderId")) + } + if s.EvidenceFolderId != nil && len(*s.EvidenceFolderId) < 36 { + invalidParams.Add(request.NewErrParamMinLen("EvidenceFolderId", 36)) + } + if s.MaxResults != nil && *s.MaxResults < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) + } + if s.NextToken != nil && len(*s.NextToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("NextToken", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAssessmentId sets the AssessmentId field's value. +func (s *GetEvidenceByEvidenceFolderInput) SetAssessmentId(v string) *GetEvidenceByEvidenceFolderInput { + s.AssessmentId = &v + return s +} + +// SetControlSetId sets the ControlSetId field's value. +func (s *GetEvidenceByEvidenceFolderInput) SetControlSetId(v string) *GetEvidenceByEvidenceFolderInput { + s.ControlSetId = &v + return s +} + +// SetEvidenceFolderId sets the EvidenceFolderId field's value. +func (s *GetEvidenceByEvidenceFolderInput) SetEvidenceFolderId(v string) *GetEvidenceByEvidenceFolderInput { + s.EvidenceFolderId = &v + return s +} + +// SetMaxResults sets the MaxResults field's value. +func (s *GetEvidenceByEvidenceFolderInput) SetMaxResults(v int64) *GetEvidenceByEvidenceFolderInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *GetEvidenceByEvidenceFolderInput) SetNextToken(v string) *GetEvidenceByEvidenceFolderInput { + s.NextToken = &v + return s +} + +type GetEvidenceByEvidenceFolderOutput struct { + _ struct{} `type:"structure"` + + // The list of evidence returned by the GetEvidenceByEvidenceFolder API. + Evidence []*Evidence `locationName:"evidence" type:"list"` + + // The pagination token used to fetch the next set of results. + NextToken *string `locationName:"nextToken" min:"1" type:"string"` +} + +// String returns the string representation +func (s GetEvidenceByEvidenceFolderOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s GetEvidenceByEvidenceFolderOutput) GoString() string { + return s.String() +} + +// SetEvidence sets the Evidence field's value. +func (s *GetEvidenceByEvidenceFolderOutput) SetEvidence(v []*Evidence) *GetEvidenceByEvidenceFolderOutput { + s.Evidence = v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *GetEvidenceByEvidenceFolderOutput) SetNextToken(v string) *GetEvidenceByEvidenceFolderOutput { + s.NextToken = &v + return s +} + +type GetEvidenceFolderInput struct { + _ struct{} `type:"structure"` + + // The identifier for the specified assessment. + // + // AssessmentId is a required field + AssessmentId *string `location:"uri" locationName:"assessmentId" min:"36" type:"string" required:"true"` + + // The identifier for the specified control set. + // + // ControlSetId is a required field + ControlSetId *string `location:"uri" locationName:"controlSetId" min:"1" type:"string" required:"true"` + + // The identifier for the folder in which the evidence is stored. + // + // EvidenceFolderId is a required field + EvidenceFolderId *string `location:"uri" locationName:"evidenceFolderId" min:"36" type:"string" required:"true"` +} + +// String returns the string representation +func (s GetEvidenceFolderInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s GetEvidenceFolderInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *GetEvidenceFolderInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "GetEvidenceFolderInput"} + if s.AssessmentId == nil { + invalidParams.Add(request.NewErrParamRequired("AssessmentId")) + } + if s.AssessmentId != nil && len(*s.AssessmentId) < 36 { + invalidParams.Add(request.NewErrParamMinLen("AssessmentId", 36)) + } + if s.ControlSetId == nil { + invalidParams.Add(request.NewErrParamRequired("ControlSetId")) + } + if s.ControlSetId != nil && len(*s.ControlSetId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ControlSetId", 1)) + } + if s.EvidenceFolderId == nil { + invalidParams.Add(request.NewErrParamRequired("EvidenceFolderId")) + } + if s.EvidenceFolderId != nil && len(*s.EvidenceFolderId) < 36 { + invalidParams.Add(request.NewErrParamMinLen("EvidenceFolderId", 36)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAssessmentId sets the AssessmentId field's value. +func (s *GetEvidenceFolderInput) SetAssessmentId(v string) *GetEvidenceFolderInput { + s.AssessmentId = &v + return s +} + +// SetControlSetId sets the ControlSetId field's value. +func (s *GetEvidenceFolderInput) SetControlSetId(v string) *GetEvidenceFolderInput { + s.ControlSetId = &v + return s +} + +// SetEvidenceFolderId sets the EvidenceFolderId field's value. +func (s *GetEvidenceFolderInput) SetEvidenceFolderId(v string) *GetEvidenceFolderInput { + s.EvidenceFolderId = &v + return s +} + +type GetEvidenceFolderOutput struct { + _ struct{} `type:"structure"` + + // The folder in which evidence is stored. + EvidenceFolder *AssessmentEvidenceFolder `locationName:"evidenceFolder" type:"structure"` +} + +// String returns the string representation +func (s GetEvidenceFolderOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s GetEvidenceFolderOutput) GoString() string { + return s.String() +} + +// SetEvidenceFolder sets the EvidenceFolder field's value. +func (s *GetEvidenceFolderOutput) SetEvidenceFolder(v *AssessmentEvidenceFolder) *GetEvidenceFolderOutput { + s.EvidenceFolder = v + return s +} + +type GetEvidenceFoldersByAssessmentControlInput struct { + _ struct{} `type:"structure"` + + // The identifier for the specified assessment. + // + // AssessmentId is a required field + AssessmentId *string `location:"uri" locationName:"assessmentId" min:"36" type:"string" required:"true"` + + // The identifier for the specified control. + // + // ControlId is a required field + ControlId *string `location:"uri" locationName:"controlId" min:"36" type:"string" required:"true"` + + // The identifier for the specified control set. + // + // ControlSetId is a required field + ControlSetId *string `location:"uri" locationName:"controlSetId" min:"1" type:"string" required:"true"` + + // Represents the maximum number of results per page, or per API request call. + MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"` + + // The pagination token used to fetch the next set of results. + NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"` +} + +// String returns the string representation +func (s GetEvidenceFoldersByAssessmentControlInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s GetEvidenceFoldersByAssessmentControlInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *GetEvidenceFoldersByAssessmentControlInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "GetEvidenceFoldersByAssessmentControlInput"} + if s.AssessmentId == nil { + invalidParams.Add(request.NewErrParamRequired("AssessmentId")) + } + if s.AssessmentId != nil && len(*s.AssessmentId) < 36 { + invalidParams.Add(request.NewErrParamMinLen("AssessmentId", 36)) + } + if s.ControlId == nil { + invalidParams.Add(request.NewErrParamRequired("ControlId")) + } + if s.ControlId != nil && len(*s.ControlId) < 36 { + invalidParams.Add(request.NewErrParamMinLen("ControlId", 36)) + } + if s.ControlSetId == nil { + invalidParams.Add(request.NewErrParamRequired("ControlSetId")) + } + if s.ControlSetId != nil && len(*s.ControlSetId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ControlSetId", 1)) + } + if s.MaxResults != nil && *s.MaxResults < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) + } + if s.NextToken != nil && len(*s.NextToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("NextToken", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAssessmentId sets the AssessmentId field's value. +func (s *GetEvidenceFoldersByAssessmentControlInput) SetAssessmentId(v string) *GetEvidenceFoldersByAssessmentControlInput { + s.AssessmentId = &v + return s +} + +// SetControlId sets the ControlId field's value. +func (s *GetEvidenceFoldersByAssessmentControlInput) SetControlId(v string) *GetEvidenceFoldersByAssessmentControlInput { + s.ControlId = &v + return s +} + +// SetControlSetId sets the ControlSetId field's value. +func (s *GetEvidenceFoldersByAssessmentControlInput) SetControlSetId(v string) *GetEvidenceFoldersByAssessmentControlInput { + s.ControlSetId = &v + return s +} + +// SetMaxResults sets the MaxResults field's value. +func (s *GetEvidenceFoldersByAssessmentControlInput) SetMaxResults(v int64) *GetEvidenceFoldersByAssessmentControlInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *GetEvidenceFoldersByAssessmentControlInput) SetNextToken(v string) *GetEvidenceFoldersByAssessmentControlInput { + s.NextToken = &v + return s +} + +type GetEvidenceFoldersByAssessmentControlOutput struct { + _ struct{} `type:"structure"` + + // The list of evidence folders returned by the GetEvidenceFoldersByAssessmentControl + // API. + EvidenceFolders []*AssessmentEvidenceFolder `locationName:"evidenceFolders" type:"list"` + + // The pagination token used to fetch the next set of results. + NextToken *string `locationName:"nextToken" min:"1" type:"string"` +} + +// String returns the string representation +func (s GetEvidenceFoldersByAssessmentControlOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s GetEvidenceFoldersByAssessmentControlOutput) GoString() string { + return s.String() +} + +// SetEvidenceFolders sets the EvidenceFolders field's value. +func (s *GetEvidenceFoldersByAssessmentControlOutput) SetEvidenceFolders(v []*AssessmentEvidenceFolder) *GetEvidenceFoldersByAssessmentControlOutput { + s.EvidenceFolders = v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *GetEvidenceFoldersByAssessmentControlOutput) SetNextToken(v string) *GetEvidenceFoldersByAssessmentControlOutput { + s.NextToken = &v + return s +} + +type GetEvidenceFoldersByAssessmentInput struct { + _ struct{} `type:"structure"` + + // The identifier for the specified assessment. + // + // AssessmentId is a required field + AssessmentId *string `location:"uri" locationName:"assessmentId" min:"36" type:"string" required:"true"` + + // Represents the maximum number of results per page, or per API request call. + MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"` + + // The pagination token used to fetch the next set of results. + NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"` +} + +// String returns the string representation +func (s GetEvidenceFoldersByAssessmentInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s GetEvidenceFoldersByAssessmentInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *GetEvidenceFoldersByAssessmentInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "GetEvidenceFoldersByAssessmentInput"} + if s.AssessmentId == nil { + invalidParams.Add(request.NewErrParamRequired("AssessmentId")) + } + if s.AssessmentId != nil && len(*s.AssessmentId) < 36 { + invalidParams.Add(request.NewErrParamMinLen("AssessmentId", 36)) + } + if s.MaxResults != nil && *s.MaxResults < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) + } + if s.NextToken != nil && len(*s.NextToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("NextToken", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAssessmentId sets the AssessmentId field's value. +func (s *GetEvidenceFoldersByAssessmentInput) SetAssessmentId(v string) *GetEvidenceFoldersByAssessmentInput { + s.AssessmentId = &v + return s +} + +// SetMaxResults sets the MaxResults field's value. +func (s *GetEvidenceFoldersByAssessmentInput) SetMaxResults(v int64) *GetEvidenceFoldersByAssessmentInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *GetEvidenceFoldersByAssessmentInput) SetNextToken(v string) *GetEvidenceFoldersByAssessmentInput { + s.NextToken = &v + return s +} + +type GetEvidenceFoldersByAssessmentOutput struct { + _ struct{} `type:"structure"` + + // The list of evidence folders returned by the GetEvidenceFoldersByAssessment + // API. + EvidenceFolders []*AssessmentEvidenceFolder `locationName:"evidenceFolders" type:"list"` + + // The pagination token used to fetch the next set of results. + NextToken *string `locationName:"nextToken" min:"1" type:"string"` +} + +// String returns the string representation +func (s GetEvidenceFoldersByAssessmentOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s GetEvidenceFoldersByAssessmentOutput) GoString() string { + return s.String() +} + +// SetEvidenceFolders sets the EvidenceFolders field's value. +func (s *GetEvidenceFoldersByAssessmentOutput) SetEvidenceFolders(v []*AssessmentEvidenceFolder) *GetEvidenceFoldersByAssessmentOutput { + s.EvidenceFolders = v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *GetEvidenceFoldersByAssessmentOutput) SetNextToken(v string) *GetEvidenceFoldersByAssessmentOutput { + s.NextToken = &v + return s +} + +type GetEvidenceInput struct { + _ struct{} `type:"structure"` + + // The identifier for the specified assessment. + // + // AssessmentId is a required field + AssessmentId *string `location:"uri" locationName:"assessmentId" min:"36" type:"string" required:"true"` + + // The identifier for the specified control set. + // + // ControlSetId is a required field + ControlSetId *string `location:"uri" locationName:"controlSetId" min:"1" type:"string" required:"true"` + + // The identifier for the folder in which the evidence is stored. + // + // EvidenceFolderId is a required field + EvidenceFolderId *string `location:"uri" locationName:"evidenceFolderId" min:"36" type:"string" required:"true"` + + // The identifier for the evidence. + // + // EvidenceId is a required field + EvidenceId *string `location:"uri" locationName:"evidenceId" min:"36" type:"string" required:"true"` +} + +// String returns the string representation +func (s GetEvidenceInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s GetEvidenceInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *GetEvidenceInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "GetEvidenceInput"} + if s.AssessmentId == nil { + invalidParams.Add(request.NewErrParamRequired("AssessmentId")) + } + if s.AssessmentId != nil && len(*s.AssessmentId) < 36 { + invalidParams.Add(request.NewErrParamMinLen("AssessmentId", 36)) + } + if s.ControlSetId == nil { + invalidParams.Add(request.NewErrParamRequired("ControlSetId")) + } + if s.ControlSetId != nil && len(*s.ControlSetId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ControlSetId", 1)) + } + if s.EvidenceFolderId == nil { + invalidParams.Add(request.NewErrParamRequired("EvidenceFolderId")) + } + if s.EvidenceFolderId != nil && len(*s.EvidenceFolderId) < 36 { + invalidParams.Add(request.NewErrParamMinLen("EvidenceFolderId", 36)) + } + if s.EvidenceId == nil { + invalidParams.Add(request.NewErrParamRequired("EvidenceId")) + } + if s.EvidenceId != nil && len(*s.EvidenceId) < 36 { + invalidParams.Add(request.NewErrParamMinLen("EvidenceId", 36)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAssessmentId sets the AssessmentId field's value. +func (s *GetEvidenceInput) SetAssessmentId(v string) *GetEvidenceInput { + s.AssessmentId = &v + return s +} + +// SetControlSetId sets the ControlSetId field's value. +func (s *GetEvidenceInput) SetControlSetId(v string) *GetEvidenceInput { + s.ControlSetId = &v + return s +} + +// SetEvidenceFolderId sets the EvidenceFolderId field's value. +func (s *GetEvidenceInput) SetEvidenceFolderId(v string) *GetEvidenceInput { + s.EvidenceFolderId = &v + return s +} + +// SetEvidenceId sets the EvidenceId field's value. +func (s *GetEvidenceInput) SetEvidenceId(v string) *GetEvidenceInput { + s.EvidenceId = &v + return s +} + +type GetEvidenceOutput struct { + _ struct{} `type:"structure"` + + // The evidence returned by the GetEvidenceResponse API. + Evidence *Evidence `locationName:"evidence" type:"structure"` +} + +// String returns the string representation +func (s GetEvidenceOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s GetEvidenceOutput) GoString() string { + return s.String() +} + +// SetEvidence sets the Evidence field's value. +func (s *GetEvidenceOutput) SetEvidence(v *Evidence) *GetEvidenceOutput { + s.Evidence = v + return s +} + +type GetOrganizationAdminAccountInput struct { + _ struct{} `type:"structure"` +} + +// String returns the string representation +func (s GetOrganizationAdminAccountInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s GetOrganizationAdminAccountInput) GoString() string { + return s.String() +} + +type GetOrganizationAdminAccountOutput struct { + _ struct{} `type:"structure"` + + // The identifier for the specified administrator account. + AdminAccountId *string `locationName:"adminAccountId" min:"12" type:"string"` + + // The identifier for the specified organization. + OrganizationId *string `locationName:"organizationId" min:"12" type:"string"` +} + +// String returns the string representation +func (s GetOrganizationAdminAccountOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s GetOrganizationAdminAccountOutput) GoString() string { + return s.String() +} + +// SetAdminAccountId sets the AdminAccountId field's value. +func (s *GetOrganizationAdminAccountOutput) SetAdminAccountId(v string) *GetOrganizationAdminAccountOutput { + s.AdminAccountId = &v + return s +} + +// SetOrganizationId sets the OrganizationId field's value. +func (s *GetOrganizationAdminAccountOutput) SetOrganizationId(v string) *GetOrganizationAdminAccountOutput { + s.OrganizationId = &v + return s +} + +type GetServicesInScopeInput struct { + _ struct{} `type:"structure"` +} + +// String returns the string representation +func (s GetServicesInScopeInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s GetServicesInScopeInput) GoString() string { + return s.String() +} + +type GetServicesInScopeOutput struct { + _ struct{} `type:"structure"` + + // The metadata associated with the aAWS service. + ServiceMetadata []*ServiceMetadata `locationName:"serviceMetadata" type:"list"` +} + +// String returns the string representation +func (s GetServicesInScopeOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s GetServicesInScopeOutput) GoString() string { + return s.String() +} + +// SetServiceMetadata sets the ServiceMetadata field's value. +func (s *GetServicesInScopeOutput) SetServiceMetadata(v []*ServiceMetadata) *GetServicesInScopeOutput { + s.ServiceMetadata = v + return s +} + +type GetSettingsInput struct { + _ struct{} `type:"structure"` + + // The list of SettingAttribute enum values. + // + // Attribute is a required field + Attribute *string `location:"uri" locationName:"attribute" type:"string" required:"true" enum:"SettingAttribute"` +} + +// String returns the string representation +func (s GetSettingsInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s GetSettingsInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *GetSettingsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "GetSettingsInput"} + if s.Attribute == nil { + invalidParams.Add(request.NewErrParamRequired("Attribute")) + } + if s.Attribute != nil && len(*s.Attribute) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Attribute", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAttribute sets the Attribute field's value. +func (s *GetSettingsInput) SetAttribute(v string) *GetSettingsInput { + s.Attribute = &v + return s +} + +type GetSettingsOutput struct { + _ struct{} `type:"structure"` + + // The settings object that holds all supported AWS Audit Manager settings. + Settings *Settings `locationName:"settings" type:"structure"` +} + +// String returns the string representation +func (s GetSettingsOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s GetSettingsOutput) GoString() string { + return s.String() +} + +// SetSettings sets the Settings field's value. +func (s *GetSettingsOutput) SetSettings(v *Settings) *GetSettingsOutput { + s.Settings = v + return s +} + +// An internal service error occurred during the processing of your request. +// Try again later. +type InternalServerException struct { + _ struct{} `type:"structure"` + RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` + + Message_ *string `locationName:"message" type:"string"` +} + +// String returns the string representation +func (s InternalServerException) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s InternalServerException) GoString() string { + return s.String() +} + +func newErrorInternalServerException(v protocol.ResponseMetadata) error { + return &InternalServerException{ + RespMetadata: v, + } +} + +// Code returns the exception type name. +func (s *InternalServerException) Code() string { + return "InternalServerException" +} + +// Message returns the exception's message. +func (s *InternalServerException) Message() string { + if s.Message_ != nil { + return *s.Message_ + } + return "" +} + +// OrigErr always returns nil, satisfies awserr.Error interface. +func (s *InternalServerException) OrigErr() error { + return nil +} + +func (s *InternalServerException) Error() string { + return fmt.Sprintf("%s: %s", s.Code(), s.Message()) +} + +// Status code returns the HTTP status code for the request's response error. +func (s *InternalServerException) StatusCode() int { + return s.RespMetadata.StatusCode +} + +// RequestID returns the service's response RequestID for request. +func (s *InternalServerException) RequestID() string { + return s.RespMetadata.RequestID +} + +type ListAssessmentFrameworksInput struct { + _ struct{} `type:"structure"` + + // The type of framework, such as standard or custom. + // + // FrameworkType is a required field + FrameworkType *string `location:"querystring" locationName:"frameworkType" type:"string" required:"true" enum:"FrameworkType"` + + // Represents the maximum number of results per page, or per API request call. + MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"` + + // The pagination token used to fetch the next set of results. + NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"` +} + +// String returns the string representation +func (s ListAssessmentFrameworksInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s ListAssessmentFrameworksInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListAssessmentFrameworksInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListAssessmentFrameworksInput"} + if s.FrameworkType == nil { + invalidParams.Add(request.NewErrParamRequired("FrameworkType")) + } + if s.MaxResults != nil && *s.MaxResults < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) + } + if s.NextToken != nil && len(*s.NextToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("NextToken", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetFrameworkType sets the FrameworkType field's value. +func (s *ListAssessmentFrameworksInput) SetFrameworkType(v string) *ListAssessmentFrameworksInput { + s.FrameworkType = &v + return s +} + +// SetMaxResults sets the MaxResults field's value. +func (s *ListAssessmentFrameworksInput) SetMaxResults(v int64) *ListAssessmentFrameworksInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListAssessmentFrameworksInput) SetNextToken(v string) *ListAssessmentFrameworksInput { + s.NextToken = &v + return s +} + +type ListAssessmentFrameworksOutput struct { + _ struct{} `type:"structure"` + + // The list of metadata objects for the specified framework. + FrameworkMetadataList []*AssessmentFrameworkMetadata `locationName:"frameworkMetadataList" type:"list"` + + // The pagination token used to fetch the next set of results. + NextToken *string `locationName:"nextToken" min:"1" type:"string"` +} + +// String returns the string representation +func (s ListAssessmentFrameworksOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s ListAssessmentFrameworksOutput) GoString() string { + return s.String() +} + +// SetFrameworkMetadataList sets the FrameworkMetadataList field's value. +func (s *ListAssessmentFrameworksOutput) SetFrameworkMetadataList(v []*AssessmentFrameworkMetadata) *ListAssessmentFrameworksOutput { + s.FrameworkMetadataList = v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListAssessmentFrameworksOutput) SetNextToken(v string) *ListAssessmentFrameworksOutput { + s.NextToken = &v + return s +} + +type ListAssessmentReportsInput struct { + _ struct{} `type:"structure"` + + // Represents the maximum number of results per page, or per API request call. + MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"` + + // The pagination token used to fetch the next set of results. + NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"` +} + +// String returns the string representation +func (s ListAssessmentReportsInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s ListAssessmentReportsInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListAssessmentReportsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListAssessmentReportsInput"} + if s.MaxResults != nil && *s.MaxResults < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) + } + if s.NextToken != nil && len(*s.NextToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("NextToken", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetMaxResults sets the MaxResults field's value. +func (s *ListAssessmentReportsInput) SetMaxResults(v int64) *ListAssessmentReportsInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListAssessmentReportsInput) SetNextToken(v string) *ListAssessmentReportsInput { + s.NextToken = &v + return s +} + +type ListAssessmentReportsOutput struct { + _ struct{} `type:"structure"` + + // The list of assessment reports returned by the ListAssessmentReports API. + AssessmentReports []*AssessmentReportMetadata `locationName:"assessmentReports" type:"list"` + + // The pagination token used to fetch the next set of results. + NextToken *string `locationName:"nextToken" min:"1" type:"string"` +} + +// String returns the string representation +func (s ListAssessmentReportsOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s ListAssessmentReportsOutput) GoString() string { + return s.String() +} + +// SetAssessmentReports sets the AssessmentReports field's value. +func (s *ListAssessmentReportsOutput) SetAssessmentReports(v []*AssessmentReportMetadata) *ListAssessmentReportsOutput { + s.AssessmentReports = v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListAssessmentReportsOutput) SetNextToken(v string) *ListAssessmentReportsOutput { + s.NextToken = &v + return s +} + +type ListAssessmentsInput struct { + _ struct{} `type:"structure"` + + // Represents the maximum number of results per page, or per API request call. + MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"` + + // The pagination token used to fetch the next set of results. + NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"` +} + +// String returns the string representation +func (s ListAssessmentsInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s ListAssessmentsInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListAssessmentsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListAssessmentsInput"} + if s.MaxResults != nil && *s.MaxResults < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) + } + if s.NextToken != nil && len(*s.NextToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("NextToken", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetMaxResults sets the MaxResults field's value. +func (s *ListAssessmentsInput) SetMaxResults(v int64) *ListAssessmentsInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListAssessmentsInput) SetNextToken(v string) *ListAssessmentsInput { + s.NextToken = &v + return s +} + +type ListAssessmentsOutput struct { + _ struct{} `type:"structure"` + + // The metadata associated with the assessment. + AssessmentMetadata []*AssessmentMetadataItem `locationName:"assessmentMetadata" type:"list"` + + // The pagination token used to fetch the next set of results. + NextToken *string `locationName:"nextToken" min:"1" type:"string"` +} + +// String returns the string representation +func (s ListAssessmentsOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s ListAssessmentsOutput) GoString() string { + return s.String() +} + +// SetAssessmentMetadata sets the AssessmentMetadata field's value. +func (s *ListAssessmentsOutput) SetAssessmentMetadata(v []*AssessmentMetadataItem) *ListAssessmentsOutput { + s.AssessmentMetadata = v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListAssessmentsOutput) SetNextToken(v string) *ListAssessmentsOutput { + s.NextToken = &v + return s +} + +type ListControlsInput struct { + _ struct{} `type:"structure"` + + // The type of control, such as standard or custom. + // + // ControlType is a required field + ControlType *string `location:"querystring" locationName:"controlType" type:"string" required:"true" enum:"ControlType"` + + // Represents the maximum number of results per page, or per API request call. + MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"` + + // The pagination token used to fetch the next set of results. + NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"` +} + +// String returns the string representation +func (s ListControlsInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s ListControlsInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListControlsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListControlsInput"} + if s.ControlType == nil { + invalidParams.Add(request.NewErrParamRequired("ControlType")) + } + if s.MaxResults != nil && *s.MaxResults < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) + } + if s.NextToken != nil && len(*s.NextToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("NextToken", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetControlType sets the ControlType field's value. +func (s *ListControlsInput) SetControlType(v string) *ListControlsInput { + s.ControlType = &v + return s +} + +// SetMaxResults sets the MaxResults field's value. +func (s *ListControlsInput) SetMaxResults(v int64) *ListControlsInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListControlsInput) SetNextToken(v string) *ListControlsInput { + s.NextToken = &v + return s +} + +type ListControlsOutput struct { + _ struct{} `type:"structure"` + + // The list of control metadata objects returned by the ListControls API. + ControlMetadataList []*ControlMetadata `locationName:"controlMetadataList" type:"list"` + + // The pagination token used to fetch the next set of results. + NextToken *string `locationName:"nextToken" min:"1" type:"string"` +} + +// String returns the string representation +func (s ListControlsOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s ListControlsOutput) GoString() string { + return s.String() +} + +// SetControlMetadataList sets the ControlMetadataList field's value. +func (s *ListControlsOutput) SetControlMetadataList(v []*ControlMetadata) *ListControlsOutput { + s.ControlMetadataList = v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListControlsOutput) SetNextToken(v string) *ListControlsOutput { + s.NextToken = &v + return s +} + +type ListKeywordsForDataSourceInput struct { + _ struct{} `type:"structure"` + + // Represents the maximum number of results per page, or per API request call. + MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"` + + // The pagination token used to fetch the next set of results. + NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"` + + // The control mapping data source to which the keywords apply. + // + // Source is a required field + Source *string `location:"querystring" locationName:"source" type:"string" required:"true" enum:"SourceType"` +} + +// String returns the string representation +func (s ListKeywordsForDataSourceInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s ListKeywordsForDataSourceInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListKeywordsForDataSourceInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListKeywordsForDataSourceInput"} + if s.MaxResults != nil && *s.MaxResults < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) + } + if s.NextToken != nil && len(*s.NextToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("NextToken", 1)) + } + if s.Source == nil { + invalidParams.Add(request.NewErrParamRequired("Source")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetMaxResults sets the MaxResults field's value. +func (s *ListKeywordsForDataSourceInput) SetMaxResults(v int64) *ListKeywordsForDataSourceInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListKeywordsForDataSourceInput) SetNextToken(v string) *ListKeywordsForDataSourceInput { + s.NextToken = &v + return s +} + +// SetSource sets the Source field's value. +func (s *ListKeywordsForDataSourceInput) SetSource(v string) *ListKeywordsForDataSourceInput { + s.Source = &v + return s +} + +type ListKeywordsForDataSourceOutput struct { + _ struct{} `type:"structure"` + + // The list of keywords for the specified event mapping source. + Keywords []*string `locationName:"keywords" type:"list"` + + // The pagination token used to fetch the next set of results. + NextToken *string `locationName:"nextToken" min:"1" type:"string"` +} + +// String returns the string representation +func (s ListKeywordsForDataSourceOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s ListKeywordsForDataSourceOutput) GoString() string { + return s.String() +} + +// SetKeywords sets the Keywords field's value. +func (s *ListKeywordsForDataSourceOutput) SetKeywords(v []*string) *ListKeywordsForDataSourceOutput { + s.Keywords = v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListKeywordsForDataSourceOutput) SetNextToken(v string) *ListKeywordsForDataSourceOutput { + s.NextToken = &v + return s +} + +type ListNotificationsInput struct { + _ struct{} `type:"structure"` + + // Represents the maximum number of results per page, or per API request call. + MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"` + + // The pagination token used to fetch the next set of results. + NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"` +} + +// String returns the string representation +func (s ListNotificationsInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s ListNotificationsInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListNotificationsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListNotificationsInput"} + if s.MaxResults != nil && *s.MaxResults < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) + } + if s.NextToken != nil && len(*s.NextToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("NextToken", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetMaxResults sets the MaxResults field's value. +func (s *ListNotificationsInput) SetMaxResults(v int64) *ListNotificationsInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListNotificationsInput) SetNextToken(v string) *ListNotificationsInput { + s.NextToken = &v + return s +} + +type ListNotificationsOutput struct { + _ struct{} `type:"structure"` + + // The pagination token used to fetch the next set of results. + NextToken *string `locationName:"nextToken" min:"1" type:"string"` + + // The returned list of notifications. + Notifications []*Notification `locationName:"notifications" type:"list"` +} + +// String returns the string representation +func (s ListNotificationsOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s ListNotificationsOutput) GoString() string { + return s.String() +} + +// SetNextToken sets the NextToken field's value. +func (s *ListNotificationsOutput) SetNextToken(v string) *ListNotificationsOutput { + s.NextToken = &v + return s +} + +// SetNotifications sets the Notifications field's value. +func (s *ListNotificationsOutput) SetNotifications(v []*Notification) *ListNotificationsOutput { + s.Notifications = v + return s +} + +type ListTagsForResourceInput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the specified resource. + // + // ResourceArn is a required field + ResourceArn *string `location:"uri" locationName:"resourceArn" min:"20" type:"string" required:"true"` +} + +// String returns the string representation +func (s ListTagsForResourceInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s ListTagsForResourceInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListTagsForResourceInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListTagsForResourceInput"} + if s.ResourceArn == nil { + invalidParams.Add(request.NewErrParamRequired("ResourceArn")) + } + if s.ResourceArn != nil && len(*s.ResourceArn) < 20 { + invalidParams.Add(request.NewErrParamMinLen("ResourceArn", 20)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetResourceArn sets the ResourceArn field's value. +func (s *ListTagsForResourceInput) SetResourceArn(v string) *ListTagsForResourceInput { + s.ResourceArn = &v + return s +} + +type ListTagsForResourceOutput struct { + _ struct{} `type:"structure"` + + // The list of tags returned by the ListTagsForResource API. + Tags map[string]*string `locationName:"tags" type:"map"` +} + +// String returns the string representation +func (s ListTagsForResourceOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s ListTagsForResourceOutput) GoString() string { + return s.String() +} + +// SetTags sets the Tags field's value. +func (s *ListTagsForResourceOutput) SetTags(v map[string]*string) *ListTagsForResourceOutput { + s.Tags = v + return s +} + +// Evidence that is uploaded to AWS Audit Manager manually. +type ManualEvidence struct { + _ struct{} `type:"structure"` + + // The Amazon S3 URL that points to a manual evidence object. + S3ResourcePath *string `locationName:"s3ResourcePath" min:"1" type:"string"` +} + +// String returns the string representation +func (s ManualEvidence) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s ManualEvidence) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ManualEvidence) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ManualEvidence"} + if s.S3ResourcePath != nil && len(*s.S3ResourcePath) < 1 { + invalidParams.Add(request.NewErrParamMinLen("S3ResourcePath", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetS3ResourcePath sets the S3ResourcePath field's value. +func (s *ManualEvidence) SetS3ResourcePath(v string) *ManualEvidence { + s.S3ResourcePath = &v + return s +} + +// The notification used to inform a user of an update in AWS Audit Manager. +// For example, this includes the notification that is sent when a control set +// is delegated for review. +type Notification struct { + _ struct{} `type:"structure"` + + // The identifier for the specified assessment. + AssessmentId *string `locationName:"assessmentId" min:"36" type:"string"` + + // The name of the related assessment. + AssessmentName *string `locationName:"assessmentName" min:"1" type:"string"` + + // The identifier for the specified control set. + ControlSetId *string `locationName:"controlSetId" min:"1" type:"string"` + + // Specifies the name of the control set that the notification is about. + ControlSetName *string `locationName:"controlSetName" min:"1" type:"string"` + + // The description of the notification. + Description *string `locationName:"description" min:"1" type:"string"` + + // The time when the notification was sent. + EventTime *time.Time `locationName:"eventTime" type:"timestamp"` + + // The unique identifier for the notification. + Id *string `locationName:"id" min:"47" type:"string"` + + // The sender of the notification. + Source *string `locationName:"source" min:"1" type:"string"` +} + +// String returns the string representation +func (s Notification) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s Notification) GoString() string { + return s.String() +} + +// SetAssessmentId sets the AssessmentId field's value. +func (s *Notification) SetAssessmentId(v string) *Notification { + s.AssessmentId = &v + return s +} + +// SetAssessmentName sets the AssessmentName field's value. +func (s *Notification) SetAssessmentName(v string) *Notification { + s.AssessmentName = &v + return s +} + +// SetControlSetId sets the ControlSetId field's value. +func (s *Notification) SetControlSetId(v string) *Notification { + s.ControlSetId = &v + return s +} + +// SetControlSetName sets the ControlSetName field's value. +func (s *Notification) SetControlSetName(v string) *Notification { + s.ControlSetName = &v + return s +} + +// SetDescription sets the Description field's value. +func (s *Notification) SetDescription(v string) *Notification { + s.Description = &v + return s +} + +// SetEventTime sets the EventTime field's value. +func (s *Notification) SetEventTime(v time.Time) *Notification { + s.EventTime = &v + return s +} + +// SetId sets the Id field's value. +func (s *Notification) SetId(v string) *Notification { + s.Id = &v + return s +} + +// SetSource sets the Source field's value. +func (s *Notification) SetSource(v string) *Notification { + s.Source = &v + return s +} + +type RegisterAccountInput struct { + _ struct{} `type:"structure"` + + // The delegated administrator account for AWS Audit Manager. + DelegatedAdminAccount *string `locationName:"delegatedAdminAccount" min:"12" type:"string"` + + // The AWS KMS key details. + KmsKey *string `locationName:"kmsKey" min:"7" type:"string"` +} + +// String returns the string representation +func (s RegisterAccountInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s RegisterAccountInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *RegisterAccountInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "RegisterAccountInput"} + if s.DelegatedAdminAccount != nil && len(*s.DelegatedAdminAccount) < 12 { + invalidParams.Add(request.NewErrParamMinLen("DelegatedAdminAccount", 12)) + } + if s.KmsKey != nil && len(*s.KmsKey) < 7 { + invalidParams.Add(request.NewErrParamMinLen("KmsKey", 7)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDelegatedAdminAccount sets the DelegatedAdminAccount field's value. +func (s *RegisterAccountInput) SetDelegatedAdminAccount(v string) *RegisterAccountInput { + s.DelegatedAdminAccount = &v + return s +} + +// SetKmsKey sets the KmsKey field's value. +func (s *RegisterAccountInput) SetKmsKey(v string) *RegisterAccountInput { + s.KmsKey = &v + return s +} + +type RegisterAccountOutput struct { + _ struct{} `type:"structure"` + + // The status of the account registration request. + Status *string `locationName:"status" type:"string" enum:"AccountStatus"` +} + +// String returns the string representation +func (s RegisterAccountOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s RegisterAccountOutput) GoString() string { + return s.String() +} + +// SetStatus sets the Status field's value. +func (s *RegisterAccountOutput) SetStatus(v string) *RegisterAccountOutput { + s.Status = &v + return s +} + +type RegisterOrganizationAdminAccountInput struct { + _ struct{} `type:"structure"` + + // The identifier for the specified delegated administrator account. + // + // AdminAccountId is a required field + AdminAccountId *string `locationName:"adminAccountId" min:"12" type:"string" required:"true"` +} + +// String returns the string representation +func (s RegisterOrganizationAdminAccountInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s RegisterOrganizationAdminAccountInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *RegisterOrganizationAdminAccountInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "RegisterOrganizationAdminAccountInput"} + if s.AdminAccountId == nil { + invalidParams.Add(request.NewErrParamRequired("AdminAccountId")) + } + if s.AdminAccountId != nil && len(*s.AdminAccountId) < 12 { + invalidParams.Add(request.NewErrParamMinLen("AdminAccountId", 12)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAdminAccountId sets the AdminAccountId field's value. +func (s *RegisterOrganizationAdminAccountInput) SetAdminAccountId(v string) *RegisterOrganizationAdminAccountInput { + s.AdminAccountId = &v + return s +} + +type RegisterOrganizationAdminAccountOutput struct { + _ struct{} `type:"structure"` + + // The identifier for the specified delegated administrator account. + AdminAccountId *string `locationName:"adminAccountId" min:"12" type:"string"` + + // The identifier for the specified AWS organization. + OrganizationId *string `locationName:"organizationId" min:"12" type:"string"` +} + +// String returns the string representation +func (s RegisterOrganizationAdminAccountOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s RegisterOrganizationAdminAccountOutput) GoString() string { + return s.String() +} + +// SetAdminAccountId sets the AdminAccountId field's value. +func (s *RegisterOrganizationAdminAccountOutput) SetAdminAccountId(v string) *RegisterOrganizationAdminAccountOutput { + s.AdminAccountId = &v + return s +} + +// SetOrganizationId sets the OrganizationId field's value. +func (s *RegisterOrganizationAdminAccountOutput) SetOrganizationId(v string) *RegisterOrganizationAdminAccountOutput { + s.OrganizationId = &v + return s +} + +// A system asset that is evaluated in an AWS Audit Manager assessment. +type Resource struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) for the specified resource. + Arn *string `locationName:"arn" min:"20" type:"string"` + + // The value of the specified resource. + Value *string `locationName:"value" type:"string"` +} + +// String returns the string representation +func (s Resource) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s Resource) GoString() string { + return s.String() +} + +// SetArn sets the Arn field's value. +func (s *Resource) SetArn(v string) *Resource { + s.Arn = &v + return s +} + +// SetValue sets the Value field's value. +func (s *Resource) SetValue(v string) *Resource { + s.Value = &v + return s +} + +// The resource specified in the request cannot be found. +type ResourceNotFoundException struct { + _ struct{} `type:"structure"` + RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` + + Message_ *string `locationName:"message" type:"string"` + + // The unique identifier for the specified resource. + // + // ResourceId is a required field + ResourceId *string `locationName:"resourceId" type:"string" required:"true"` + + // The type of resource affected by the error. + // + // ResourceType is a required field + ResourceType *string `locationName:"resourceType" type:"string" required:"true"` +} + +// String returns the string representation +func (s ResourceNotFoundException) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s ResourceNotFoundException) GoString() string { + return s.String() +} + +func newErrorResourceNotFoundException(v protocol.ResponseMetadata) error { + return &ResourceNotFoundException{ + RespMetadata: v, + } +} + +// Code returns the exception type name. +func (s *ResourceNotFoundException) Code() string { + return "ResourceNotFoundException" +} + +// Message returns the exception's message. +func (s *ResourceNotFoundException) Message() string { + if s.Message_ != nil { + return *s.Message_ + } + return "" +} + +// OrigErr always returns nil, satisfies awserr.Error interface. +func (s *ResourceNotFoundException) OrigErr() error { + return nil +} + +func (s *ResourceNotFoundException) Error() string { + return fmt.Sprintf("%s: %s\n%s", s.Code(), s.Message(), s.String()) +} + +// Status code returns the HTTP status code for the request's response error. +func (s *ResourceNotFoundException) StatusCode() int { + return s.RespMetadata.StatusCode +} + +// RequestID returns the service's response RequestID for request. +func (s *ResourceNotFoundException) RequestID() string { + return s.RespMetadata.RequestID +} + +// The wrapper that contains AWS Audit Manager role information, such as the +// role type and IAM Amazon Resource Name (ARN). +type Role struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the IAM role. + RoleArn *string `locationName:"roleArn" min:"20" type:"string"` + + // 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. + RoleType *string `locationName:"roleType" type:"string" enum:"RoleType"` +} + +// String returns the string representation +func (s Role) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s Role) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *Role) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "Role"} + if s.RoleArn != nil && len(*s.RoleArn) < 20 { + invalidParams.Add(request.NewErrParamMinLen("RoleArn", 20)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetRoleArn sets the RoleArn field's value. +func (s *Role) SetRoleArn(v string) *Role { + s.RoleArn = &v + return s +} + +// SetRoleType sets the RoleType field's value. +func (s *Role) SetRoleType(v string) *Role { + s.RoleType = &v + return s +} + +// The wrapper that contains the AWS accounts and AWS services in scope for +// the assessment. +type Scope struct { + _ struct{} `type:"structure"` + + // The AWS accounts included in the scope of the assessment. + AwsAccounts []*AWSAccount `locationName:"awsAccounts" type:"list"` + + // The AWS services included in the scope of the assessment. + AwsServices []*AWSService `locationName:"awsServices" type:"list"` +} + +// String returns the string representation +func (s Scope) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s Scope) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *Scope) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "Scope"} + if s.AwsAccounts != nil { + for i, v := range s.AwsAccounts { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "AwsAccounts", i), err.(request.ErrInvalidParams)) + } + } + } + if s.AwsServices != nil { + for i, v := range s.AwsServices { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "AwsServices", i), err.(request.ErrInvalidParams)) + } + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAwsAccounts sets the AwsAccounts field's value. +func (s *Scope) SetAwsAccounts(v []*AWSAccount) *Scope { + s.AwsAccounts = v + return s +} + +// SetAwsServices sets the AwsServices field's value. +func (s *Scope) SetAwsServices(v []*AWSService) *Scope { + s.AwsServices = v + return s +} + +// The metadata associated with the specified AWS service. +type ServiceMetadata struct { + _ struct{} `type:"structure"` + + // The category in which the AWS service belongs, such as compute, storage, + // database, and so on. + Category *string `locationName:"category" min:"1" type:"string"` + + // The description of the specified AWS service. + Description *string `locationName:"description" min:"1" type:"string"` + + // The display name of the AWS service. + DisplayName *string `locationName:"displayName" min:"1" type:"string"` + + // The name of the AWS service. + Name *string `locationName:"name" min:"1" type:"string"` +} + +// String returns the string representation +func (s ServiceMetadata) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s ServiceMetadata) GoString() string { + return s.String() +} + +// SetCategory sets the Category field's value. +func (s *ServiceMetadata) SetCategory(v string) *ServiceMetadata { + s.Category = &v + return s +} + +// SetDescription sets the Description field's value. +func (s *ServiceMetadata) SetDescription(v string) *ServiceMetadata { + s.Description = &v + return s +} + +// SetDisplayName sets the DisplayName field's value. +func (s *ServiceMetadata) SetDisplayName(v string) *ServiceMetadata { + s.DisplayName = &v + return s +} + +// SetName sets the Name field's value. +func (s *ServiceMetadata) SetName(v string) *ServiceMetadata { + s.Name = &v + return s +} + +// The settings object that holds all supported AWS Audit Manager settings. +type Settings struct { + _ struct{} `type:"structure"` + + // The default storage destination for assessment reports. + DefaultAssessmentReportsDestination *AssessmentReportsDestination `locationName:"defaultAssessmentReportsDestination" type:"structure"` + + // The designated default audit owners. + DefaultProcessOwners []*Role `locationName:"defaultProcessOwners" type:"list"` + + // Specifies whether AWS Organizations is enabled. + IsAwsOrgEnabled *bool `locationName:"isAwsOrgEnabled" type:"boolean"` + + // The AWS KMS key details. + KmsKey *string `locationName:"kmsKey" min:"7" type:"string"` + + // The designated Amazon Simple Notification Service (Amazon SNS) topic. + SnsTopic *string `locationName:"snsTopic" min:"1" type:"string"` +} + +// String returns the string representation +func (s Settings) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s Settings) GoString() string { + return s.String() +} + +// SetDefaultAssessmentReportsDestination sets the DefaultAssessmentReportsDestination field's value. +func (s *Settings) SetDefaultAssessmentReportsDestination(v *AssessmentReportsDestination) *Settings { + s.DefaultAssessmentReportsDestination = v + return s +} + +// SetDefaultProcessOwners sets the DefaultProcessOwners field's value. +func (s *Settings) SetDefaultProcessOwners(v []*Role) *Settings { + s.DefaultProcessOwners = v + return s +} + +// SetIsAwsOrgEnabled sets the IsAwsOrgEnabled field's value. +func (s *Settings) SetIsAwsOrgEnabled(v bool) *Settings { + s.IsAwsOrgEnabled = &v + return s +} + +// SetKmsKey sets the KmsKey field's value. +func (s *Settings) SetKmsKey(v string) *Settings { + s.KmsKey = &v + return s +} + +// SetSnsTopic sets the SnsTopic field's value. +func (s *Settings) SetSnsTopic(v string) *Settings { + s.SnsTopic = &v + return s +} + +// The keyword to search for in AWS CloudTrail logs. +type SourceKeyword struct { + _ struct{} `type:"structure"` + + // The method of input for the specified keyword. + KeywordInputType *string `locationName:"keywordInputType" type:"string" enum:"KeywordInputType"` + + // The value of the keyword used to search AWS CloudTrail logs when mapping + // a control data source. + KeywordValue *string `locationName:"keywordValue" min:"1" type:"string"` +} + +// String returns the string representation +func (s SourceKeyword) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s SourceKeyword) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *SourceKeyword) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "SourceKeyword"} + if s.KeywordValue != nil && len(*s.KeywordValue) < 1 { + invalidParams.Add(request.NewErrParamMinLen("KeywordValue", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetKeywordInputType sets the KeywordInputType field's value. +func (s *SourceKeyword) SetKeywordInputType(v string) *SourceKeyword { + s.KeywordInputType = &v + return s +} + +// SetKeywordValue sets the KeywordValue field's value. +func (s *SourceKeyword) SetKeywordValue(v string) *SourceKeyword { + s.KeywordValue = &v + return s +} + +type TagResourceInput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the specified resource. + // + // ResourceArn is a required field + ResourceArn *string `location:"uri" locationName:"resourceArn" min:"20" type:"string" required:"true"` + + // The tags to be associated with the resource. + // + // Tags is a required field + Tags map[string]*string `locationName:"tags" type:"map" required:"true"` +} + +// String returns the string representation +func (s TagResourceInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s TagResourceInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *TagResourceInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "TagResourceInput"} + if s.ResourceArn == nil { + invalidParams.Add(request.NewErrParamRequired("ResourceArn")) + } + if s.ResourceArn != nil && len(*s.ResourceArn) < 20 { + invalidParams.Add(request.NewErrParamMinLen("ResourceArn", 20)) + } + if s.Tags == nil { + invalidParams.Add(request.NewErrParamRequired("Tags")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetResourceArn sets the ResourceArn field's value. +func (s *TagResourceInput) SetResourceArn(v string) *TagResourceInput { + s.ResourceArn = &v + return s +} + +// SetTags sets the Tags field's value. +func (s *TagResourceInput) SetTags(v map[string]*string) *TagResourceInput { + s.Tags = v + return s +} + +type TagResourceOutput struct { + _ struct{} `type:"structure"` +} + +// String returns the string representation +func (s TagResourceOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s TagResourceOutput) GoString() string { + return s.String() +} + +// A uniform resource locator, used as a unique identifier to locate a resource +// on the internet. +type URL struct { + _ struct{} `type:"structure"` + + // The name or word used as a hyperlink to the URL. + HyperlinkName *string `locationName:"hyperlinkName" min:"1" type:"string"` + + // The unique identifier for the internet resource. + Link *string `locationName:"link" min:"1" type:"string"` +} + +// String returns the string representation +func (s URL) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s URL) GoString() string { + return s.String() +} + +// SetHyperlinkName sets the HyperlinkName field's value. +func (s *URL) SetHyperlinkName(v string) *URL { + s.HyperlinkName = &v + return s +} + +// SetLink sets the Link field's value. +func (s *URL) SetLink(v string) *URL { + s.Link = &v + return s +} + +type UntagResourceInput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the specified resource. + // + // ResourceArn is a required field + ResourceArn *string `location:"uri" locationName:"resourceArn" min:"20" type:"string" required:"true"` + + // The name or key of the tag. + // + // TagKeys is a required field + TagKeys []*string `location:"querystring" locationName:"tagKeys" min:"1" type:"list" required:"true"` +} + +// String returns the string representation +func (s UntagResourceInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s UntagResourceInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *UntagResourceInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "UntagResourceInput"} + if s.ResourceArn == nil { + invalidParams.Add(request.NewErrParamRequired("ResourceArn")) + } + if s.ResourceArn != nil && len(*s.ResourceArn) < 20 { + invalidParams.Add(request.NewErrParamMinLen("ResourceArn", 20)) + } + if s.TagKeys == nil { + invalidParams.Add(request.NewErrParamRequired("TagKeys")) + } + if s.TagKeys != nil && len(s.TagKeys) < 1 { + invalidParams.Add(request.NewErrParamMinLen("TagKeys", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetResourceArn sets the ResourceArn field's value. +func (s *UntagResourceInput) SetResourceArn(v string) *UntagResourceInput { + s.ResourceArn = &v + return s +} + +// SetTagKeys sets the TagKeys field's value. +func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput { + s.TagKeys = v + return s +} + +type UntagResourceOutput struct { + _ struct{} `type:"structure"` +} + +// String returns the string representation +func (s UntagResourceOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s UntagResourceOutput) GoString() string { + return s.String() +} + +type UpdateAssessmentControlInput struct { + _ struct{} `type:"structure"` + + // The identifier for the specified assessment. + // + // AssessmentId is a required field + AssessmentId *string `location:"uri" locationName:"assessmentId" min:"36" type:"string" required:"true"` + + // The comment body text for the specified control. + CommentBody *string `locationName:"commentBody" type:"string"` + + // The identifier for the specified control. + // + // ControlId is a required field + ControlId *string `location:"uri" locationName:"controlId" min:"36" type:"string" required:"true"` + + // The identifier for the specified control set. + // + // ControlSetId is a required field + ControlSetId *string `location:"uri" locationName:"controlSetId" min:"1" type:"string" required:"true"` + + // The status of the specified control. + ControlStatus *string `locationName:"controlStatus" type:"string" enum:"ControlStatus"` +} + +// String returns the string representation +func (s UpdateAssessmentControlInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s UpdateAssessmentControlInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *UpdateAssessmentControlInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "UpdateAssessmentControlInput"} + if s.AssessmentId == nil { + invalidParams.Add(request.NewErrParamRequired("AssessmentId")) + } + if s.AssessmentId != nil && len(*s.AssessmentId) < 36 { + invalidParams.Add(request.NewErrParamMinLen("AssessmentId", 36)) + } + if s.ControlId == nil { + invalidParams.Add(request.NewErrParamRequired("ControlId")) + } + if s.ControlId != nil && len(*s.ControlId) < 36 { + invalidParams.Add(request.NewErrParamMinLen("ControlId", 36)) + } + if s.ControlSetId == nil { + invalidParams.Add(request.NewErrParamRequired("ControlSetId")) + } + if s.ControlSetId != nil && len(*s.ControlSetId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ControlSetId", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAssessmentId sets the AssessmentId field's value. +func (s *UpdateAssessmentControlInput) SetAssessmentId(v string) *UpdateAssessmentControlInput { + s.AssessmentId = &v + return s +} + +// SetCommentBody sets the CommentBody field's value. +func (s *UpdateAssessmentControlInput) SetCommentBody(v string) *UpdateAssessmentControlInput { + s.CommentBody = &v + return s +} + +// SetControlId sets the ControlId field's value. +func (s *UpdateAssessmentControlInput) SetControlId(v string) *UpdateAssessmentControlInput { + s.ControlId = &v + return s +} + +// SetControlSetId sets the ControlSetId field's value. +func (s *UpdateAssessmentControlInput) SetControlSetId(v string) *UpdateAssessmentControlInput { + s.ControlSetId = &v + return s +} + +// SetControlStatus sets the ControlStatus field's value. +func (s *UpdateAssessmentControlInput) SetControlStatus(v string) *UpdateAssessmentControlInput { + s.ControlStatus = &v + return s +} + +type UpdateAssessmentControlOutput struct { + _ struct{} `type:"structure"` + + // The name of the updated control set returned by the UpdateAssessmentControl + // API. + Control *AssessmentControl `locationName:"control" type:"structure"` +} + +// String returns the string representation +func (s UpdateAssessmentControlOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s UpdateAssessmentControlOutput) GoString() string { + return s.String() +} + +// SetControl sets the Control field's value. +func (s *UpdateAssessmentControlOutput) SetControl(v *AssessmentControl) *UpdateAssessmentControlOutput { + s.Control = v + return s +} + +type UpdateAssessmentControlSetStatusInput struct { + _ struct{} `type:"structure"` + + // The identifier for the specified assessment. + // + // AssessmentId is a required field + AssessmentId *string `location:"uri" locationName:"assessmentId" min:"36" type:"string" required:"true"` + + // The comment related to the status update. + // + // Comment is a required field + Comment *string `locationName:"comment" type:"string" required:"true"` + + // The identifier for the specified control set. + // + // ControlSetId is a required field + ControlSetId *string `location:"uri" locationName:"controlSetId" type:"string" required:"true"` + + // The status of the control set that is being updated. + // + // Status is a required field + Status *string `locationName:"status" type:"string" required:"true" enum:"ControlSetStatus"` +} + +// String returns the string representation +func (s UpdateAssessmentControlSetStatusInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s UpdateAssessmentControlSetStatusInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *UpdateAssessmentControlSetStatusInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "UpdateAssessmentControlSetStatusInput"} + if s.AssessmentId == nil { + invalidParams.Add(request.NewErrParamRequired("AssessmentId")) + } + if s.AssessmentId != nil && len(*s.AssessmentId) < 36 { + invalidParams.Add(request.NewErrParamMinLen("AssessmentId", 36)) + } + if s.Comment == nil { + invalidParams.Add(request.NewErrParamRequired("Comment")) + } + if s.ControlSetId == nil { + invalidParams.Add(request.NewErrParamRequired("ControlSetId")) + } + if s.ControlSetId != nil && len(*s.ControlSetId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ControlSetId", 1)) + } + if s.Status == nil { + invalidParams.Add(request.NewErrParamRequired("Status")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAssessmentId sets the AssessmentId field's value. +func (s *UpdateAssessmentControlSetStatusInput) SetAssessmentId(v string) *UpdateAssessmentControlSetStatusInput { + s.AssessmentId = &v + return s +} + +// SetComment sets the Comment field's value. +func (s *UpdateAssessmentControlSetStatusInput) SetComment(v string) *UpdateAssessmentControlSetStatusInput { + s.Comment = &v + return s +} + +// SetControlSetId sets the ControlSetId field's value. +func (s *UpdateAssessmentControlSetStatusInput) SetControlSetId(v string) *UpdateAssessmentControlSetStatusInput { + s.ControlSetId = &v + return s +} + +// SetStatus sets the Status field's value. +func (s *UpdateAssessmentControlSetStatusInput) SetStatus(v string) *UpdateAssessmentControlSetStatusInput { + s.Status = &v + return s +} + +type UpdateAssessmentControlSetStatusOutput struct { + _ struct{} `type:"structure"` + + // The name of the updated control set returned by the UpdateAssessmentControlSetStatus + // API. + ControlSet *AssessmentControlSet `locationName:"controlSet" type:"structure"` +} + +// String returns the string representation +func (s UpdateAssessmentControlSetStatusOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s UpdateAssessmentControlSetStatusOutput) GoString() string { + return s.String() +} + +// SetControlSet sets the ControlSet field's value. +func (s *UpdateAssessmentControlSetStatusOutput) SetControlSet(v *AssessmentControlSet) *UpdateAssessmentControlSetStatusOutput { + s.ControlSet = v + return s +} + +// A controlSet entity that represents a collection of controls in AWS Audit +// Manager. This does not contain the control set ID. +type UpdateAssessmentFrameworkControlSet struct { + _ struct{} `type:"structure"` + + // The list of controls contained within the control set. + Controls []*CreateAssessmentFrameworkControl `locationName:"controls" min:"1" type:"list"` + + // The unique identifier for the control set. + Id *string `locationName:"id" min:"36" type:"string"` + + // The name of the control set. + Name *string `locationName:"name" min:"1" type:"string"` +} + +// String returns the string representation +func (s UpdateAssessmentFrameworkControlSet) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s UpdateAssessmentFrameworkControlSet) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *UpdateAssessmentFrameworkControlSet) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "UpdateAssessmentFrameworkControlSet"} + if s.Controls != nil && len(s.Controls) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Controls", 1)) + } + if s.Id != nil && len(*s.Id) < 36 { + invalidParams.Add(request.NewErrParamMinLen("Id", 36)) + } + if s.Name != nil && len(*s.Name) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Name", 1)) + } + if s.Controls != nil { + for i, v := range s.Controls { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Controls", i), err.(request.ErrInvalidParams)) + } + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetControls sets the Controls field's value. +func (s *UpdateAssessmentFrameworkControlSet) SetControls(v []*CreateAssessmentFrameworkControl) *UpdateAssessmentFrameworkControlSet { + s.Controls = v + return s +} + +// SetId sets the Id field's value. +func (s *UpdateAssessmentFrameworkControlSet) SetId(v string) *UpdateAssessmentFrameworkControlSet { + s.Id = &v + return s +} + +// SetName sets the Name field's value. +func (s *UpdateAssessmentFrameworkControlSet) SetName(v string) *UpdateAssessmentFrameworkControlSet { + s.Name = &v + return s +} + +type UpdateAssessmentFrameworkInput struct { + _ struct{} `type:"structure"` + + // The compliance type that the new custom framework supports, such as CIS or + // HIPAA. + ComplianceType *string `locationName:"complianceType" type:"string"` + + // The control sets associated with the framework. + // + // ControlSets is a required field + ControlSets []*UpdateAssessmentFrameworkControlSet `locationName:"controlSets" type:"list" required:"true"` + + // The description of the framework that is to be updated. + Description *string `locationName:"description" min:"1" type:"string"` + + // The identifier for the specified framework. + // + // FrameworkId is a required field + FrameworkId *string `location:"uri" locationName:"frameworkId" min:"36" type:"string" required:"true"` + + // The name of the framework to be updated. + // + // Name is a required field + Name *string `locationName:"name" min:"1" type:"string" required:"true"` +} + +// String returns the string representation +func (s UpdateAssessmentFrameworkInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s UpdateAssessmentFrameworkInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *UpdateAssessmentFrameworkInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "UpdateAssessmentFrameworkInput"} + if s.ControlSets == nil { + invalidParams.Add(request.NewErrParamRequired("ControlSets")) + } + if s.Description != nil && len(*s.Description) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Description", 1)) + } + if s.FrameworkId == nil { + invalidParams.Add(request.NewErrParamRequired("FrameworkId")) + } + if s.FrameworkId != nil && len(*s.FrameworkId) < 36 { + invalidParams.Add(request.NewErrParamMinLen("FrameworkId", 36)) + } + if s.Name == nil { + invalidParams.Add(request.NewErrParamRequired("Name")) + } + if s.Name != nil && len(*s.Name) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Name", 1)) + } + if s.ControlSets != nil { + for i, v := range s.ControlSets { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "ControlSets", i), err.(request.ErrInvalidParams)) + } + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetComplianceType sets the ComplianceType field's value. +func (s *UpdateAssessmentFrameworkInput) SetComplianceType(v string) *UpdateAssessmentFrameworkInput { + s.ComplianceType = &v + return s +} + +// SetControlSets sets the ControlSets field's value. +func (s *UpdateAssessmentFrameworkInput) SetControlSets(v []*UpdateAssessmentFrameworkControlSet) *UpdateAssessmentFrameworkInput { + s.ControlSets = v + return s +} + +// SetDescription sets the Description field's value. +func (s *UpdateAssessmentFrameworkInput) SetDescription(v string) *UpdateAssessmentFrameworkInput { + s.Description = &v + return s +} + +// SetFrameworkId sets the FrameworkId field's value. +func (s *UpdateAssessmentFrameworkInput) SetFrameworkId(v string) *UpdateAssessmentFrameworkInput { + s.FrameworkId = &v + return s +} + +// SetName sets the Name field's value. +func (s *UpdateAssessmentFrameworkInput) SetName(v string) *UpdateAssessmentFrameworkInput { + s.Name = &v + return s +} + +type UpdateAssessmentFrameworkOutput struct { + _ struct{} `type:"structure"` + + // The name of the specified framework. + Framework *Framework `locationName:"framework" type:"structure"` +} + +// String returns the string representation +func (s UpdateAssessmentFrameworkOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s UpdateAssessmentFrameworkOutput) GoString() string { + return s.String() +} + +// SetFramework sets the Framework field's value. +func (s *UpdateAssessmentFrameworkOutput) SetFramework(v *Framework) *UpdateAssessmentFrameworkOutput { + s.Framework = v + return s +} + +type UpdateAssessmentInput struct { + _ struct{} `type:"structure"` + + // The description of the specified assessment. + AssessmentDescription *string `locationName:"assessmentDescription" type:"string"` + + // The identifier for the specified assessment. + // + // AssessmentId is a required field + AssessmentId *string `location:"uri" locationName:"assessmentId" min:"36" type:"string" required:"true"` + + // The name of the specified assessment to be updated. + AssessmentName *string `locationName:"assessmentName" min:"1" type:"string"` + + // The assessment report storage destination for the specified assessment that + // is being updated. + AssessmentReportsDestination *AssessmentReportsDestination `locationName:"assessmentReportsDestination" type:"structure"` + + // The list of roles for the specified assessment. + Roles []*Role `locationName:"roles" type:"list"` + + // The scope of the specified assessment. + // + // Scope is a required field + Scope *Scope `locationName:"scope" type:"structure" required:"true"` +} + +// String returns the string representation +func (s UpdateAssessmentInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s UpdateAssessmentInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *UpdateAssessmentInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "UpdateAssessmentInput"} + if s.AssessmentId == nil { + invalidParams.Add(request.NewErrParamRequired("AssessmentId")) + } + if s.AssessmentId != nil && len(*s.AssessmentId) < 36 { + invalidParams.Add(request.NewErrParamMinLen("AssessmentId", 36)) + } + if s.AssessmentName != nil && len(*s.AssessmentName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("AssessmentName", 1)) + } + if s.Scope == nil { + invalidParams.Add(request.NewErrParamRequired("Scope")) + } + if s.AssessmentReportsDestination != nil { + if err := s.AssessmentReportsDestination.Validate(); err != nil { + invalidParams.AddNested("AssessmentReportsDestination", err.(request.ErrInvalidParams)) + } + } + if s.Roles != nil { + for i, v := range s.Roles { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Roles", i), err.(request.ErrInvalidParams)) + } + } + } + if s.Scope != nil { + if err := s.Scope.Validate(); err != nil { + invalidParams.AddNested("Scope", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAssessmentDescription sets the AssessmentDescription field's value. +func (s *UpdateAssessmentInput) SetAssessmentDescription(v string) *UpdateAssessmentInput { + s.AssessmentDescription = &v + return s +} + +// SetAssessmentId sets the AssessmentId field's value. +func (s *UpdateAssessmentInput) SetAssessmentId(v string) *UpdateAssessmentInput { + s.AssessmentId = &v + return s +} + +// SetAssessmentName sets the AssessmentName field's value. +func (s *UpdateAssessmentInput) SetAssessmentName(v string) *UpdateAssessmentInput { + s.AssessmentName = &v + return s +} + +// SetAssessmentReportsDestination sets the AssessmentReportsDestination field's value. +func (s *UpdateAssessmentInput) SetAssessmentReportsDestination(v *AssessmentReportsDestination) *UpdateAssessmentInput { + s.AssessmentReportsDestination = v + return s +} + +// SetRoles sets the Roles field's value. +func (s *UpdateAssessmentInput) SetRoles(v []*Role) *UpdateAssessmentInput { + s.Roles = v + return s +} + +// SetScope sets the Scope field's value. +func (s *UpdateAssessmentInput) SetScope(v *Scope) *UpdateAssessmentInput { + s.Scope = v + return s +} + +type UpdateAssessmentOutput struct { + _ struct{} `type:"structure"` + + // The response object (name of the updated assessment) for the UpdateAssessmentRequest + // API. + Assessment *Assessment `locationName:"assessment" type:"structure"` +} + +// String returns the string representation +func (s UpdateAssessmentOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s UpdateAssessmentOutput) GoString() string { + return s.String() +} + +// SetAssessment sets the Assessment field's value. +func (s *UpdateAssessmentOutput) SetAssessment(v *Assessment) *UpdateAssessmentOutput { + s.Assessment = v + return s +} + +type UpdateAssessmentStatusInput struct { + _ struct{} `type:"structure"` + + // The identifier for the specified assessment. + // + // AssessmentId is a required field + AssessmentId *string `location:"uri" locationName:"assessmentId" min:"36" type:"string" required:"true"` + + // The current status of the specified assessment. + // + // Status is a required field + Status *string `locationName:"status" type:"string" required:"true" enum:"AssessmentStatus"` +} + +// String returns the string representation +func (s UpdateAssessmentStatusInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s UpdateAssessmentStatusInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *UpdateAssessmentStatusInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "UpdateAssessmentStatusInput"} + if s.AssessmentId == nil { + invalidParams.Add(request.NewErrParamRequired("AssessmentId")) + } + if s.AssessmentId != nil && len(*s.AssessmentId) < 36 { + invalidParams.Add(request.NewErrParamMinLen("AssessmentId", 36)) + } + if s.Status == nil { + invalidParams.Add(request.NewErrParamRequired("Status")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAssessmentId sets the AssessmentId field's value. +func (s *UpdateAssessmentStatusInput) SetAssessmentId(v string) *UpdateAssessmentStatusInput { + s.AssessmentId = &v + return s +} + +// SetStatus sets the Status field's value. +func (s *UpdateAssessmentStatusInput) SetStatus(v string) *UpdateAssessmentStatusInput { + s.Status = &v + return s +} + +type UpdateAssessmentStatusOutput struct { + _ struct{} `type:"structure"` + + // The name of the updated assessment returned by the UpdateAssessmentStatus + // API. + Assessment *Assessment `locationName:"assessment" type:"structure"` +} + +// String returns the string representation +func (s UpdateAssessmentStatusOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s UpdateAssessmentStatusOutput) GoString() string { + return s.String() +} + +// SetAssessment sets the Assessment field's value. +func (s *UpdateAssessmentStatusOutput) SetAssessment(v *Assessment) *UpdateAssessmentStatusOutput { + s.Assessment = v + return s +} + +type UpdateControlInput struct { + _ struct{} `type:"structure"` + + // The recommended actions to carry out if the control is not fulfilled. + ActionPlanInstructions *string `locationName:"actionPlanInstructions" type:"string"` + + // The title of the action plan for remediating the control. + ActionPlanTitle *string `locationName:"actionPlanTitle" type:"string"` + + // The identifier for the specified control. + // + // ControlId is a required field + ControlId *string `location:"uri" locationName:"controlId" min:"36" type:"string" required:"true"` + + // The data source that determines from where AWS Audit Manager collects evidence + // for the control. + // + // ControlMappingSources is a required field + ControlMappingSources []*ControlMappingSource `locationName:"controlMappingSources" min:"1" type:"list" required:"true"` + + // The optional description of the control. + Description *string `locationName:"description" type:"string"` + + // The name of the control to be updated. + // + // Name is a required field + Name *string `locationName:"name" min:"1" type:"string" required:"true"` + + // The steps that to follow to determine if the control has been satisfied. + TestingInformation *string `locationName:"testingInformation" type:"string"` +} + +// String returns the string representation +func (s UpdateControlInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s UpdateControlInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *UpdateControlInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "UpdateControlInput"} + if s.ControlId == nil { + invalidParams.Add(request.NewErrParamRequired("ControlId")) + } + if s.ControlId != nil && len(*s.ControlId) < 36 { + invalidParams.Add(request.NewErrParamMinLen("ControlId", 36)) + } + if s.ControlMappingSources == nil { + invalidParams.Add(request.NewErrParamRequired("ControlMappingSources")) + } + if s.ControlMappingSources != nil && len(s.ControlMappingSources) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ControlMappingSources", 1)) + } + if s.Name == nil { + invalidParams.Add(request.NewErrParamRequired("Name")) + } + if s.Name != nil && len(*s.Name) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Name", 1)) + } + if s.ControlMappingSources != nil { + for i, v := range s.ControlMappingSources { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "ControlMappingSources", i), err.(request.ErrInvalidParams)) + } + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetActionPlanInstructions sets the ActionPlanInstructions field's value. +func (s *UpdateControlInput) SetActionPlanInstructions(v string) *UpdateControlInput { + s.ActionPlanInstructions = &v + return s +} + +// SetActionPlanTitle sets the ActionPlanTitle field's value. +func (s *UpdateControlInput) SetActionPlanTitle(v string) *UpdateControlInput { + s.ActionPlanTitle = &v + return s +} + +// SetControlId sets the ControlId field's value. +func (s *UpdateControlInput) SetControlId(v string) *UpdateControlInput { + s.ControlId = &v + return s +} + +// SetControlMappingSources sets the ControlMappingSources field's value. +func (s *UpdateControlInput) SetControlMappingSources(v []*ControlMappingSource) *UpdateControlInput { + s.ControlMappingSources = v + return s +} + +// SetDescription sets the Description field's value. +func (s *UpdateControlInput) SetDescription(v string) *UpdateControlInput { + s.Description = &v + return s +} + +// SetName sets the Name field's value. +func (s *UpdateControlInput) SetName(v string) *UpdateControlInput { + s.Name = &v + return s +} + +// SetTestingInformation sets the TestingInformation field's value. +func (s *UpdateControlInput) SetTestingInformation(v string) *UpdateControlInput { + s.TestingInformation = &v + return s +} + +type UpdateControlOutput struct { + _ struct{} `type:"structure"` + + // The name of the updated control set returned by the UpdateControl API. + Control *Control `locationName:"control" type:"structure"` +} + +// String returns the string representation +func (s UpdateControlOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s UpdateControlOutput) GoString() string { + return s.String() +} + +// SetControl sets the Control field's value. +func (s *UpdateControlOutput) SetControl(v *Control) *UpdateControlOutput { + s.Control = v + return s +} + +type UpdateSettingsInput struct { + _ struct{} `type:"structure"` + + // The default storage destination for assessment reports. + DefaultAssessmentReportsDestination *AssessmentReportsDestination `locationName:"defaultAssessmentReportsDestination" type:"structure"` + + // A list of the default audit owners. + DefaultProcessOwners []*Role `locationName:"defaultProcessOwners" type:"list"` + + // The AWS KMS key details. + KmsKey *string `locationName:"kmsKey" min:"7" type:"string"` + + // The Amazon Simple Notification Service (Amazon SNS) topic to which AWS Audit + // Manager sends notifications. + SnsTopic *string `locationName:"snsTopic" min:"20" type:"string"` +} + +// String returns the string representation +func (s UpdateSettingsInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s UpdateSettingsInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *UpdateSettingsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "UpdateSettingsInput"} + if s.KmsKey != nil && len(*s.KmsKey) < 7 { + invalidParams.Add(request.NewErrParamMinLen("KmsKey", 7)) + } + if s.SnsTopic != nil && len(*s.SnsTopic) < 20 { + invalidParams.Add(request.NewErrParamMinLen("SnsTopic", 20)) + } + if s.DefaultAssessmentReportsDestination != nil { + if err := s.DefaultAssessmentReportsDestination.Validate(); err != nil { + invalidParams.AddNested("DefaultAssessmentReportsDestination", err.(request.ErrInvalidParams)) + } + } + if s.DefaultProcessOwners != nil { + for i, v := range s.DefaultProcessOwners { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "DefaultProcessOwners", i), err.(request.ErrInvalidParams)) + } + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDefaultAssessmentReportsDestination sets the DefaultAssessmentReportsDestination field's value. +func (s *UpdateSettingsInput) SetDefaultAssessmentReportsDestination(v *AssessmentReportsDestination) *UpdateSettingsInput { + s.DefaultAssessmentReportsDestination = v + return s +} + +// SetDefaultProcessOwners sets the DefaultProcessOwners field's value. +func (s *UpdateSettingsInput) SetDefaultProcessOwners(v []*Role) *UpdateSettingsInput { + s.DefaultProcessOwners = v + return s +} + +// SetKmsKey sets the KmsKey field's value. +func (s *UpdateSettingsInput) SetKmsKey(v string) *UpdateSettingsInput { + s.KmsKey = &v + return s +} + +// SetSnsTopic sets the SnsTopic field's value. +func (s *UpdateSettingsInput) SetSnsTopic(v string) *UpdateSettingsInput { + s.SnsTopic = &v + return s +} + +type UpdateSettingsOutput struct { + _ struct{} `type:"structure"` + + // The current list of settings. + Settings *Settings `locationName:"settings" type:"structure"` +} + +// String returns the string representation +func (s UpdateSettingsOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s UpdateSettingsOutput) GoString() string { + return s.String() +} + +// SetSettings sets the Settings field's value. +func (s *UpdateSettingsOutput) SetSettings(v *Settings) *UpdateSettingsOutput { + s.Settings = v + return s +} + +type ValidateAssessmentReportIntegrityInput struct { + _ struct{} `type:"structure"` + + // The relative path of the specified Amazon S3 bucket in which the assessment + // report is stored. + // + // S3RelativePath is a required field + S3RelativePath *string `locationName:"s3RelativePath" min:"1" type:"string" required:"true"` +} + +// String returns the string representation +func (s ValidateAssessmentReportIntegrityInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s ValidateAssessmentReportIntegrityInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ValidateAssessmentReportIntegrityInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ValidateAssessmentReportIntegrityInput"} + if s.S3RelativePath == nil { + invalidParams.Add(request.NewErrParamRequired("S3RelativePath")) + } + if s.S3RelativePath != nil && len(*s.S3RelativePath) < 1 { + invalidParams.Add(request.NewErrParamMinLen("S3RelativePath", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetS3RelativePath sets the S3RelativePath field's value. +func (s *ValidateAssessmentReportIntegrityInput) SetS3RelativePath(v string) *ValidateAssessmentReportIntegrityInput { + s.S3RelativePath = &v + return s +} + +type ValidateAssessmentReportIntegrityOutput struct { + _ struct{} `type:"structure"` + + // The signature algorithm used to code sign the assessment report file. + SignatureAlgorithm *string `locationName:"signatureAlgorithm" type:"string"` + + // The date and time signature that specifies when the assessment report was + // created. + SignatureDateTime *string `locationName:"signatureDateTime" type:"string"` + + // The unique identifier for the validation signature key. + SignatureKeyId *string `locationName:"signatureKeyId" type:"string"` + + // Specifies whether the signature key is valid. + SignatureValid *bool `locationName:"signatureValid" type:"boolean"` + + // Represents any errors that occurred when validating the assessment report. + ValidationErrors []*string `locationName:"validationErrors" type:"list"` +} + +// String returns the string representation +func (s ValidateAssessmentReportIntegrityOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s ValidateAssessmentReportIntegrityOutput) GoString() string { + return s.String() +} + +// SetSignatureAlgorithm sets the SignatureAlgorithm field's value. +func (s *ValidateAssessmentReportIntegrityOutput) SetSignatureAlgorithm(v string) *ValidateAssessmentReportIntegrityOutput { + s.SignatureAlgorithm = &v + return s +} + +// SetSignatureDateTime sets the SignatureDateTime field's value. +func (s *ValidateAssessmentReportIntegrityOutput) SetSignatureDateTime(v string) *ValidateAssessmentReportIntegrityOutput { + s.SignatureDateTime = &v + return s +} + +// SetSignatureKeyId sets the SignatureKeyId field's value. +func (s *ValidateAssessmentReportIntegrityOutput) SetSignatureKeyId(v string) *ValidateAssessmentReportIntegrityOutput { + s.SignatureKeyId = &v + return s +} + +// SetSignatureValid sets the SignatureValid field's value. +func (s *ValidateAssessmentReportIntegrityOutput) SetSignatureValid(v bool) *ValidateAssessmentReportIntegrityOutput { + s.SignatureValid = &v + return s +} + +// SetValidationErrors sets the ValidationErrors field's value. +func (s *ValidateAssessmentReportIntegrityOutput) SetValidationErrors(v []*string) *ValidateAssessmentReportIntegrityOutput { + s.ValidationErrors = v + return s +} + +// The request has invalid or missing parameters. +type ValidationException struct { + _ struct{} `type:"structure"` + RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` + + // The fields that caused the error, if applicable. + Fields []*ValidationExceptionField `locationName:"fields" type:"list"` + + Message_ *string `locationName:"message" type:"string"` + + // The reason the request failed validation. + Reason *string `locationName:"reason" type:"string" enum:"ValidationExceptionReason"` +} + +// String returns the string representation +func (s ValidationException) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s ValidationException) GoString() string { + return s.String() +} + +func newErrorValidationException(v protocol.ResponseMetadata) error { + return &ValidationException{ + RespMetadata: v, + } +} + +// Code returns the exception type name. +func (s *ValidationException) Code() string { + return "ValidationException" +} + +// Message returns the exception's message. +func (s *ValidationException) Message() string { + if s.Message_ != nil { + return *s.Message_ + } + return "" +} + +// OrigErr always returns nil, satisfies awserr.Error interface. +func (s *ValidationException) OrigErr() error { + return nil +} + +func (s *ValidationException) Error() string { + return fmt.Sprintf("%s: %s\n%s", s.Code(), s.Message(), s.String()) +} + +// Status code returns the HTTP status code for the request's response error. +func (s *ValidationException) StatusCode() int { + return s.RespMetadata.StatusCode +} + +// RequestID returns the service's response RequestID for request. +func (s *ValidationException) RequestID() string { + return s.RespMetadata.RequestID +} + +// Indicates that the request has invalid or missing parameters for the specified +// field. +type ValidationExceptionField struct { + _ struct{} `type:"structure"` + + // The body of the error message. + // + // Message is a required field + Message *string `locationName:"message" type:"string" required:"true"` + + // The name of the validation error. + // + // Name is a required field + Name *string `locationName:"name" type:"string" required:"true"` +} + +// String returns the string representation +func (s ValidationExceptionField) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s ValidationExceptionField) GoString() string { + return s.String() +} + +// SetMessage sets the Message field's value. +func (s *ValidationExceptionField) SetMessage(v string) *ValidationExceptionField { + s.Message = &v + return s +} + +// SetName sets the Name field's value. +func (s *ValidationExceptionField) SetName(v string) *ValidationExceptionField { + s.Name = &v + return s +} + +const ( + // AccountStatusActive is a AccountStatus enum value + AccountStatusActive = "ACTIVE" + + // AccountStatusInactive is a AccountStatus enum value + AccountStatusInactive = "INACTIVE" + + // AccountStatusPendingActivation is a AccountStatus enum value + AccountStatusPendingActivation = "PENDING_ACTIVATION" +) + +// AccountStatus_Values returns all elements of the AccountStatus enum +func AccountStatus_Values() []string { + return []string{ + AccountStatusActive, + AccountStatusInactive, + AccountStatusPendingActivation, + } +} + +const ( + // ActionEnumCreate is a ActionEnum enum value + ActionEnumCreate = "CREATE" + + // ActionEnumUpdateMetadata is a ActionEnum enum value + ActionEnumUpdateMetadata = "UPDATE_METADATA" + + // ActionEnumActive is a ActionEnum enum value + ActionEnumActive = "ACTIVE" + + // ActionEnumInactive is a ActionEnum enum value + ActionEnumInactive = "INACTIVE" + + // ActionEnumDelete is a ActionEnum enum value + ActionEnumDelete = "DELETE" + + // ActionEnumUnderReview is a ActionEnum enum value + ActionEnumUnderReview = "UNDER_REVIEW" + + // ActionEnumReviewed is a ActionEnum enum value + ActionEnumReviewed = "REVIEWED" + + // ActionEnumImportEvidence is a ActionEnum enum value + ActionEnumImportEvidence = "IMPORT_EVIDENCE" +) + +// ActionEnum_Values returns all elements of the ActionEnum enum +func ActionEnum_Values() []string { + return []string{ + ActionEnumCreate, + ActionEnumUpdateMetadata, + ActionEnumActive, + ActionEnumInactive, + ActionEnumDelete, + ActionEnumUnderReview, + ActionEnumReviewed, + ActionEnumImportEvidence, + } +} + +const ( + // AssessmentReportDestinationTypeS3 is a AssessmentReportDestinationType enum value + AssessmentReportDestinationTypeS3 = "S3" +) + +// AssessmentReportDestinationType_Values returns all elements of the AssessmentReportDestinationType enum +func AssessmentReportDestinationType_Values() []string { + return []string{ + AssessmentReportDestinationTypeS3, + } +} + +const ( + // AssessmentReportStatusComplete is a AssessmentReportStatus enum value + AssessmentReportStatusComplete = "COMPLETE" + + // AssessmentReportStatusInProgress is a AssessmentReportStatus enum value + AssessmentReportStatusInProgress = "IN_PROGRESS" + + // AssessmentReportStatusFailed is a AssessmentReportStatus enum value + AssessmentReportStatusFailed = "FAILED" +) + +// AssessmentReportStatus_Values returns all elements of the AssessmentReportStatus enum +func AssessmentReportStatus_Values() []string { + return []string{ + AssessmentReportStatusComplete, + AssessmentReportStatusInProgress, + AssessmentReportStatusFailed, + } +} + +const ( + // AssessmentStatusActive is a AssessmentStatus enum value + AssessmentStatusActive = "ACTIVE" + + // AssessmentStatusInactive is a AssessmentStatus enum value + AssessmentStatusInactive = "INACTIVE" +) + +// AssessmentStatus_Values returns all elements of the AssessmentStatus enum +func AssessmentStatus_Values() []string { + return []string{ + AssessmentStatusActive, + AssessmentStatusInactive, + } +} + +const ( + // ControlResponseManual is a ControlResponse enum value + ControlResponseManual = "MANUAL" + + // ControlResponseAutomate is a ControlResponse enum value + ControlResponseAutomate = "AUTOMATE" + + // ControlResponseDefer is a ControlResponse enum value + ControlResponseDefer = "DEFER" + + // ControlResponseIgnore is a ControlResponse enum value + ControlResponseIgnore = "IGNORE" +) + +// ControlResponse_Values returns all elements of the ControlResponse enum +func ControlResponse_Values() []string { + return []string{ + ControlResponseManual, + ControlResponseAutomate, + ControlResponseDefer, + ControlResponseIgnore, + } +} + +const ( + // ControlSetStatusActive is a ControlSetStatus enum value + ControlSetStatusActive = "ACTIVE" + + // ControlSetStatusUnderReview is a ControlSetStatus enum value + ControlSetStatusUnderReview = "UNDER_REVIEW" + + // ControlSetStatusReviewed is a ControlSetStatus enum value + ControlSetStatusReviewed = "REVIEWED" +) + +// ControlSetStatus_Values returns all elements of the ControlSetStatus enum +func ControlSetStatus_Values() []string { + return []string{ + ControlSetStatusActive, + ControlSetStatusUnderReview, + ControlSetStatusReviewed, + } +} + +const ( + // ControlStatusUnderReview is a ControlStatus enum value + ControlStatusUnderReview = "UNDER_REVIEW" + + // ControlStatusReviewed is a ControlStatus enum value + ControlStatusReviewed = "REVIEWED" + + // ControlStatusInactive is a ControlStatus enum value + ControlStatusInactive = "INACTIVE" +) + +// ControlStatus_Values returns all elements of the ControlStatus enum +func ControlStatus_Values() []string { + return []string{ + ControlStatusUnderReview, + ControlStatusReviewed, + ControlStatusInactive, + } +} + +const ( + // ControlTypeStandard is a ControlType enum value + ControlTypeStandard = "Standard" + + // ControlTypeCustom is a ControlType enum value + ControlTypeCustom = "Custom" +) + +// ControlType_Values returns all elements of the ControlType enum +func ControlType_Values() []string { + return []string{ + ControlTypeStandard, + ControlTypeCustom, + } +} + +const ( + // DelegationStatusInProgress is a DelegationStatus enum value + DelegationStatusInProgress = "IN_PROGRESS" + + // DelegationStatusUnderReview is a DelegationStatus enum value + DelegationStatusUnderReview = "UNDER_REVIEW" + + // DelegationStatusComplete is a DelegationStatus enum value + DelegationStatusComplete = "COMPLETE" +) + +// DelegationStatus_Values returns all elements of the DelegationStatus enum +func DelegationStatus_Values() []string { + return []string{ + DelegationStatusInProgress, + DelegationStatusUnderReview, + DelegationStatusComplete, + } +} + +const ( + // FrameworkTypeStandard is a FrameworkType enum value + FrameworkTypeStandard = "Standard" + + // FrameworkTypeCustom is a FrameworkType enum value + FrameworkTypeCustom = "Custom" +) + +// FrameworkType_Values returns all elements of the FrameworkType enum +func FrameworkType_Values() []string { + return []string{ + FrameworkTypeStandard, + FrameworkTypeCustom, + } +} + +const ( + // KeywordInputTypeSelectFromList is a KeywordInputType enum value + KeywordInputTypeSelectFromList = "SELECT_FROM_LIST" +) + +// KeywordInputType_Values returns all elements of the KeywordInputType enum +func KeywordInputType_Values() []string { + return []string{ + KeywordInputTypeSelectFromList, + } +} + +const ( + // ObjectTypeEnumAssessment is a ObjectTypeEnum enum value + ObjectTypeEnumAssessment = "ASSESSMENT" + + // ObjectTypeEnumControlSet is a ObjectTypeEnum enum value + ObjectTypeEnumControlSet = "CONTROL_SET" + + // ObjectTypeEnumControl is a ObjectTypeEnum enum value + ObjectTypeEnumControl = "CONTROL" + + // ObjectTypeEnumDelegation is a ObjectTypeEnum enum value + ObjectTypeEnumDelegation = "DELEGATION" + + // ObjectTypeEnumAssessmentReport is a ObjectTypeEnum enum value + ObjectTypeEnumAssessmentReport = "ASSESSMENT_REPORT" +) + +// ObjectTypeEnum_Values returns all elements of the ObjectTypeEnum enum +func ObjectTypeEnum_Values() []string { + return []string{ + ObjectTypeEnumAssessment, + ObjectTypeEnumControlSet, + ObjectTypeEnumControl, + ObjectTypeEnumDelegation, + ObjectTypeEnumAssessmentReport, + } +} + +const ( + // RoleTypeProcessOwner is a RoleType enum value + RoleTypeProcessOwner = "PROCESS_OWNER" + + // RoleTypeResourceOwner is a RoleType enum value + RoleTypeResourceOwner = "RESOURCE_OWNER" +) + +// RoleType_Values returns all elements of the RoleType enum +func RoleType_Values() []string { + return []string{ + RoleTypeProcessOwner, + RoleTypeResourceOwner, + } +} + +const ( + // SettingAttributeAll is a SettingAttribute enum value + SettingAttributeAll = "ALL" + + // SettingAttributeIsAwsOrgEnabled is a SettingAttribute enum value + SettingAttributeIsAwsOrgEnabled = "IS_AWS_ORG_ENABLED" + + // SettingAttributeSnsTopic is a SettingAttribute enum value + SettingAttributeSnsTopic = "SNS_TOPIC" + + // SettingAttributeDefaultAssessmentReportsDestination is a SettingAttribute enum value + SettingAttributeDefaultAssessmentReportsDestination = "DEFAULT_ASSESSMENT_REPORTS_DESTINATION" + + // SettingAttributeDefaultProcessOwners is a SettingAttribute enum value + SettingAttributeDefaultProcessOwners = "DEFAULT_PROCESS_OWNERS" +) + +// SettingAttribute_Values returns all elements of the SettingAttribute enum +func SettingAttribute_Values() []string { + return []string{ + SettingAttributeAll, + SettingAttributeIsAwsOrgEnabled, + SettingAttributeSnsTopic, + SettingAttributeDefaultAssessmentReportsDestination, + SettingAttributeDefaultProcessOwners, + } +} + +const ( + // SourceFrequencyDaily is a SourceFrequency enum value + SourceFrequencyDaily = "DAILY" + + // SourceFrequencyWeekly is a SourceFrequency enum value + SourceFrequencyWeekly = "WEEKLY" + + // SourceFrequencyMonthly is a SourceFrequency enum value + SourceFrequencyMonthly = "MONTHLY" +) + +// SourceFrequency_Values returns all elements of the SourceFrequency enum +func SourceFrequency_Values() []string { + return []string{ + SourceFrequencyDaily, + SourceFrequencyWeekly, + SourceFrequencyMonthly, + } +} + +const ( + // SourceSetUpOptionSystemControlsMapping is a SourceSetUpOption enum value + SourceSetUpOptionSystemControlsMapping = "System_Controls_Mapping" + + // SourceSetUpOptionProceduralControlsMapping is a SourceSetUpOption enum value + SourceSetUpOptionProceduralControlsMapping = "Procedural_Controls_Mapping" +) + +// SourceSetUpOption_Values returns all elements of the SourceSetUpOption enum +func SourceSetUpOption_Values() []string { + return []string{ + SourceSetUpOptionSystemControlsMapping, + SourceSetUpOptionProceduralControlsMapping, + } +} + +const ( + // SourceTypeAwsCloudtrail is a SourceType enum value + SourceTypeAwsCloudtrail = "AWS_Cloudtrail" + + // SourceTypeAwsConfig is a SourceType enum value + SourceTypeAwsConfig = "AWS_Config" + + // SourceTypeAwsSecurityHub is a SourceType enum value + SourceTypeAwsSecurityHub = "AWS_Security_Hub" + + // SourceTypeAwsApiCall is a SourceType enum value + SourceTypeAwsApiCall = "AWS_API_Call" + + // SourceTypeManual is a SourceType enum value + SourceTypeManual = "MANUAL" +) + +// SourceType_Values returns all elements of the SourceType enum +func SourceType_Values() []string { + return []string{ + SourceTypeAwsCloudtrail, + SourceTypeAwsConfig, + SourceTypeAwsSecurityHub, + SourceTypeAwsApiCall, + SourceTypeManual, + } +} + +const ( + // ValidationExceptionReasonUnknownOperation is a ValidationExceptionReason enum value + ValidationExceptionReasonUnknownOperation = "unknownOperation" + + // ValidationExceptionReasonCannotParse is a ValidationExceptionReason enum value + ValidationExceptionReasonCannotParse = "cannotParse" + + // ValidationExceptionReasonFieldValidationFailed is a ValidationExceptionReason enum value + ValidationExceptionReasonFieldValidationFailed = "fieldValidationFailed" + + // ValidationExceptionReasonOther is a ValidationExceptionReason enum value + ValidationExceptionReasonOther = "other" +) + +// ValidationExceptionReason_Values returns all elements of the ValidationExceptionReason enum +func ValidationExceptionReason_Values() []string { + return []string{ + ValidationExceptionReasonUnknownOperation, + ValidationExceptionReasonCannotParse, + ValidationExceptionReasonFieldValidationFailed, + ValidationExceptionReasonOther, + } +} diff --git a/service/auditmanager/auditmanageriface/interface.go b/service/auditmanager/auditmanageriface/interface.go new file mode 100644 index 00000000000..5d9d8fd726f --- /dev/null +++ b/service/auditmanager/auditmanageriface/interface.go @@ -0,0 +1,301 @@ +// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT. + +// Package auditmanageriface provides an interface to enable mocking the AWS Audit Manager service client +// for testing your code. +// +// It is important to note that this interface will have breaking changes +// when the service model is updated and adds new API operations, paginators, +// and waiters. +package auditmanageriface + +import ( + "github.com/aws/aws-sdk-go/aws" + "github.com/aws/aws-sdk-go/aws/request" + "github.com/aws/aws-sdk-go/service/auditmanager" +) + +// AuditManagerAPI provides an interface to enable mocking the +// auditmanager.AuditManager service client's API operation, +// paginators, and waiters. This make unit testing your code that calls out +// to the SDK's service client's calls easier. +// +// The best way to use this interface is so the SDK's service client's calls +// can be stubbed out for unit testing your code with the SDK without needing +// to inject custom request handlers into the SDK's request pipeline. +// +// // myFunc uses an SDK service client to make a request to +// // AWS Audit Manager. +// func myFunc(svc auditmanageriface.AuditManagerAPI) bool { +// // Make svc.AssociateAssessmentReportEvidenceFolder request +// } +// +// func main() { +// sess := session.New() +// svc := auditmanager.New(sess) +// +// myFunc(svc) +// } +// +// In your _test.go file: +// +// // Define a mock struct to be used in your unit tests of myFunc. +// type mockAuditManagerClient struct { +// auditmanageriface.AuditManagerAPI +// } +// func (m *mockAuditManagerClient) AssociateAssessmentReportEvidenceFolder(input *auditmanager.AssociateAssessmentReportEvidenceFolderInput) (*auditmanager.AssociateAssessmentReportEvidenceFolderOutput, error) { +// // mock response/functionality +// } +// +// func TestMyFunc(t *testing.T) { +// // Setup Test +// mockSvc := &mockAuditManagerClient{} +// +// myfunc(mockSvc) +// +// // Verify myFunc's functionality +// } +// +// It is important to note that this interface will have breaking changes +// when the service model is updated and adds new API operations, paginators, +// and waiters. Its suggested to use the pattern above for testing, or using +// tooling to generate mocks to satisfy the interfaces. +type AuditManagerAPI interface { + AssociateAssessmentReportEvidenceFolder(*auditmanager.AssociateAssessmentReportEvidenceFolderInput) (*auditmanager.AssociateAssessmentReportEvidenceFolderOutput, error) + AssociateAssessmentReportEvidenceFolderWithContext(aws.Context, *auditmanager.AssociateAssessmentReportEvidenceFolderInput, ...request.Option) (*auditmanager.AssociateAssessmentReportEvidenceFolderOutput, error) + AssociateAssessmentReportEvidenceFolderRequest(*auditmanager.AssociateAssessmentReportEvidenceFolderInput) (*request.Request, *auditmanager.AssociateAssessmentReportEvidenceFolderOutput) + + BatchAssociateAssessmentReportEvidence(*auditmanager.BatchAssociateAssessmentReportEvidenceInput) (*auditmanager.BatchAssociateAssessmentReportEvidenceOutput, error) + BatchAssociateAssessmentReportEvidenceWithContext(aws.Context, *auditmanager.BatchAssociateAssessmentReportEvidenceInput, ...request.Option) (*auditmanager.BatchAssociateAssessmentReportEvidenceOutput, error) + BatchAssociateAssessmentReportEvidenceRequest(*auditmanager.BatchAssociateAssessmentReportEvidenceInput) (*request.Request, *auditmanager.BatchAssociateAssessmentReportEvidenceOutput) + + BatchCreateDelegationByAssessment(*auditmanager.BatchCreateDelegationByAssessmentInput) (*auditmanager.BatchCreateDelegationByAssessmentOutput, error) + BatchCreateDelegationByAssessmentWithContext(aws.Context, *auditmanager.BatchCreateDelegationByAssessmentInput, ...request.Option) (*auditmanager.BatchCreateDelegationByAssessmentOutput, error) + BatchCreateDelegationByAssessmentRequest(*auditmanager.BatchCreateDelegationByAssessmentInput) (*request.Request, *auditmanager.BatchCreateDelegationByAssessmentOutput) + + BatchDeleteDelegationByAssessment(*auditmanager.BatchDeleteDelegationByAssessmentInput) (*auditmanager.BatchDeleteDelegationByAssessmentOutput, error) + BatchDeleteDelegationByAssessmentWithContext(aws.Context, *auditmanager.BatchDeleteDelegationByAssessmentInput, ...request.Option) (*auditmanager.BatchDeleteDelegationByAssessmentOutput, error) + BatchDeleteDelegationByAssessmentRequest(*auditmanager.BatchDeleteDelegationByAssessmentInput) (*request.Request, *auditmanager.BatchDeleteDelegationByAssessmentOutput) + + BatchDisassociateAssessmentReportEvidence(*auditmanager.BatchDisassociateAssessmentReportEvidenceInput) (*auditmanager.BatchDisassociateAssessmentReportEvidenceOutput, error) + BatchDisassociateAssessmentReportEvidenceWithContext(aws.Context, *auditmanager.BatchDisassociateAssessmentReportEvidenceInput, ...request.Option) (*auditmanager.BatchDisassociateAssessmentReportEvidenceOutput, error) + BatchDisassociateAssessmentReportEvidenceRequest(*auditmanager.BatchDisassociateAssessmentReportEvidenceInput) (*request.Request, *auditmanager.BatchDisassociateAssessmentReportEvidenceOutput) + + BatchImportEvidenceToAssessmentControl(*auditmanager.BatchImportEvidenceToAssessmentControlInput) (*auditmanager.BatchImportEvidenceToAssessmentControlOutput, error) + BatchImportEvidenceToAssessmentControlWithContext(aws.Context, *auditmanager.BatchImportEvidenceToAssessmentControlInput, ...request.Option) (*auditmanager.BatchImportEvidenceToAssessmentControlOutput, error) + BatchImportEvidenceToAssessmentControlRequest(*auditmanager.BatchImportEvidenceToAssessmentControlInput) (*request.Request, *auditmanager.BatchImportEvidenceToAssessmentControlOutput) + + CreateAssessment(*auditmanager.CreateAssessmentInput) (*auditmanager.CreateAssessmentOutput, error) + CreateAssessmentWithContext(aws.Context, *auditmanager.CreateAssessmentInput, ...request.Option) (*auditmanager.CreateAssessmentOutput, error) + CreateAssessmentRequest(*auditmanager.CreateAssessmentInput) (*request.Request, *auditmanager.CreateAssessmentOutput) + + CreateAssessmentFramework(*auditmanager.CreateAssessmentFrameworkInput) (*auditmanager.CreateAssessmentFrameworkOutput, error) + CreateAssessmentFrameworkWithContext(aws.Context, *auditmanager.CreateAssessmentFrameworkInput, ...request.Option) (*auditmanager.CreateAssessmentFrameworkOutput, error) + CreateAssessmentFrameworkRequest(*auditmanager.CreateAssessmentFrameworkInput) (*request.Request, *auditmanager.CreateAssessmentFrameworkOutput) + + CreateAssessmentReport(*auditmanager.CreateAssessmentReportInput) (*auditmanager.CreateAssessmentReportOutput, error) + CreateAssessmentReportWithContext(aws.Context, *auditmanager.CreateAssessmentReportInput, ...request.Option) (*auditmanager.CreateAssessmentReportOutput, error) + CreateAssessmentReportRequest(*auditmanager.CreateAssessmentReportInput) (*request.Request, *auditmanager.CreateAssessmentReportOutput) + + CreateControl(*auditmanager.CreateControlInput) (*auditmanager.CreateControlOutput, error) + CreateControlWithContext(aws.Context, *auditmanager.CreateControlInput, ...request.Option) (*auditmanager.CreateControlOutput, error) + CreateControlRequest(*auditmanager.CreateControlInput) (*request.Request, *auditmanager.CreateControlOutput) + + DeleteAssessment(*auditmanager.DeleteAssessmentInput) (*auditmanager.DeleteAssessmentOutput, error) + DeleteAssessmentWithContext(aws.Context, *auditmanager.DeleteAssessmentInput, ...request.Option) (*auditmanager.DeleteAssessmentOutput, error) + DeleteAssessmentRequest(*auditmanager.DeleteAssessmentInput) (*request.Request, *auditmanager.DeleteAssessmentOutput) + + DeleteAssessmentFramework(*auditmanager.DeleteAssessmentFrameworkInput) (*auditmanager.DeleteAssessmentFrameworkOutput, error) + DeleteAssessmentFrameworkWithContext(aws.Context, *auditmanager.DeleteAssessmentFrameworkInput, ...request.Option) (*auditmanager.DeleteAssessmentFrameworkOutput, error) + DeleteAssessmentFrameworkRequest(*auditmanager.DeleteAssessmentFrameworkInput) (*request.Request, *auditmanager.DeleteAssessmentFrameworkOutput) + + DeleteAssessmentReport(*auditmanager.DeleteAssessmentReportInput) (*auditmanager.DeleteAssessmentReportOutput, error) + DeleteAssessmentReportWithContext(aws.Context, *auditmanager.DeleteAssessmentReportInput, ...request.Option) (*auditmanager.DeleteAssessmentReportOutput, error) + DeleteAssessmentReportRequest(*auditmanager.DeleteAssessmentReportInput) (*request.Request, *auditmanager.DeleteAssessmentReportOutput) + + DeleteControl(*auditmanager.DeleteControlInput) (*auditmanager.DeleteControlOutput, error) + DeleteControlWithContext(aws.Context, *auditmanager.DeleteControlInput, ...request.Option) (*auditmanager.DeleteControlOutput, error) + DeleteControlRequest(*auditmanager.DeleteControlInput) (*request.Request, *auditmanager.DeleteControlOutput) + + DeregisterAccount(*auditmanager.DeregisterAccountInput) (*auditmanager.DeregisterAccountOutput, error) + DeregisterAccountWithContext(aws.Context, *auditmanager.DeregisterAccountInput, ...request.Option) (*auditmanager.DeregisterAccountOutput, error) + DeregisterAccountRequest(*auditmanager.DeregisterAccountInput) (*request.Request, *auditmanager.DeregisterAccountOutput) + + DeregisterOrganizationAdminAccount(*auditmanager.DeregisterOrganizationAdminAccountInput) (*auditmanager.DeregisterOrganizationAdminAccountOutput, error) + DeregisterOrganizationAdminAccountWithContext(aws.Context, *auditmanager.DeregisterOrganizationAdminAccountInput, ...request.Option) (*auditmanager.DeregisterOrganizationAdminAccountOutput, error) + DeregisterOrganizationAdminAccountRequest(*auditmanager.DeregisterOrganizationAdminAccountInput) (*request.Request, *auditmanager.DeregisterOrganizationAdminAccountOutput) + + DisassociateAssessmentReportEvidenceFolder(*auditmanager.DisassociateAssessmentReportEvidenceFolderInput) (*auditmanager.DisassociateAssessmentReportEvidenceFolderOutput, error) + DisassociateAssessmentReportEvidenceFolderWithContext(aws.Context, *auditmanager.DisassociateAssessmentReportEvidenceFolderInput, ...request.Option) (*auditmanager.DisassociateAssessmentReportEvidenceFolderOutput, error) + DisassociateAssessmentReportEvidenceFolderRequest(*auditmanager.DisassociateAssessmentReportEvidenceFolderInput) (*request.Request, *auditmanager.DisassociateAssessmentReportEvidenceFolderOutput) + + GetAccountStatus(*auditmanager.GetAccountStatusInput) (*auditmanager.GetAccountStatusOutput, error) + GetAccountStatusWithContext(aws.Context, *auditmanager.GetAccountStatusInput, ...request.Option) (*auditmanager.GetAccountStatusOutput, error) + GetAccountStatusRequest(*auditmanager.GetAccountStatusInput) (*request.Request, *auditmanager.GetAccountStatusOutput) + + GetAssessment(*auditmanager.GetAssessmentInput) (*auditmanager.GetAssessmentOutput, error) + GetAssessmentWithContext(aws.Context, *auditmanager.GetAssessmentInput, ...request.Option) (*auditmanager.GetAssessmentOutput, error) + GetAssessmentRequest(*auditmanager.GetAssessmentInput) (*request.Request, *auditmanager.GetAssessmentOutput) + + GetAssessmentFramework(*auditmanager.GetAssessmentFrameworkInput) (*auditmanager.GetAssessmentFrameworkOutput, error) + GetAssessmentFrameworkWithContext(aws.Context, *auditmanager.GetAssessmentFrameworkInput, ...request.Option) (*auditmanager.GetAssessmentFrameworkOutput, error) + GetAssessmentFrameworkRequest(*auditmanager.GetAssessmentFrameworkInput) (*request.Request, *auditmanager.GetAssessmentFrameworkOutput) + + GetAssessmentReportUrl(*auditmanager.GetAssessmentReportUrlInput) (*auditmanager.GetAssessmentReportUrlOutput, error) + GetAssessmentReportUrlWithContext(aws.Context, *auditmanager.GetAssessmentReportUrlInput, ...request.Option) (*auditmanager.GetAssessmentReportUrlOutput, error) + GetAssessmentReportUrlRequest(*auditmanager.GetAssessmentReportUrlInput) (*request.Request, *auditmanager.GetAssessmentReportUrlOutput) + + GetChangeLogs(*auditmanager.GetChangeLogsInput) (*auditmanager.GetChangeLogsOutput, error) + GetChangeLogsWithContext(aws.Context, *auditmanager.GetChangeLogsInput, ...request.Option) (*auditmanager.GetChangeLogsOutput, error) + GetChangeLogsRequest(*auditmanager.GetChangeLogsInput) (*request.Request, *auditmanager.GetChangeLogsOutput) + + GetChangeLogsPages(*auditmanager.GetChangeLogsInput, func(*auditmanager.GetChangeLogsOutput, bool) bool) error + GetChangeLogsPagesWithContext(aws.Context, *auditmanager.GetChangeLogsInput, func(*auditmanager.GetChangeLogsOutput, bool) bool, ...request.Option) error + + GetControl(*auditmanager.GetControlInput) (*auditmanager.GetControlOutput, error) + GetControlWithContext(aws.Context, *auditmanager.GetControlInput, ...request.Option) (*auditmanager.GetControlOutput, error) + GetControlRequest(*auditmanager.GetControlInput) (*request.Request, *auditmanager.GetControlOutput) + + GetDelegations(*auditmanager.GetDelegationsInput) (*auditmanager.GetDelegationsOutput, error) + GetDelegationsWithContext(aws.Context, *auditmanager.GetDelegationsInput, ...request.Option) (*auditmanager.GetDelegationsOutput, error) + GetDelegationsRequest(*auditmanager.GetDelegationsInput) (*request.Request, *auditmanager.GetDelegationsOutput) + + GetDelegationsPages(*auditmanager.GetDelegationsInput, func(*auditmanager.GetDelegationsOutput, bool) bool) error + GetDelegationsPagesWithContext(aws.Context, *auditmanager.GetDelegationsInput, func(*auditmanager.GetDelegationsOutput, bool) bool, ...request.Option) error + + GetEvidence(*auditmanager.GetEvidenceInput) (*auditmanager.GetEvidenceOutput, error) + GetEvidenceWithContext(aws.Context, *auditmanager.GetEvidenceInput, ...request.Option) (*auditmanager.GetEvidenceOutput, error) + GetEvidenceRequest(*auditmanager.GetEvidenceInput) (*request.Request, *auditmanager.GetEvidenceOutput) + + GetEvidenceByEvidenceFolder(*auditmanager.GetEvidenceByEvidenceFolderInput) (*auditmanager.GetEvidenceByEvidenceFolderOutput, error) + GetEvidenceByEvidenceFolderWithContext(aws.Context, *auditmanager.GetEvidenceByEvidenceFolderInput, ...request.Option) (*auditmanager.GetEvidenceByEvidenceFolderOutput, error) + GetEvidenceByEvidenceFolderRequest(*auditmanager.GetEvidenceByEvidenceFolderInput) (*request.Request, *auditmanager.GetEvidenceByEvidenceFolderOutput) + + GetEvidenceByEvidenceFolderPages(*auditmanager.GetEvidenceByEvidenceFolderInput, func(*auditmanager.GetEvidenceByEvidenceFolderOutput, bool) bool) error + GetEvidenceByEvidenceFolderPagesWithContext(aws.Context, *auditmanager.GetEvidenceByEvidenceFolderInput, func(*auditmanager.GetEvidenceByEvidenceFolderOutput, bool) bool, ...request.Option) error + + GetEvidenceFolder(*auditmanager.GetEvidenceFolderInput) (*auditmanager.GetEvidenceFolderOutput, error) + GetEvidenceFolderWithContext(aws.Context, *auditmanager.GetEvidenceFolderInput, ...request.Option) (*auditmanager.GetEvidenceFolderOutput, error) + GetEvidenceFolderRequest(*auditmanager.GetEvidenceFolderInput) (*request.Request, *auditmanager.GetEvidenceFolderOutput) + + GetEvidenceFoldersByAssessment(*auditmanager.GetEvidenceFoldersByAssessmentInput) (*auditmanager.GetEvidenceFoldersByAssessmentOutput, error) + GetEvidenceFoldersByAssessmentWithContext(aws.Context, *auditmanager.GetEvidenceFoldersByAssessmentInput, ...request.Option) (*auditmanager.GetEvidenceFoldersByAssessmentOutput, error) + GetEvidenceFoldersByAssessmentRequest(*auditmanager.GetEvidenceFoldersByAssessmentInput) (*request.Request, *auditmanager.GetEvidenceFoldersByAssessmentOutput) + + GetEvidenceFoldersByAssessmentPages(*auditmanager.GetEvidenceFoldersByAssessmentInput, func(*auditmanager.GetEvidenceFoldersByAssessmentOutput, bool) bool) error + GetEvidenceFoldersByAssessmentPagesWithContext(aws.Context, *auditmanager.GetEvidenceFoldersByAssessmentInput, func(*auditmanager.GetEvidenceFoldersByAssessmentOutput, bool) bool, ...request.Option) error + + GetEvidenceFoldersByAssessmentControl(*auditmanager.GetEvidenceFoldersByAssessmentControlInput) (*auditmanager.GetEvidenceFoldersByAssessmentControlOutput, error) + GetEvidenceFoldersByAssessmentControlWithContext(aws.Context, *auditmanager.GetEvidenceFoldersByAssessmentControlInput, ...request.Option) (*auditmanager.GetEvidenceFoldersByAssessmentControlOutput, error) + GetEvidenceFoldersByAssessmentControlRequest(*auditmanager.GetEvidenceFoldersByAssessmentControlInput) (*request.Request, *auditmanager.GetEvidenceFoldersByAssessmentControlOutput) + + GetEvidenceFoldersByAssessmentControlPages(*auditmanager.GetEvidenceFoldersByAssessmentControlInput, func(*auditmanager.GetEvidenceFoldersByAssessmentControlOutput, bool) bool) error + GetEvidenceFoldersByAssessmentControlPagesWithContext(aws.Context, *auditmanager.GetEvidenceFoldersByAssessmentControlInput, func(*auditmanager.GetEvidenceFoldersByAssessmentControlOutput, bool) bool, ...request.Option) error + + GetOrganizationAdminAccount(*auditmanager.GetOrganizationAdminAccountInput) (*auditmanager.GetOrganizationAdminAccountOutput, error) + GetOrganizationAdminAccountWithContext(aws.Context, *auditmanager.GetOrganizationAdminAccountInput, ...request.Option) (*auditmanager.GetOrganizationAdminAccountOutput, error) + GetOrganizationAdminAccountRequest(*auditmanager.GetOrganizationAdminAccountInput) (*request.Request, *auditmanager.GetOrganizationAdminAccountOutput) + + GetServicesInScope(*auditmanager.GetServicesInScopeInput) (*auditmanager.GetServicesInScopeOutput, error) + GetServicesInScopeWithContext(aws.Context, *auditmanager.GetServicesInScopeInput, ...request.Option) (*auditmanager.GetServicesInScopeOutput, error) + GetServicesInScopeRequest(*auditmanager.GetServicesInScopeInput) (*request.Request, *auditmanager.GetServicesInScopeOutput) + + GetSettings(*auditmanager.GetSettingsInput) (*auditmanager.GetSettingsOutput, error) + GetSettingsWithContext(aws.Context, *auditmanager.GetSettingsInput, ...request.Option) (*auditmanager.GetSettingsOutput, error) + GetSettingsRequest(*auditmanager.GetSettingsInput) (*request.Request, *auditmanager.GetSettingsOutput) + + ListAssessmentFrameworks(*auditmanager.ListAssessmentFrameworksInput) (*auditmanager.ListAssessmentFrameworksOutput, error) + ListAssessmentFrameworksWithContext(aws.Context, *auditmanager.ListAssessmentFrameworksInput, ...request.Option) (*auditmanager.ListAssessmentFrameworksOutput, error) + ListAssessmentFrameworksRequest(*auditmanager.ListAssessmentFrameworksInput) (*request.Request, *auditmanager.ListAssessmentFrameworksOutput) + + ListAssessmentFrameworksPages(*auditmanager.ListAssessmentFrameworksInput, func(*auditmanager.ListAssessmentFrameworksOutput, bool) bool) error + ListAssessmentFrameworksPagesWithContext(aws.Context, *auditmanager.ListAssessmentFrameworksInput, func(*auditmanager.ListAssessmentFrameworksOutput, bool) bool, ...request.Option) error + + ListAssessmentReports(*auditmanager.ListAssessmentReportsInput) (*auditmanager.ListAssessmentReportsOutput, error) + ListAssessmentReportsWithContext(aws.Context, *auditmanager.ListAssessmentReportsInput, ...request.Option) (*auditmanager.ListAssessmentReportsOutput, error) + ListAssessmentReportsRequest(*auditmanager.ListAssessmentReportsInput) (*request.Request, *auditmanager.ListAssessmentReportsOutput) + + ListAssessmentReportsPages(*auditmanager.ListAssessmentReportsInput, func(*auditmanager.ListAssessmentReportsOutput, bool) bool) error + ListAssessmentReportsPagesWithContext(aws.Context, *auditmanager.ListAssessmentReportsInput, func(*auditmanager.ListAssessmentReportsOutput, bool) bool, ...request.Option) error + + ListAssessments(*auditmanager.ListAssessmentsInput) (*auditmanager.ListAssessmentsOutput, error) + ListAssessmentsWithContext(aws.Context, *auditmanager.ListAssessmentsInput, ...request.Option) (*auditmanager.ListAssessmentsOutput, error) + ListAssessmentsRequest(*auditmanager.ListAssessmentsInput) (*request.Request, *auditmanager.ListAssessmentsOutput) + + ListAssessmentsPages(*auditmanager.ListAssessmentsInput, func(*auditmanager.ListAssessmentsOutput, bool) bool) error + ListAssessmentsPagesWithContext(aws.Context, *auditmanager.ListAssessmentsInput, func(*auditmanager.ListAssessmentsOutput, bool) bool, ...request.Option) error + + ListControls(*auditmanager.ListControlsInput) (*auditmanager.ListControlsOutput, error) + ListControlsWithContext(aws.Context, *auditmanager.ListControlsInput, ...request.Option) (*auditmanager.ListControlsOutput, error) + ListControlsRequest(*auditmanager.ListControlsInput) (*request.Request, *auditmanager.ListControlsOutput) + + ListControlsPages(*auditmanager.ListControlsInput, func(*auditmanager.ListControlsOutput, bool) bool) error + ListControlsPagesWithContext(aws.Context, *auditmanager.ListControlsInput, func(*auditmanager.ListControlsOutput, bool) bool, ...request.Option) error + + ListKeywordsForDataSource(*auditmanager.ListKeywordsForDataSourceInput) (*auditmanager.ListKeywordsForDataSourceOutput, error) + ListKeywordsForDataSourceWithContext(aws.Context, *auditmanager.ListKeywordsForDataSourceInput, ...request.Option) (*auditmanager.ListKeywordsForDataSourceOutput, error) + ListKeywordsForDataSourceRequest(*auditmanager.ListKeywordsForDataSourceInput) (*request.Request, *auditmanager.ListKeywordsForDataSourceOutput) + + ListKeywordsForDataSourcePages(*auditmanager.ListKeywordsForDataSourceInput, func(*auditmanager.ListKeywordsForDataSourceOutput, bool) bool) error + ListKeywordsForDataSourcePagesWithContext(aws.Context, *auditmanager.ListKeywordsForDataSourceInput, func(*auditmanager.ListKeywordsForDataSourceOutput, bool) bool, ...request.Option) error + + ListNotifications(*auditmanager.ListNotificationsInput) (*auditmanager.ListNotificationsOutput, error) + ListNotificationsWithContext(aws.Context, *auditmanager.ListNotificationsInput, ...request.Option) (*auditmanager.ListNotificationsOutput, error) + ListNotificationsRequest(*auditmanager.ListNotificationsInput) (*request.Request, *auditmanager.ListNotificationsOutput) + + ListNotificationsPages(*auditmanager.ListNotificationsInput, func(*auditmanager.ListNotificationsOutput, bool) bool) error + ListNotificationsPagesWithContext(aws.Context, *auditmanager.ListNotificationsInput, func(*auditmanager.ListNotificationsOutput, bool) bool, ...request.Option) error + + ListTagsForResource(*auditmanager.ListTagsForResourceInput) (*auditmanager.ListTagsForResourceOutput, error) + ListTagsForResourceWithContext(aws.Context, *auditmanager.ListTagsForResourceInput, ...request.Option) (*auditmanager.ListTagsForResourceOutput, error) + ListTagsForResourceRequest(*auditmanager.ListTagsForResourceInput) (*request.Request, *auditmanager.ListTagsForResourceOutput) + + RegisterAccount(*auditmanager.RegisterAccountInput) (*auditmanager.RegisterAccountOutput, error) + RegisterAccountWithContext(aws.Context, *auditmanager.RegisterAccountInput, ...request.Option) (*auditmanager.RegisterAccountOutput, error) + RegisterAccountRequest(*auditmanager.RegisterAccountInput) (*request.Request, *auditmanager.RegisterAccountOutput) + + RegisterOrganizationAdminAccount(*auditmanager.RegisterOrganizationAdminAccountInput) (*auditmanager.RegisterOrganizationAdminAccountOutput, error) + RegisterOrganizationAdminAccountWithContext(aws.Context, *auditmanager.RegisterOrganizationAdminAccountInput, ...request.Option) (*auditmanager.RegisterOrganizationAdminAccountOutput, error) + RegisterOrganizationAdminAccountRequest(*auditmanager.RegisterOrganizationAdminAccountInput) (*request.Request, *auditmanager.RegisterOrganizationAdminAccountOutput) + + TagResource(*auditmanager.TagResourceInput) (*auditmanager.TagResourceOutput, error) + TagResourceWithContext(aws.Context, *auditmanager.TagResourceInput, ...request.Option) (*auditmanager.TagResourceOutput, error) + TagResourceRequest(*auditmanager.TagResourceInput) (*request.Request, *auditmanager.TagResourceOutput) + + UntagResource(*auditmanager.UntagResourceInput) (*auditmanager.UntagResourceOutput, error) + UntagResourceWithContext(aws.Context, *auditmanager.UntagResourceInput, ...request.Option) (*auditmanager.UntagResourceOutput, error) + UntagResourceRequest(*auditmanager.UntagResourceInput) (*request.Request, *auditmanager.UntagResourceOutput) + + UpdateAssessment(*auditmanager.UpdateAssessmentInput) (*auditmanager.UpdateAssessmentOutput, error) + UpdateAssessmentWithContext(aws.Context, *auditmanager.UpdateAssessmentInput, ...request.Option) (*auditmanager.UpdateAssessmentOutput, error) + UpdateAssessmentRequest(*auditmanager.UpdateAssessmentInput) (*request.Request, *auditmanager.UpdateAssessmentOutput) + + UpdateAssessmentControl(*auditmanager.UpdateAssessmentControlInput) (*auditmanager.UpdateAssessmentControlOutput, error) + UpdateAssessmentControlWithContext(aws.Context, *auditmanager.UpdateAssessmentControlInput, ...request.Option) (*auditmanager.UpdateAssessmentControlOutput, error) + UpdateAssessmentControlRequest(*auditmanager.UpdateAssessmentControlInput) (*request.Request, *auditmanager.UpdateAssessmentControlOutput) + + UpdateAssessmentControlSetStatus(*auditmanager.UpdateAssessmentControlSetStatusInput) (*auditmanager.UpdateAssessmentControlSetStatusOutput, error) + UpdateAssessmentControlSetStatusWithContext(aws.Context, *auditmanager.UpdateAssessmentControlSetStatusInput, ...request.Option) (*auditmanager.UpdateAssessmentControlSetStatusOutput, error) + UpdateAssessmentControlSetStatusRequest(*auditmanager.UpdateAssessmentControlSetStatusInput) (*request.Request, *auditmanager.UpdateAssessmentControlSetStatusOutput) + + UpdateAssessmentFramework(*auditmanager.UpdateAssessmentFrameworkInput) (*auditmanager.UpdateAssessmentFrameworkOutput, error) + UpdateAssessmentFrameworkWithContext(aws.Context, *auditmanager.UpdateAssessmentFrameworkInput, ...request.Option) (*auditmanager.UpdateAssessmentFrameworkOutput, error) + UpdateAssessmentFrameworkRequest(*auditmanager.UpdateAssessmentFrameworkInput) (*request.Request, *auditmanager.UpdateAssessmentFrameworkOutput) + + UpdateAssessmentStatus(*auditmanager.UpdateAssessmentStatusInput) (*auditmanager.UpdateAssessmentStatusOutput, error) + UpdateAssessmentStatusWithContext(aws.Context, *auditmanager.UpdateAssessmentStatusInput, ...request.Option) (*auditmanager.UpdateAssessmentStatusOutput, error) + UpdateAssessmentStatusRequest(*auditmanager.UpdateAssessmentStatusInput) (*request.Request, *auditmanager.UpdateAssessmentStatusOutput) + + UpdateControl(*auditmanager.UpdateControlInput) (*auditmanager.UpdateControlOutput, error) + UpdateControlWithContext(aws.Context, *auditmanager.UpdateControlInput, ...request.Option) (*auditmanager.UpdateControlOutput, error) + UpdateControlRequest(*auditmanager.UpdateControlInput) (*request.Request, *auditmanager.UpdateControlOutput) + + UpdateSettings(*auditmanager.UpdateSettingsInput) (*auditmanager.UpdateSettingsOutput, error) + UpdateSettingsWithContext(aws.Context, *auditmanager.UpdateSettingsInput, ...request.Option) (*auditmanager.UpdateSettingsOutput, error) + UpdateSettingsRequest(*auditmanager.UpdateSettingsInput) (*request.Request, *auditmanager.UpdateSettingsOutput) + + ValidateAssessmentReportIntegrity(*auditmanager.ValidateAssessmentReportIntegrityInput) (*auditmanager.ValidateAssessmentReportIntegrityOutput, error) + ValidateAssessmentReportIntegrityWithContext(aws.Context, *auditmanager.ValidateAssessmentReportIntegrityInput, ...request.Option) (*auditmanager.ValidateAssessmentReportIntegrityOutput, error) + ValidateAssessmentReportIntegrityRequest(*auditmanager.ValidateAssessmentReportIntegrityInput) (*request.Request, *auditmanager.ValidateAssessmentReportIntegrityOutput) +} + +var _ AuditManagerAPI = (*auditmanager.AuditManager)(nil) diff --git a/service/auditmanager/doc.go b/service/auditmanager/doc.go new file mode 100644 index 00000000000..0b5b697b0d7 --- /dev/null +++ b/service/auditmanager/doc.go @@ -0,0 +1,58 @@ +// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT. + +// Package auditmanager provides the client and types for making API +// requests to AWS Audit Manager. +// +// Welcome to the AWS Audit Manager API reference. This guide is for developers +// who need detailed information about the AWS Audit Manager API operations, +// data types, and errors. +// +// AWS Audit Manager is a service that provides automated evidence collection +// so that you can continuously audit your AWS usage, and assess the effectiveness +// of your controls to better manage risk and simplify compliance. +// +// AWS Audit Manager provides pre-built frameworks that structure and automate +// assessments for a given compliance standard. Frameworks include a pre-built +// collection of controls with descriptions and testing procedures, which are +// grouped according to the requirements of the specified compliance standard +// or regulation. You can also customize frameworks and controls to support +// internal audits with unique requirements. +// +// Use the following links to get started with the AWS Audit Manager API: +// +// * Actions (https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_Operations.html): +// An alphabetical list of all AWS Audit Manager API operations. +// +// * Data types (https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_Types.html): +// An alphabetical list of all AWS Audit Manager data types. +// +// * Common parameters (https://docs.aws.amazon.com/audit-manager/latest/APIReference/CommonParameters.html): +// Parameters that all Query operations can use. +// +// * Common errors (https://docs.aws.amazon.com/audit-manager/latest/APIReference/CommonErrors.html): +// Client and server errors that all operations can return. +// +// If you're new to AWS Audit Manager, we recommend that you review the AWS +// Audit Manager User Guide (https://docs.aws.amazon.com/audit-manager/latest/userguide/what-is.html). +// +// See https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25 for more information on this service. +// +// See auditmanager package documentation for more information. +// https://docs.aws.amazon.com/sdk-for-go/api/service/auditmanager/ +// +// Using the Client +// +// To contact AWS Audit Manager with the SDK use the New function to create +// a new service client. With that client you can make API requests to the service. +// These clients are safe to use concurrently. +// +// See the SDK's documentation for more information on how to use the SDK. +// https://docs.aws.amazon.com/sdk-for-go/api/ +// +// See aws.Config documentation for more information on configuring SDK clients. +// https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config +// +// See the AWS Audit Manager client AuditManager for more +// information on creating client for this service. +// https://docs.aws.amazon.com/sdk-for-go/api/service/auditmanager/#New +package auditmanager diff --git a/service/auditmanager/errors.go b/service/auditmanager/errors.go new file mode 100644 index 00000000000..dda3b563c61 --- /dev/null +++ b/service/auditmanager/errors.go @@ -0,0 +1,42 @@ +// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT. + +package auditmanager + +import ( + "github.com/aws/aws-sdk-go/private/protocol" +) + +const ( + + // ErrCodeAccessDeniedException for service response error code + // "AccessDeniedException". + // + // You do not have sufficient access to perform this action. + ErrCodeAccessDeniedException = "AccessDeniedException" + + // ErrCodeInternalServerException for service response error code + // "InternalServerException". + // + // An internal service error occurred during the processing of your request. + // Try again later. + ErrCodeInternalServerException = "InternalServerException" + + // ErrCodeResourceNotFoundException for service response error code + // "ResourceNotFoundException". + // + // The resource specified in the request cannot be found. + ErrCodeResourceNotFoundException = "ResourceNotFoundException" + + // ErrCodeValidationException for service response error code + // "ValidationException". + // + // The request has invalid or missing parameters. + ErrCodeValidationException = "ValidationException" +) + +var exceptionFromCode = map[string]func(protocol.ResponseMetadata) error{ + "AccessDeniedException": newErrorAccessDeniedException, + "InternalServerException": newErrorInternalServerException, + "ResourceNotFoundException": newErrorResourceNotFoundException, + "ValidationException": newErrorValidationException, +} diff --git a/service/auditmanager/service.go b/service/auditmanager/service.go new file mode 100644 index 00000000000..31eb767724b --- /dev/null +++ b/service/auditmanager/service.go @@ -0,0 +1,104 @@ +// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT. + +package auditmanager + +import ( + "github.com/aws/aws-sdk-go/aws" + "github.com/aws/aws-sdk-go/aws/client" + "github.com/aws/aws-sdk-go/aws/client/metadata" + "github.com/aws/aws-sdk-go/aws/request" + "github.com/aws/aws-sdk-go/aws/signer/v4" + "github.com/aws/aws-sdk-go/private/protocol" + "github.com/aws/aws-sdk-go/private/protocol/restjson" +) + +// AuditManager provides the API operation methods for making requests to +// AWS Audit Manager. See this package's package overview docs +// for details on the service. +// +// AuditManager methods are safe to use concurrently. It is not safe to +// modify mutate any of the struct's properties though. +type AuditManager struct { + *client.Client +} + +// Used for custom client initialization logic +var initClient func(*client.Client) + +// Used for custom request initialization logic +var initRequest func(*request.Request) + +// Service information constants +const ( + ServiceName = "AuditManager" // Name of service. + EndpointsID = "auditmanager" // ID to lookup a service endpoint with. + ServiceID = "AuditManager" // ServiceID is a unique identifier of a specific service. +) + +// New creates a new instance of the AuditManager client with a session. +// If additional configuration is needed for the client instance use the optional +// aws.Config parameter to add your extra config. +// +// Example: +// mySession := session.Must(session.NewSession()) +// +// // Create a AuditManager client from just a session. +// svc := auditmanager.New(mySession) +// +// // Create a AuditManager client with additional configuration +// svc := auditmanager.New(mySession, aws.NewConfig().WithRegion("us-west-2")) +func New(p client.ConfigProvider, cfgs ...*aws.Config) *AuditManager { + c := p.ClientConfig(EndpointsID, cfgs...) + if c.SigningNameDerived || len(c.SigningName) == 0 { + c.SigningName = "auditmanager" + } + return newClient(*c.Config, c.Handlers, c.PartitionID, c.Endpoint, c.SigningRegion, c.SigningName) +} + +// newClient creates, initializes and returns a new service client instance. +func newClient(cfg aws.Config, handlers request.Handlers, partitionID, endpoint, signingRegion, signingName string) *AuditManager { + svc := &AuditManager{ + Client: client.New( + cfg, + metadata.ClientInfo{ + ServiceName: ServiceName, + ServiceID: ServiceID, + SigningName: signingName, + SigningRegion: signingRegion, + PartitionID: partitionID, + Endpoint: endpoint, + APIVersion: "2017-07-25", + }, + handlers, + ), + } + + // Handlers + svc.Handlers.Sign.PushBackNamed(v4.SignRequestHandler) + svc.Handlers.Build.PushBackNamed(restjson.BuildHandler) + svc.Handlers.Unmarshal.PushBackNamed(restjson.UnmarshalHandler) + svc.Handlers.UnmarshalMeta.PushBackNamed(restjson.UnmarshalMetaHandler) + svc.Handlers.UnmarshalError.PushBackNamed( + protocol.NewUnmarshalErrorHandler(restjson.NewUnmarshalTypedError(exceptionFromCode)).NamedHandler(), + ) + + // Run custom client initialization if present + if initClient != nil { + initClient(svc.Client) + } + + return svc +} + +// newRequest creates a new request for a AuditManager operation and runs any +// custom request initialization. +func (c *AuditManager) newRequest(op *request.Operation, params, data interface{}) *request.Request { + req := c.NewRequest(op, params, data) + + // Run custom request initialization if present + if initRequest != nil { + initRequest(req) + } + + return req +} diff --git a/service/ecr/api.go b/service/ecr/api.go index 462b049cc3c..9f85b3d434d 100644 --- a/service/ecr/api.go +++ b/service/ecr/api.go @@ -604,6 +604,92 @@ func (c *ECR) DeleteLifecyclePolicyWithContext(ctx aws.Context, input *DeleteLif return out, req.Send() } +const opDeleteRegistryPolicy = "DeleteRegistryPolicy" + +// DeleteRegistryPolicyRequest generates a "aws/request.Request" representing the +// client's request for the DeleteRegistryPolicy operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See DeleteRegistryPolicy for more information on using the DeleteRegistryPolicy +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the DeleteRegistryPolicyRequest method. +// req, resp := client.DeleteRegistryPolicyRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/ecr-2015-09-21/DeleteRegistryPolicy +func (c *ECR) DeleteRegistryPolicyRequest(input *DeleteRegistryPolicyInput) (req *request.Request, output *DeleteRegistryPolicyOutput) { + op := &request.Operation{ + Name: opDeleteRegistryPolicy, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &DeleteRegistryPolicyInput{} + } + + output = &DeleteRegistryPolicyOutput{} + req = c.newRequest(op, input, output) + return +} + +// DeleteRegistryPolicy API operation for Amazon EC2 Container Registry. +// +// Deletes the registry permissions policy. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon EC2 Container Registry's +// API operation DeleteRegistryPolicy for usage and error information. +// +// Returned Error Types: +// * ServerException +// These errors are usually caused by a server-side issue. +// +// * InvalidParameterException +// The specified parameter is invalid. Review the available parameters for the +// API request. +// +// * RegistryPolicyNotFoundException +// The registry doesn't have an associated registry policy. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/ecr-2015-09-21/DeleteRegistryPolicy +func (c *ECR) DeleteRegistryPolicy(input *DeleteRegistryPolicyInput) (*DeleteRegistryPolicyOutput, error) { + req, out := c.DeleteRegistryPolicyRequest(input) + return out, req.Send() +} + +// DeleteRegistryPolicyWithContext is the same as DeleteRegistryPolicy with the addition of +// the ability to pass a context and additional request options. +// +// See DeleteRegistryPolicy for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *ECR) DeleteRegistryPolicyWithContext(ctx aws.Context, input *DeleteRegistryPolicyInput, opts ...request.Option) (*DeleteRegistryPolicyOutput, error) { + req, out := c.DeleteRegistryPolicyRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opDeleteRepository = "DeleteRepository" // DeleteRepositoryRequest generates a "aws/request.Request" representing the @@ -1096,6 +1182,94 @@ func (c *ECR) DescribeImagesPagesWithContext(ctx aws.Context, input *DescribeIma return p.Err() } +const opDescribeRegistry = "DescribeRegistry" + +// DescribeRegistryRequest generates a "aws/request.Request" representing the +// client's request for the DescribeRegistry operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See DescribeRegistry for more information on using the DescribeRegistry +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the DescribeRegistryRequest method. +// req, resp := client.DescribeRegistryRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/ecr-2015-09-21/DescribeRegistry +func (c *ECR) DescribeRegistryRequest(input *DescribeRegistryInput) (req *request.Request, output *DescribeRegistryOutput) { + op := &request.Operation{ + Name: opDescribeRegistry, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &DescribeRegistryInput{} + } + + output = &DescribeRegistryOutput{} + req = c.newRequest(op, input, output) + return +} + +// DescribeRegistry API operation for Amazon EC2 Container Registry. +// +// Describes the settings for a registry. The replication configuration for +// a repository can be created or updated with the PutReplicationConfiguration +// API action. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon EC2 Container Registry's +// API operation DescribeRegistry for usage and error information. +// +// Returned Error Types: +// * ServerException +// These errors are usually caused by a server-side issue. +// +// * InvalidParameterException +// The specified parameter is invalid. Review the available parameters for the +// API request. +// +// * ValidationException +// There was an exception validating this request. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/ecr-2015-09-21/DescribeRegistry +func (c *ECR) DescribeRegistry(input *DescribeRegistryInput) (*DescribeRegistryOutput, error) { + req, out := c.DescribeRegistryRequest(input) + return out, req.Send() +} + +// DescribeRegistryWithContext is the same as DescribeRegistry with the addition of +// the ability to pass a context and additional request options. +// +// See DescribeRegistry for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *ECR) DescribeRegistryWithContext(ctx aws.Context, input *DescribeRegistryInput, opts ...request.Option) (*DescribeRegistryOutput, error) { + req, out := c.DescribeRegistryRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opDescribeRepositories = "DescribeRepositories" // DescribeRepositoriesRequest generates a "aws/request.Request" representing the @@ -1675,6 +1849,92 @@ func (c *ECR) GetLifecyclePolicyPreviewPagesWithContext(ctx aws.Context, input * return p.Err() } +const opGetRegistryPolicy = "GetRegistryPolicy" + +// GetRegistryPolicyRequest generates a "aws/request.Request" representing the +// client's request for the GetRegistryPolicy operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See GetRegistryPolicy for more information on using the GetRegistryPolicy +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the GetRegistryPolicyRequest method. +// req, resp := client.GetRegistryPolicyRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/ecr-2015-09-21/GetRegistryPolicy +func (c *ECR) GetRegistryPolicyRequest(input *GetRegistryPolicyInput) (req *request.Request, output *GetRegistryPolicyOutput) { + op := &request.Operation{ + Name: opGetRegistryPolicy, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &GetRegistryPolicyInput{} + } + + output = &GetRegistryPolicyOutput{} + req = c.newRequest(op, input, output) + return +} + +// GetRegistryPolicy API operation for Amazon EC2 Container Registry. +// +// Retrieves the permissions policy for a registry. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon EC2 Container Registry's +// API operation GetRegistryPolicy for usage and error information. +// +// Returned Error Types: +// * ServerException +// These errors are usually caused by a server-side issue. +// +// * InvalidParameterException +// The specified parameter is invalid. Review the available parameters for the +// API request. +// +// * RegistryPolicyNotFoundException +// The registry doesn't have an associated registry policy. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/ecr-2015-09-21/GetRegistryPolicy +func (c *ECR) GetRegistryPolicy(input *GetRegistryPolicyInput) (*GetRegistryPolicyOutput, error) { + req, out := c.GetRegistryPolicyRequest(input) + return out, req.Send() +} + +// GetRegistryPolicyWithContext is the same as GetRegistryPolicy with the addition of +// the ability to pass a context and additional request options. +// +// See GetRegistryPolicy for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *ECR) GetRegistryPolicyWithContext(ctx aws.Context, input *GetRegistryPolicyInput, opts ...request.Option) (*GetRegistryPolicyOutput, error) { + req, out := c.GetRegistryPolicyRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opGetRepositoryPolicy = "GetRepositoryPolicy" // GetRepositoryPolicyRequest generates a "aws/request.Request" representing the @@ -2489,52 +2749,55 @@ func (c *ECR) PutLifecyclePolicyWithContext(ctx aws.Context, input *PutLifecycle return out, req.Send() } -const opSetRepositoryPolicy = "SetRepositoryPolicy" +const opPutRegistryPolicy = "PutRegistryPolicy" -// SetRepositoryPolicyRequest generates a "aws/request.Request" representing the -// client's request for the SetRepositoryPolicy operation. The "output" return +// PutRegistryPolicyRequest generates a "aws/request.Request" representing the +// client's request for the PutRegistryPolicy operation. The "output" return // value will be populated with the request's response once the request completes // successfully. // // Use "Send" method on the returned Request to send the API call to the service. // the "output" return value is not valid until after Send returns without error. // -// See SetRepositoryPolicy for more information on using the SetRepositoryPolicy +// See PutRegistryPolicy for more information on using the PutRegistryPolicy // API call, and error handling. // // This method is useful when you want to inject custom logic or configuration // into the SDK's request lifecycle. Such as custom headers, or retry logic. // // -// // Example sending a request using the SetRepositoryPolicyRequest method. -// req, resp := client.SetRepositoryPolicyRequest(params) +// // Example sending a request using the PutRegistryPolicyRequest method. +// req, resp := client.PutRegistryPolicyRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/ecr-2015-09-21/SetRepositoryPolicy -func (c *ECR) SetRepositoryPolicyRequest(input *SetRepositoryPolicyInput) (req *request.Request, output *SetRepositoryPolicyOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/ecr-2015-09-21/PutRegistryPolicy +func (c *ECR) PutRegistryPolicyRequest(input *PutRegistryPolicyInput) (req *request.Request, output *PutRegistryPolicyOutput) { op := &request.Operation{ - Name: opSetRepositoryPolicy, + Name: opPutRegistryPolicy, HTTPMethod: "POST", HTTPPath: "/", } if input == nil { - input = &SetRepositoryPolicyInput{} + input = &PutRegistryPolicyInput{} } - output = &SetRepositoryPolicyOutput{} + output = &PutRegistryPolicyOutput{} req = c.newRequest(op, input, output) return } -// SetRepositoryPolicy API operation for Amazon EC2 Container Registry. +// PutRegistryPolicy API operation for Amazon EC2 Container Registry. // -// Applies a repository policy to the specified repository to control access -// permissions. For more information, see Amazon ECR Repository Policies (https://docs.aws.amazon.com/AmazonECR/latest/userguide/repository-policies.html) +// Creates or updates the permissions policy for your registry. +// +// A registry policy is used to specify permissions for another AWS account +// and is used when configuring cross-account replication. For more information, +// see Registry permissions (https://docs.aws.amazon.com/AmazonECR/latest/userguide/registry-permissions.html) // in the Amazon Elastic Container Registry User Guide. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions @@ -2542,7 +2805,7 @@ func (c *ECR) SetRepositoryPolicyRequest(input *SetRepositoryPolicyInput) (req * // the error. // // See the AWS API reference guide for Amazon EC2 Container Registry's -// API operation SetRepositoryPolicy for usage and error information. +// API operation PutRegistryPolicy for usage and error information. // // Returned Error Types: // * ServerException @@ -2552,87 +2815,90 @@ func (c *ECR) SetRepositoryPolicyRequest(input *SetRepositoryPolicyInput) (req * // The specified parameter is invalid. Review the available parameters for the // API request. // -// * RepositoryNotFoundException -// The specified repository could not be found. Check the spelling of the specified -// repository and ensure that you are performing operations on the correct registry. -// -// See also, https://docs.aws.amazon.com/goto/WebAPI/ecr-2015-09-21/SetRepositoryPolicy -func (c *ECR) SetRepositoryPolicy(input *SetRepositoryPolicyInput) (*SetRepositoryPolicyOutput, error) { - req, out := c.SetRepositoryPolicyRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/ecr-2015-09-21/PutRegistryPolicy +func (c *ECR) PutRegistryPolicy(input *PutRegistryPolicyInput) (*PutRegistryPolicyOutput, error) { + req, out := c.PutRegistryPolicyRequest(input) return out, req.Send() } -// SetRepositoryPolicyWithContext is the same as SetRepositoryPolicy with the addition of +// PutRegistryPolicyWithContext is the same as PutRegistryPolicy with the addition of // the ability to pass a context and additional request options. // -// See SetRepositoryPolicy for details on how to use this API operation. +// See PutRegistryPolicy for details on how to use this API operation. // // The context must be non-nil and will be used for request cancellation. If // the context is nil a panic will occur. In the future the SDK may create // sub-contexts for http.Requests. See https://golang.org/pkg/context/ // for more information on using Contexts. -func (c *ECR) SetRepositoryPolicyWithContext(ctx aws.Context, input *SetRepositoryPolicyInput, opts ...request.Option) (*SetRepositoryPolicyOutput, error) { - req, out := c.SetRepositoryPolicyRequest(input) +func (c *ECR) PutRegistryPolicyWithContext(ctx aws.Context, input *PutRegistryPolicyInput, opts ...request.Option) (*PutRegistryPolicyOutput, error) { + req, out := c.PutRegistryPolicyRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opStartImageScan = "StartImageScan" +const opPutReplicationConfiguration = "PutReplicationConfiguration" -// StartImageScanRequest generates a "aws/request.Request" representing the -// client's request for the StartImageScan operation. The "output" return +// PutReplicationConfigurationRequest generates a "aws/request.Request" representing the +// client's request for the PutReplicationConfiguration operation. The "output" return // value will be populated with the request's response once the request completes // successfully. // // Use "Send" method on the returned Request to send the API call to the service. // the "output" return value is not valid until after Send returns without error. // -// See StartImageScan for more information on using the StartImageScan +// See PutReplicationConfiguration for more information on using the PutReplicationConfiguration // API call, and error handling. // // This method is useful when you want to inject custom logic or configuration // into the SDK's request lifecycle. Such as custom headers, or retry logic. // // -// // Example sending a request using the StartImageScanRequest method. -// req, resp := client.StartImageScanRequest(params) +// // Example sending a request using the PutReplicationConfigurationRequest method. +// req, resp := client.PutReplicationConfigurationRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/ecr-2015-09-21/StartImageScan -func (c *ECR) StartImageScanRequest(input *StartImageScanInput) (req *request.Request, output *StartImageScanOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/ecr-2015-09-21/PutReplicationConfiguration +func (c *ECR) PutReplicationConfigurationRequest(input *PutReplicationConfigurationInput) (req *request.Request, output *PutReplicationConfigurationOutput) { op := &request.Operation{ - Name: opStartImageScan, + Name: opPutReplicationConfiguration, HTTPMethod: "POST", HTTPPath: "/", } if input == nil { - input = &StartImageScanInput{} + input = &PutReplicationConfigurationInput{} } - output = &StartImageScanOutput{} + output = &PutReplicationConfigurationOutput{} req = c.newRequest(op, input, output) return } -// StartImageScan API operation for Amazon EC2 Container Registry. +// PutReplicationConfiguration API operation for Amazon EC2 Container Registry. // -// Starts an image vulnerability scan. An image scan can only be started once -// per day on an individual image. This limit includes if an image was scanned -// on initial push. For more information, see Image Scanning (https://docs.aws.amazon.com/AmazonECR/latest/userguide/image-scanning.html) +// Creates or updates the replication configuration for a registry. The existing +// replication configuration for a repository can be retrieved with the DescribeRegistry +// API action. The first time the PutReplicationConfiguration API is called, +// a service-linked IAM role is created in your account for the replication +// process. For more information, see Using Service-Linked Roles for Amazon +// ECR (https://docs.aws.amazon.com/AmazonECR/latest/userguide/using-service-linked-roles.html) // in the Amazon Elastic Container Registry User Guide. // +// When configuring cross-account replication, the destination account must +// grant the source account permission to replicate. This permission is controlled +// using a registry permissions policy. For more information, see PutRegistryPolicy. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. // // See the AWS API reference guide for Amazon EC2 Container Registry's -// API operation StartImageScan for usage and error information. +// API operation PutReplicationConfiguration for usage and error information. // // Returned Error Types: // * ServerException @@ -2642,44 +2908,222 @@ func (c *ECR) StartImageScanRequest(input *StartImageScanInput) (req *request.Re // The specified parameter is invalid. Review the available parameters for the // API request. // -// * UnsupportedImageTypeException -// The image is of a type that cannot be scanned. -// -// * LimitExceededException -// The operation did not succeed because it would have exceeded a service limit -// for your account. For more information, see Amazon ECR Service Quotas (https://docs.aws.amazon.com/AmazonECR/latest/userguide/service-quotas.html) -// in the Amazon Elastic Container Registry User Guide. -// -// * RepositoryNotFoundException -// The specified repository could not be found. Check the spelling of the specified -// repository and ensure that you are performing operations on the correct registry. -// -// * ImageNotFoundException -// The image requested does not exist in the specified repository. +// * ValidationException +// There was an exception validating this request. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/ecr-2015-09-21/StartImageScan -func (c *ECR) StartImageScan(input *StartImageScanInput) (*StartImageScanOutput, error) { - req, out := c.StartImageScanRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/ecr-2015-09-21/PutReplicationConfiguration +func (c *ECR) PutReplicationConfiguration(input *PutReplicationConfigurationInput) (*PutReplicationConfigurationOutput, error) { + req, out := c.PutReplicationConfigurationRequest(input) return out, req.Send() } -// StartImageScanWithContext is the same as StartImageScan with the addition of +// PutReplicationConfigurationWithContext is the same as PutReplicationConfiguration with the addition of // the ability to pass a context and additional request options. // -// See StartImageScan for details on how to use this API operation. +// See PutReplicationConfiguration for details on how to use this API operation. // // The context must be non-nil and will be used for request cancellation. If // the context is nil a panic will occur. In the future the SDK may create // sub-contexts for http.Requests. See https://golang.org/pkg/context/ // for more information on using Contexts. -func (c *ECR) StartImageScanWithContext(ctx aws.Context, input *StartImageScanInput, opts ...request.Option) (*StartImageScanOutput, error) { - req, out := c.StartImageScanRequest(input) +func (c *ECR) PutReplicationConfigurationWithContext(ctx aws.Context, input *PutReplicationConfigurationInput, opts ...request.Option) (*PutReplicationConfigurationOutput, error) { + req, out := c.PutReplicationConfigurationRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opStartLifecyclePolicyPreview = "StartLifecyclePolicyPreview" +const opSetRepositoryPolicy = "SetRepositoryPolicy" + +// SetRepositoryPolicyRequest generates a "aws/request.Request" representing the +// client's request for the SetRepositoryPolicy operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See SetRepositoryPolicy for more information on using the SetRepositoryPolicy +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the SetRepositoryPolicyRequest method. +// req, resp := client.SetRepositoryPolicyRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/ecr-2015-09-21/SetRepositoryPolicy +func (c *ECR) SetRepositoryPolicyRequest(input *SetRepositoryPolicyInput) (req *request.Request, output *SetRepositoryPolicyOutput) { + op := &request.Operation{ + Name: opSetRepositoryPolicy, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &SetRepositoryPolicyInput{} + } + + output = &SetRepositoryPolicyOutput{} + req = c.newRequest(op, input, output) + return +} + +// SetRepositoryPolicy API operation for Amazon EC2 Container Registry. +// +// Applies a repository policy to the specified repository to control access +// permissions. For more information, see Amazon ECR Repository Policies (https://docs.aws.amazon.com/AmazonECR/latest/userguide/repository-policies.html) +// in the Amazon Elastic Container Registry User Guide. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon EC2 Container Registry's +// API operation SetRepositoryPolicy for usage and error information. +// +// Returned Error Types: +// * ServerException +// These errors are usually caused by a server-side issue. +// +// * InvalidParameterException +// The specified parameter is invalid. Review the available parameters for the +// API request. +// +// * RepositoryNotFoundException +// The specified repository could not be found. Check the spelling of the specified +// repository and ensure that you are performing operations on the correct registry. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/ecr-2015-09-21/SetRepositoryPolicy +func (c *ECR) SetRepositoryPolicy(input *SetRepositoryPolicyInput) (*SetRepositoryPolicyOutput, error) { + req, out := c.SetRepositoryPolicyRequest(input) + return out, req.Send() +} + +// SetRepositoryPolicyWithContext is the same as SetRepositoryPolicy with the addition of +// the ability to pass a context and additional request options. +// +// See SetRepositoryPolicy for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *ECR) SetRepositoryPolicyWithContext(ctx aws.Context, input *SetRepositoryPolicyInput, opts ...request.Option) (*SetRepositoryPolicyOutput, error) { + req, out := c.SetRepositoryPolicyRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opStartImageScan = "StartImageScan" + +// StartImageScanRequest generates a "aws/request.Request" representing the +// client's request for the StartImageScan operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See StartImageScan for more information on using the StartImageScan +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the StartImageScanRequest method. +// req, resp := client.StartImageScanRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/ecr-2015-09-21/StartImageScan +func (c *ECR) StartImageScanRequest(input *StartImageScanInput) (req *request.Request, output *StartImageScanOutput) { + op := &request.Operation{ + Name: opStartImageScan, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &StartImageScanInput{} + } + + output = &StartImageScanOutput{} + req = c.newRequest(op, input, output) + return +} + +// StartImageScan API operation for Amazon EC2 Container Registry. +// +// Starts an image vulnerability scan. An image scan can only be started once +// per day on an individual image. This limit includes if an image was scanned +// on initial push. For more information, see Image Scanning (https://docs.aws.amazon.com/AmazonECR/latest/userguide/image-scanning.html) +// in the Amazon Elastic Container Registry User Guide. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon EC2 Container Registry's +// API operation StartImageScan for usage and error information. +// +// Returned Error Types: +// * ServerException +// These errors are usually caused by a server-side issue. +// +// * InvalidParameterException +// The specified parameter is invalid. Review the available parameters for the +// API request. +// +// * UnsupportedImageTypeException +// The image is of a type that cannot be scanned. +// +// * LimitExceededException +// The operation did not succeed because it would have exceeded a service limit +// for your account. For more information, see Amazon ECR Service Quotas (https://docs.aws.amazon.com/AmazonECR/latest/userguide/service-quotas.html) +// in the Amazon Elastic Container Registry User Guide. +// +// * RepositoryNotFoundException +// The specified repository could not be found. Check the spelling of the specified +// repository and ensure that you are performing operations on the correct registry. +// +// * ImageNotFoundException +// The image requested does not exist in the specified repository. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/ecr-2015-09-21/StartImageScan +func (c *ECR) StartImageScan(input *StartImageScanInput) (*StartImageScanOutput, error) { + req, out := c.StartImageScanRequest(input) + return out, req.Send() +} + +// StartImageScanWithContext is the same as StartImageScan with the addition of +// the ability to pass a context and additional request options. +// +// See StartImageScan for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *ECR) StartImageScanWithContext(ctx aws.Context, input *StartImageScanInput, opts ...request.Option) (*StartImageScanOutput, error) { + req, out := c.StartImageScanRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opStartLifecyclePolicyPreview = "StartLifecyclePolicyPreview" // StartLifecyclePolicyPreviewRequest generates a "aws/request.Request" representing the // client's request for the StartLifecyclePolicyPreview operation. The "output" return @@ -3852,6 +4296,52 @@ func (s *DeleteLifecyclePolicyOutput) SetRepositoryName(v string) *DeleteLifecyc return s } +type DeleteRegistryPolicyInput struct { + _ struct{} `type:"structure"` +} + +// String returns the string representation +func (s DeleteRegistryPolicyInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s DeleteRegistryPolicyInput) GoString() string { + return s.String() +} + +type DeleteRegistryPolicyOutput struct { + _ struct{} `type:"structure"` + + // The contents of the registry permissions policy that was deleted. + PolicyText *string `locationName:"policyText" type:"string"` + + // The registry ID associated with the request. + RegistryId *string `locationName:"registryId" type:"string"` +} + +// String returns the string representation +func (s DeleteRegistryPolicyOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s DeleteRegistryPolicyOutput) GoString() string { + return s.String() +} + +// SetPolicyText sets the PolicyText field's value. +func (s *DeleteRegistryPolicyOutput) SetPolicyText(v string) *DeleteRegistryPolicyOutput { + s.PolicyText = &v + return s +} + +// SetRegistryId sets the RegistryId field's value. +func (s *DeleteRegistryPolicyOutput) SetRegistryId(v string) *DeleteRegistryPolicyOutput { + s.RegistryId = &v + return s +} + type DeleteRepositoryInput struct { _ struct{} `type:"structure"` @@ -4378,32 +4868,78 @@ func (s *DescribeImagesOutput) SetNextToken(v string) *DescribeImagesOutput { return s } -type DescribeRepositoriesInput struct { +type DescribeRegistryInput struct { _ struct{} `type:"structure"` +} - // The maximum number of repository results returned by DescribeRepositories - // in paginated output. When this parameter is used, DescribeRepositories only - // returns maxResults results in a single page along with a nextToken response - // element. The remaining results of the initial request can be seen by sending - // another DescribeRepositories request with the returned nextToken value. This - // value can be between 1 and 1000. If this parameter is not used, then DescribeRepositories - // returns up to 100 results and a nextToken value, if applicable. This option - // cannot be used when you specify repositories with repositoryNames. - MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"` +// String returns the string representation +func (s DescribeRegistryInput) String() string { + return awsutil.Prettify(s) +} - // The nextToken value returned from a previous paginated DescribeRepositories - // request where maxResults was used and the results exceeded the value of that - // parameter. Pagination continues from the end of the previous results that - // returned the nextToken value. This value is null when there are no more results - // to return. This option cannot be used when you specify repositories with - // repositoryNames. - // - // This token should be treated as an opaque identifier that is only used to - // retrieve the next items in a list and not for other programmatic purposes. - NextToken *string `locationName:"nextToken" type:"string"` +// GoString returns the string representation +func (s DescribeRegistryInput) GoString() string { + return s.String() +} - // The AWS account ID associated with the registry that contains the repositories - // to be described. If you do not specify a registry, the default registry is +type DescribeRegistryOutput struct { + _ struct{} `type:"structure"` + + // The ID of the registry. + RegistryId *string `locationName:"registryId" type:"string"` + + // The replication configuration for the registry. + ReplicationConfiguration *ReplicationConfiguration `locationName:"replicationConfiguration" type:"structure"` +} + +// String returns the string representation +func (s DescribeRegistryOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s DescribeRegistryOutput) GoString() string { + return s.String() +} + +// SetRegistryId sets the RegistryId field's value. +func (s *DescribeRegistryOutput) SetRegistryId(v string) *DescribeRegistryOutput { + s.RegistryId = &v + return s +} + +// SetReplicationConfiguration sets the ReplicationConfiguration field's value. +func (s *DescribeRegistryOutput) SetReplicationConfiguration(v *ReplicationConfiguration) *DescribeRegistryOutput { + s.ReplicationConfiguration = v + return s +} + +type DescribeRepositoriesInput struct { + _ struct{} `type:"structure"` + + // The maximum number of repository results returned by DescribeRepositories + // in paginated output. When this parameter is used, DescribeRepositories only + // returns maxResults results in a single page along with a nextToken response + // element. The remaining results of the initial request can be seen by sending + // another DescribeRepositories request with the returned nextToken value. This + // value can be between 1 and 1000. If this parameter is not used, then DescribeRepositories + // returns up to 100 results and a nextToken value, if applicable. This option + // cannot be used when you specify repositories with repositoryNames. + MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"` + + // The nextToken value returned from a previous paginated DescribeRepositories + // request where maxResults was used and the results exceeded the value of that + // parameter. Pagination continues from the end of the previous results that + // returned the nextToken value. This value is null when there are no more results + // to return. This option cannot be used when you specify repositories with + // repositoryNames. + // + // This token should be treated as an opaque identifier that is only used to + // retrieve the next items in a list and not for other programmatic purposes. + NextToken *string `locationName:"nextToken" type:"string"` + + // The AWS account ID associated with the registry that contains the repositories + // to be described. If you do not specify a registry, the default registry is // assumed. RegistryId *string `locationName:"registryId" type:"string"` @@ -4641,7 +5177,9 @@ type GetAuthorizationTokenInput struct { // A list of AWS account IDs that are associated with the registries for which // to get AuthorizationData objects. If you do not specify a registry, the default // registry is assumed. - RegistryIds []*string `locationName:"registryIds" min:"1" type:"list"` + // + // Deprecated: This field is deprecated. The returned authorization token can be used to access any Amazon ECR registry that the IAM principal has access to, specifying a registry ID doesn't change the permissions scope of the authorization token. + RegistryIds []*string `locationName:"registryIds" min:"1" deprecated:"true" type:"list"` } // String returns the string representation @@ -5091,6 +5629,52 @@ func (s *GetLifecyclePolicyPreviewOutput) SetSummary(v *LifecyclePolicyPreviewSu return s } +type GetRegistryPolicyInput struct { + _ struct{} `type:"structure"` +} + +// String returns the string representation +func (s GetRegistryPolicyInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s GetRegistryPolicyInput) GoString() string { + return s.String() +} + +type GetRegistryPolicyOutput struct { + _ struct{} `type:"structure"` + + // The JSON text of the permissions policy for a registry. + PolicyText *string `locationName:"policyText" type:"string"` + + // The ID of the registry. + RegistryId *string `locationName:"registryId" type:"string"` +} + +// String returns the string representation +func (s GetRegistryPolicyOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s GetRegistryPolicyOutput) GoString() string { + return s.String() +} + +// SetPolicyText sets the PolicyText field's value. +func (s *GetRegistryPolicyOutput) SetPolicyText(v string) *GetRegistryPolicyOutput { + s.PolicyText = &v + return s +} + +// SetRegistryId sets the RegistryId field's value. +func (s *GetRegistryPolicyOutput) SetRegistryId(v string) *GetRegistryPolicyOutput { + s.RegistryId = &v + return s +} + type GetRepositoryPolicyInput struct { _ struct{} `type:"structure"` @@ -7631,6 +8215,145 @@ func (s *PutLifecyclePolicyOutput) SetRepositoryName(v string) *PutLifecyclePoli return s } +type PutRegistryPolicyInput struct { + _ struct{} `type:"structure"` + + // The JSON policy text to apply to your registry. The policy text follows the + // same format as IAM policy text. For more information, see Registry permissions + // (https://docs.aws.amazon.com/AmazonECR/latest/userguide/registry-permissions.html) + // in the Amazon Elastic Container Registry User Guide. + // + // PolicyText is a required field + PolicyText *string `locationName:"policyText" type:"string" required:"true"` +} + +// String returns the string representation +func (s PutRegistryPolicyInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s PutRegistryPolicyInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *PutRegistryPolicyInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "PutRegistryPolicyInput"} + if s.PolicyText == nil { + invalidParams.Add(request.NewErrParamRequired("PolicyText")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetPolicyText sets the PolicyText field's value. +func (s *PutRegistryPolicyInput) SetPolicyText(v string) *PutRegistryPolicyInput { + s.PolicyText = &v + return s +} + +type PutRegistryPolicyOutput struct { + _ struct{} `type:"structure"` + + // The JSON policy text for your registry. + PolicyText *string `locationName:"policyText" type:"string"` + + // The registry ID. + RegistryId *string `locationName:"registryId" type:"string"` +} + +// String returns the string representation +func (s PutRegistryPolicyOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s PutRegistryPolicyOutput) GoString() string { + return s.String() +} + +// SetPolicyText sets the PolicyText field's value. +func (s *PutRegistryPolicyOutput) SetPolicyText(v string) *PutRegistryPolicyOutput { + s.PolicyText = &v + return s +} + +// SetRegistryId sets the RegistryId field's value. +func (s *PutRegistryPolicyOutput) SetRegistryId(v string) *PutRegistryPolicyOutput { + s.RegistryId = &v + return s +} + +type PutReplicationConfigurationInput struct { + _ struct{} `type:"structure"` + + // An object representing the replication configuration for a registry. + // + // ReplicationConfiguration is a required field + ReplicationConfiguration *ReplicationConfiguration `locationName:"replicationConfiguration" type:"structure" required:"true"` +} + +// String returns the string representation +func (s PutReplicationConfigurationInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s PutReplicationConfigurationInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *PutReplicationConfigurationInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "PutReplicationConfigurationInput"} + if s.ReplicationConfiguration == nil { + invalidParams.Add(request.NewErrParamRequired("ReplicationConfiguration")) + } + if s.ReplicationConfiguration != nil { + if err := s.ReplicationConfiguration.Validate(); err != nil { + invalidParams.AddNested("ReplicationConfiguration", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetReplicationConfiguration sets the ReplicationConfiguration field's value. +func (s *PutReplicationConfigurationInput) SetReplicationConfiguration(v *ReplicationConfiguration) *PutReplicationConfigurationInput { + s.ReplicationConfiguration = v + return s +} + +type PutReplicationConfigurationOutput struct { + _ struct{} `type:"structure"` + + // The contents of the replication configuration for the registry. + ReplicationConfiguration *ReplicationConfiguration `locationName:"replicationConfiguration" type:"structure"` +} + +// String returns the string representation +func (s PutReplicationConfigurationOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s PutReplicationConfigurationOutput) GoString() string { + return s.String() +} + +// SetReplicationConfiguration sets the ReplicationConfiguration field's value. +func (s *PutReplicationConfigurationOutput) SetReplicationConfiguration(v *ReplicationConfiguration) *PutReplicationConfigurationOutput { + s.ReplicationConfiguration = v + return s +} + // The manifest list is referencing an image that does not exist. type ReferencedImagesNotFoundException struct { _ struct{} `type:"structure"` @@ -7687,6 +8410,220 @@ func (s *ReferencedImagesNotFoundException) RequestID() string { return s.RespMetadata.RequestID } +// The registry doesn't have an associated registry policy. +type RegistryPolicyNotFoundException struct { + _ struct{} `type:"structure"` + RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` + + Message_ *string `locationName:"message" type:"string"` +} + +// String returns the string representation +func (s RegistryPolicyNotFoundException) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s RegistryPolicyNotFoundException) GoString() string { + return s.String() +} + +func newErrorRegistryPolicyNotFoundException(v protocol.ResponseMetadata) error { + return &RegistryPolicyNotFoundException{ + RespMetadata: v, + } +} + +// Code returns the exception type name. +func (s *RegistryPolicyNotFoundException) Code() string { + return "RegistryPolicyNotFoundException" +} + +// Message returns the exception's message. +func (s *RegistryPolicyNotFoundException) Message() string { + if s.Message_ != nil { + return *s.Message_ + } + return "" +} + +// OrigErr always returns nil, satisfies awserr.Error interface. +func (s *RegistryPolicyNotFoundException) OrigErr() error { + return nil +} + +func (s *RegistryPolicyNotFoundException) Error() string { + return fmt.Sprintf("%s: %s", s.Code(), s.Message()) +} + +// Status code returns the HTTP status code for the request's response error. +func (s *RegistryPolicyNotFoundException) StatusCode() int { + return s.RespMetadata.StatusCode +} + +// RequestID returns the service's response RequestID for request. +func (s *RegistryPolicyNotFoundException) RequestID() string { + return s.RespMetadata.RequestID +} + +// The replication configuration for a registry. +type ReplicationConfiguration struct { + _ struct{} `type:"structure"` + + // An array of objects representing the replication rules for a replication + // configuration. A replication configuration may contain only one replication + // rule but the rule may contain one or more replication destinations. + // + // Rules is a required field + Rules []*ReplicationRule `locationName:"rules" type:"list" required:"true"` +} + +// String returns the string representation +func (s ReplicationConfiguration) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s ReplicationConfiguration) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ReplicationConfiguration) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ReplicationConfiguration"} + if s.Rules == nil { + invalidParams.Add(request.NewErrParamRequired("Rules")) + } + if s.Rules != nil { + for i, v := range s.Rules { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Rules", i), err.(request.ErrInvalidParams)) + } + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetRules sets the Rules field's value. +func (s *ReplicationConfiguration) SetRules(v []*ReplicationRule) *ReplicationConfiguration { + s.Rules = v + return s +} + +// An array of objects representing the details of a replication destination. +type ReplicationDestination struct { + _ struct{} `type:"structure"` + + // A Region to replicate to. + // + // Region is a required field + Region *string `locationName:"region" min:"2" type:"string" required:"true"` + + // The account ID of the destination registry to replicate to. + // + // RegistryId is a required field + RegistryId *string `locationName:"registryId" type:"string" required:"true"` +} + +// String returns the string representation +func (s ReplicationDestination) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s ReplicationDestination) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ReplicationDestination) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ReplicationDestination"} + if s.Region == nil { + invalidParams.Add(request.NewErrParamRequired("Region")) + } + if s.Region != nil && len(*s.Region) < 2 { + invalidParams.Add(request.NewErrParamMinLen("Region", 2)) + } + if s.RegistryId == nil { + invalidParams.Add(request.NewErrParamRequired("RegistryId")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetRegion sets the Region field's value. +func (s *ReplicationDestination) SetRegion(v string) *ReplicationDestination { + s.Region = &v + return s +} + +// SetRegistryId sets the RegistryId field's value. +func (s *ReplicationDestination) SetRegistryId(v string) *ReplicationDestination { + s.RegistryId = &v + return s +} + +// An array of objects representing the replication destinations for a replication +// configuration. A replication configuration may contain only one replication +// rule but the rule may contain one or more replication destinations. +type ReplicationRule struct { + _ struct{} `type:"structure"` + + // An array of objects representing the details of a replication destination. + // + // Destinations is a required field + Destinations []*ReplicationDestination `locationName:"destinations" type:"list" required:"true"` +} + +// String returns the string representation +func (s ReplicationRule) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s ReplicationRule) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ReplicationRule) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ReplicationRule"} + if s.Destinations == nil { + invalidParams.Add(request.NewErrParamRequired("Destinations")) + } + if s.Destinations != nil { + for i, v := range s.Destinations { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Destinations", i), err.(request.ErrInvalidParams)) + } + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDestinations sets the Destinations field's value. +func (s *ReplicationRule) SetDestinations(v []*ReplicationDestination) *ReplicationRule { + s.Destinations = v + return s +} + // An object representing a repository. type Repository struct { _ struct{} `type:"structure"` @@ -8985,6 +9922,62 @@ func (s *UploadNotFoundException) RequestID() string { return s.RespMetadata.RequestID } +// There was an exception validating this request. +type ValidationException struct { + _ struct{} `type:"structure"` + RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` + + Message_ *string `locationName:"message" type:"string"` +} + +// String returns the string representation +func (s ValidationException) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s ValidationException) GoString() string { + return s.String() +} + +func newErrorValidationException(v protocol.ResponseMetadata) error { + return &ValidationException{ + RespMetadata: v, + } +} + +// Code returns the exception type name. +func (s *ValidationException) Code() string { + return "ValidationException" +} + +// Message returns the exception's message. +func (s *ValidationException) Message() string { + if s.Message_ != nil { + return *s.Message_ + } + return "" +} + +// OrigErr always returns nil, satisfies awserr.Error interface. +func (s *ValidationException) OrigErr() error { + return nil +} + +func (s *ValidationException) Error() string { + return fmt.Sprintf("%s: %s", s.Code(), s.Message()) +} + +// Status code returns the HTTP status code for the request's response error. +func (s *ValidationException) StatusCode() int { + return s.RespMetadata.StatusCode +} + +// RequestID returns the service's response RequestID for request. +func (s *ValidationException) RequestID() string { + return s.RespMetadata.RequestID +} + const ( // EncryptionTypeAes256 is a EncryptionType enum value EncryptionTypeAes256 = "AES256" diff --git a/service/ecr/ecriface/interface.go b/service/ecr/ecriface/interface.go index b0163a22ce9..7004907d86e 100644 --- a/service/ecr/ecriface/interface.go +++ b/service/ecr/ecriface/interface.go @@ -84,6 +84,10 @@ type ECRAPI interface { DeleteLifecyclePolicyWithContext(aws.Context, *ecr.DeleteLifecyclePolicyInput, ...request.Option) (*ecr.DeleteLifecyclePolicyOutput, error) DeleteLifecyclePolicyRequest(*ecr.DeleteLifecyclePolicyInput) (*request.Request, *ecr.DeleteLifecyclePolicyOutput) + DeleteRegistryPolicy(*ecr.DeleteRegistryPolicyInput) (*ecr.DeleteRegistryPolicyOutput, error) + DeleteRegistryPolicyWithContext(aws.Context, *ecr.DeleteRegistryPolicyInput, ...request.Option) (*ecr.DeleteRegistryPolicyOutput, error) + DeleteRegistryPolicyRequest(*ecr.DeleteRegistryPolicyInput) (*request.Request, *ecr.DeleteRegistryPolicyOutput) + DeleteRepository(*ecr.DeleteRepositoryInput) (*ecr.DeleteRepositoryOutput, error) DeleteRepositoryWithContext(aws.Context, *ecr.DeleteRepositoryInput, ...request.Option) (*ecr.DeleteRepositoryOutput, error) DeleteRepositoryRequest(*ecr.DeleteRepositoryInput) (*request.Request, *ecr.DeleteRepositoryOutput) @@ -106,6 +110,10 @@ type ECRAPI interface { DescribeImagesPages(*ecr.DescribeImagesInput, func(*ecr.DescribeImagesOutput, bool) bool) error DescribeImagesPagesWithContext(aws.Context, *ecr.DescribeImagesInput, func(*ecr.DescribeImagesOutput, bool) bool, ...request.Option) error + DescribeRegistry(*ecr.DescribeRegistryInput) (*ecr.DescribeRegistryOutput, error) + DescribeRegistryWithContext(aws.Context, *ecr.DescribeRegistryInput, ...request.Option) (*ecr.DescribeRegistryOutput, error) + DescribeRegistryRequest(*ecr.DescribeRegistryInput) (*request.Request, *ecr.DescribeRegistryOutput) + DescribeRepositories(*ecr.DescribeRepositoriesInput) (*ecr.DescribeRepositoriesOutput, error) DescribeRepositoriesWithContext(aws.Context, *ecr.DescribeRepositoriesInput, ...request.Option) (*ecr.DescribeRepositoriesOutput, error) DescribeRepositoriesRequest(*ecr.DescribeRepositoriesInput) (*request.Request, *ecr.DescribeRepositoriesOutput) @@ -132,6 +140,10 @@ type ECRAPI interface { GetLifecyclePolicyPreviewPages(*ecr.GetLifecyclePolicyPreviewInput, func(*ecr.GetLifecyclePolicyPreviewOutput, bool) bool) error GetLifecyclePolicyPreviewPagesWithContext(aws.Context, *ecr.GetLifecyclePolicyPreviewInput, func(*ecr.GetLifecyclePolicyPreviewOutput, bool) bool, ...request.Option) error + GetRegistryPolicy(*ecr.GetRegistryPolicyInput) (*ecr.GetRegistryPolicyOutput, error) + GetRegistryPolicyWithContext(aws.Context, *ecr.GetRegistryPolicyInput, ...request.Option) (*ecr.GetRegistryPolicyOutput, error) + GetRegistryPolicyRequest(*ecr.GetRegistryPolicyInput) (*request.Request, *ecr.GetRegistryPolicyOutput) + GetRepositoryPolicy(*ecr.GetRepositoryPolicyInput) (*ecr.GetRepositoryPolicyOutput, error) GetRepositoryPolicyWithContext(aws.Context, *ecr.GetRepositoryPolicyInput, ...request.Option) (*ecr.GetRepositoryPolicyOutput, error) GetRepositoryPolicyRequest(*ecr.GetRepositoryPolicyInput) (*request.Request, *ecr.GetRepositoryPolicyOutput) @@ -167,6 +179,14 @@ type ECRAPI interface { PutLifecyclePolicyWithContext(aws.Context, *ecr.PutLifecyclePolicyInput, ...request.Option) (*ecr.PutLifecyclePolicyOutput, error) PutLifecyclePolicyRequest(*ecr.PutLifecyclePolicyInput) (*request.Request, *ecr.PutLifecyclePolicyOutput) + PutRegistryPolicy(*ecr.PutRegistryPolicyInput) (*ecr.PutRegistryPolicyOutput, error) + PutRegistryPolicyWithContext(aws.Context, *ecr.PutRegistryPolicyInput, ...request.Option) (*ecr.PutRegistryPolicyOutput, error) + PutRegistryPolicyRequest(*ecr.PutRegistryPolicyInput) (*request.Request, *ecr.PutRegistryPolicyOutput) + + PutReplicationConfiguration(*ecr.PutReplicationConfigurationInput) (*ecr.PutReplicationConfigurationOutput, error) + PutReplicationConfigurationWithContext(aws.Context, *ecr.PutReplicationConfigurationInput, ...request.Option) (*ecr.PutReplicationConfigurationOutput, error) + PutReplicationConfigurationRequest(*ecr.PutReplicationConfigurationInput) (*request.Request, *ecr.PutReplicationConfigurationOutput) + SetRepositoryPolicy(*ecr.SetRepositoryPolicyInput) (*ecr.SetRepositoryPolicyOutput, error) SetRepositoryPolicyWithContext(aws.Context, *ecr.SetRepositoryPolicyInput, ...request.Option) (*ecr.SetRepositoryPolicyOutput, error) SetRepositoryPolicyRequest(*ecr.SetRepositoryPolicyInput) (*request.Request, *ecr.SetRepositoryPolicyOutput) diff --git a/service/ecr/errors.go b/service/ecr/errors.go index 8191013264f..12b2b9570ad 100644 --- a/service/ecr/errors.go +++ b/service/ecr/errors.go @@ -135,6 +135,12 @@ const ( // The manifest list is referencing an image that does not exist. ErrCodeReferencedImagesNotFoundException = "ReferencedImagesNotFoundException" + // ErrCodeRegistryPolicyNotFoundException for service response error code + // "RegistryPolicyNotFoundException". + // + // The registry doesn't have an associated registry policy. + ErrCodeRegistryPolicyNotFoundException = "RegistryPolicyNotFoundException" + // ErrCodeRepositoryAlreadyExistsException for service response error code // "RepositoryAlreadyExistsException". // @@ -194,6 +200,12 @@ const ( // The upload could not be found, or the specified upload ID is not valid for // this repository. ErrCodeUploadNotFoundException = "UploadNotFoundException" + + // ErrCodeValidationException for service response error code + // "ValidationException". + // + // There was an exception validating this request. + ErrCodeValidationException = "ValidationException" ) var exceptionFromCode = map[string]func(protocol.ResponseMetadata) error{ @@ -216,6 +228,7 @@ var exceptionFromCode = map[string]func(protocol.ResponseMetadata) error{ "LifecyclePolicyPreviewNotFoundException": newErrorLifecyclePolicyPreviewNotFoundException, "LimitExceededException": newErrorLimitExceededException, "ReferencedImagesNotFoundException": newErrorReferencedImagesNotFoundException, + "RegistryPolicyNotFoundException": newErrorRegistryPolicyNotFoundException, "RepositoryAlreadyExistsException": newErrorRepositoryAlreadyExistsException, "RepositoryNotEmptyException": newErrorRepositoryNotEmptyException, "RepositoryNotFoundException": newErrorRepositoryNotFoundException, @@ -225,4 +238,5 @@ var exceptionFromCode = map[string]func(protocol.ResponseMetadata) error{ "TooManyTagsException": newErrorTooManyTagsException, "UnsupportedImageTypeException": newErrorUnsupportedImageTypeException, "UploadNotFoundException": newErrorUploadNotFoundException, + "ValidationException": newErrorValidationException, } diff --git a/service/emrcontainers/api.go b/service/emrcontainers/api.go new file mode 100644 index 00000000000..18c93d29cf2 --- /dev/null +++ b/service/emrcontainers/api.go @@ -0,0 +1,4320 @@ +// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT. + +package emrcontainers + +import ( + "fmt" + "time" + + "github.com/aws/aws-sdk-go/aws" + "github.com/aws/aws-sdk-go/aws/awsutil" + "github.com/aws/aws-sdk-go/aws/request" + "github.com/aws/aws-sdk-go/private/protocol" + "github.com/aws/aws-sdk-go/private/protocol/restjson" +) + +const opCancelJobRun = "CancelJobRun" + +// CancelJobRunRequest generates a "aws/request.Request" representing the +// client's request for the CancelJobRun operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See CancelJobRun for more information on using the CancelJobRun +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the CancelJobRunRequest method. +// req, resp := client.CancelJobRunRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/emr-containers-2020-10-01/CancelJobRun +func (c *EMRContainers) CancelJobRunRequest(input *CancelJobRunInput) (req *request.Request, output *CancelJobRunOutput) { + op := &request.Operation{ + Name: opCancelJobRun, + HTTPMethod: "DELETE", + HTTPPath: "/virtualclusters/{virtualClusterId}/jobruns/{jobRunId}", + } + + if input == nil { + input = &CancelJobRunInput{} + } + + output = &CancelJobRunOutput{} + req = c.newRequest(op, input, output) + return +} + +// CancelJobRun API operation for Amazon EMR Containers. +// +// Cancels a job run. A job run is a unit of work, such as a Spark jar, PySpark +// script, or SparkSQL query, that you submit to Amazon EMR on EKS. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon EMR Containers's +// API operation CancelJobRun for usage and error information. +// +// Returned Error Types: +// * ValidationException +// There are invalid parameters in the client request. +// +// * InternalServerException +// This is an internal server exception. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/emr-containers-2020-10-01/CancelJobRun +func (c *EMRContainers) CancelJobRun(input *CancelJobRunInput) (*CancelJobRunOutput, error) { + req, out := c.CancelJobRunRequest(input) + return out, req.Send() +} + +// CancelJobRunWithContext is the same as CancelJobRun with the addition of +// the ability to pass a context and additional request options. +// +// See CancelJobRun for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *EMRContainers) CancelJobRunWithContext(ctx aws.Context, input *CancelJobRunInput, opts ...request.Option) (*CancelJobRunOutput, error) { + req, out := c.CancelJobRunRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opCreateManagedEndpoint = "CreateManagedEndpoint" + +// CreateManagedEndpointRequest generates a "aws/request.Request" representing the +// client's request for the CreateManagedEndpoint operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See CreateManagedEndpoint for more information on using the CreateManagedEndpoint +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the CreateManagedEndpointRequest method. +// req, resp := client.CreateManagedEndpointRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/emr-containers-2020-10-01/CreateManagedEndpoint +func (c *EMRContainers) CreateManagedEndpointRequest(input *CreateManagedEndpointInput) (req *request.Request, output *CreateManagedEndpointOutput) { + op := &request.Operation{ + Name: opCreateManagedEndpoint, + HTTPMethod: "POST", + HTTPPath: "/virtualclusters/{virtualClusterId}/endpoints", + } + + if input == nil { + input = &CreateManagedEndpointInput{} + } + + output = &CreateManagedEndpointOutput{} + req = c.newRequest(op, input, output) + return +} + +// CreateManagedEndpoint API operation for Amazon EMR Containers. +// +// Creates a managed endpoint. A managed endpoint is a gateway that connects +// EMR Studio to Amazon EMR on EKS so that EMR Studio can communicate with your +// virtual cluster. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon EMR Containers's +// API operation CreateManagedEndpoint for usage and error information. +// +// Returned Error Types: +// * ValidationException +// There are invalid parameters in the client request. +// +// * ResourceNotFoundException +// The specified resource was not found. +// +// * InternalServerException +// This is an internal server exception. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/emr-containers-2020-10-01/CreateManagedEndpoint +func (c *EMRContainers) CreateManagedEndpoint(input *CreateManagedEndpointInput) (*CreateManagedEndpointOutput, error) { + req, out := c.CreateManagedEndpointRequest(input) + return out, req.Send() +} + +// CreateManagedEndpointWithContext is the same as CreateManagedEndpoint with the addition of +// the ability to pass a context and additional request options. +// +// See CreateManagedEndpoint for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *EMRContainers) CreateManagedEndpointWithContext(ctx aws.Context, input *CreateManagedEndpointInput, opts ...request.Option) (*CreateManagedEndpointOutput, error) { + req, out := c.CreateManagedEndpointRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opCreateVirtualCluster = "CreateVirtualCluster" + +// CreateVirtualClusterRequest generates a "aws/request.Request" representing the +// client's request for the CreateVirtualCluster operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See CreateVirtualCluster for more information on using the CreateVirtualCluster +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the CreateVirtualClusterRequest method. +// req, resp := client.CreateVirtualClusterRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/emr-containers-2020-10-01/CreateVirtualCluster +func (c *EMRContainers) CreateVirtualClusterRequest(input *CreateVirtualClusterInput) (req *request.Request, output *CreateVirtualClusterOutput) { + op := &request.Operation{ + Name: opCreateVirtualCluster, + HTTPMethod: "POST", + HTTPPath: "/virtualclusters", + } + + if input == nil { + input = &CreateVirtualClusterInput{} + } + + output = &CreateVirtualClusterOutput{} + req = c.newRequest(op, input, output) + return +} + +// CreateVirtualCluster API operation for Amazon EMR Containers. +// +// Creates a virtual cluster. Virtual cluster is a managed entity on Amazon +// EMR on EKS. You can create, describe, list and delete virtual clusters. They +// do not consume any additional resource in your system. A single virtual cluster +// maps to a single Kubernetes namespace. Given this relationship, you can model +// virtual clusters the same way you model Kubernetes namespaces to meet your +// requirements. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon EMR Containers's +// API operation CreateVirtualCluster for usage and error information. +// +// Returned Error Types: +// * ValidationException +// There are invalid parameters in the client request. +// +// * ResourceNotFoundException +// The specified resource was not found. +// +// * InternalServerException +// This is an internal server exception. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/emr-containers-2020-10-01/CreateVirtualCluster +func (c *EMRContainers) CreateVirtualCluster(input *CreateVirtualClusterInput) (*CreateVirtualClusterOutput, error) { + req, out := c.CreateVirtualClusterRequest(input) + return out, req.Send() +} + +// CreateVirtualClusterWithContext is the same as CreateVirtualCluster with the addition of +// the ability to pass a context and additional request options. +// +// See CreateVirtualCluster for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *EMRContainers) CreateVirtualClusterWithContext(ctx aws.Context, input *CreateVirtualClusterInput, opts ...request.Option) (*CreateVirtualClusterOutput, error) { + req, out := c.CreateVirtualClusterRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opDeleteManagedEndpoint = "DeleteManagedEndpoint" + +// DeleteManagedEndpointRequest generates a "aws/request.Request" representing the +// client's request for the DeleteManagedEndpoint operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See DeleteManagedEndpoint for more information on using the DeleteManagedEndpoint +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the DeleteManagedEndpointRequest method. +// req, resp := client.DeleteManagedEndpointRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/emr-containers-2020-10-01/DeleteManagedEndpoint +func (c *EMRContainers) DeleteManagedEndpointRequest(input *DeleteManagedEndpointInput) (req *request.Request, output *DeleteManagedEndpointOutput) { + op := &request.Operation{ + Name: opDeleteManagedEndpoint, + HTTPMethod: "DELETE", + HTTPPath: "/virtualclusters/{virtualClusterId}/endpoints/{endpointId}", + } + + if input == nil { + input = &DeleteManagedEndpointInput{} + } + + output = &DeleteManagedEndpointOutput{} + req = c.newRequest(op, input, output) + return +} + +// DeleteManagedEndpoint API operation for Amazon EMR Containers. +// +// Deletes a managed endpoint. A managed endpoint is a gateway that connects +// EMR Studio to Amazon EMR on EKS so that EMR Studio can communicate with your +// virtual cluster. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon EMR Containers's +// API operation DeleteManagedEndpoint for usage and error information. +// +// Returned Error Types: +// * ValidationException +// There are invalid parameters in the client request. +// +// * InternalServerException +// This is an internal server exception. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/emr-containers-2020-10-01/DeleteManagedEndpoint +func (c *EMRContainers) DeleteManagedEndpoint(input *DeleteManagedEndpointInput) (*DeleteManagedEndpointOutput, error) { + req, out := c.DeleteManagedEndpointRequest(input) + return out, req.Send() +} + +// DeleteManagedEndpointWithContext is the same as DeleteManagedEndpoint with the addition of +// the ability to pass a context and additional request options. +// +// See DeleteManagedEndpoint for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *EMRContainers) DeleteManagedEndpointWithContext(ctx aws.Context, input *DeleteManagedEndpointInput, opts ...request.Option) (*DeleteManagedEndpointOutput, error) { + req, out := c.DeleteManagedEndpointRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opDeleteVirtualCluster = "DeleteVirtualCluster" + +// DeleteVirtualClusterRequest generates a "aws/request.Request" representing the +// client's request for the DeleteVirtualCluster operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See DeleteVirtualCluster for more information on using the DeleteVirtualCluster +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the DeleteVirtualClusterRequest method. +// req, resp := client.DeleteVirtualClusterRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/emr-containers-2020-10-01/DeleteVirtualCluster +func (c *EMRContainers) DeleteVirtualClusterRequest(input *DeleteVirtualClusterInput) (req *request.Request, output *DeleteVirtualClusterOutput) { + op := &request.Operation{ + Name: opDeleteVirtualCluster, + HTTPMethod: "DELETE", + HTTPPath: "/virtualclusters/{virtualClusterId}", + } + + if input == nil { + input = &DeleteVirtualClusterInput{} + } + + output = &DeleteVirtualClusterOutput{} + req = c.newRequest(op, input, output) + return +} + +// DeleteVirtualCluster API operation for Amazon EMR Containers. +// +// Deletes a virtual cluster. Virtual cluster is a managed entity on Amazon +// EMR on EKS. You can create, describe, list and delete virtual clusters. They +// do not consume any additional resource in your system. A single virtual cluster +// maps to a single Kubernetes namespace. Given this relationship, you can model +// virtual clusters the same way you model Kubernetes namespaces to meet your +// requirements. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon EMR Containers's +// API operation DeleteVirtualCluster for usage and error information. +// +// Returned Error Types: +// * ValidationException +// There are invalid parameters in the client request. +// +// * InternalServerException +// This is an internal server exception. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/emr-containers-2020-10-01/DeleteVirtualCluster +func (c *EMRContainers) DeleteVirtualCluster(input *DeleteVirtualClusterInput) (*DeleteVirtualClusterOutput, error) { + req, out := c.DeleteVirtualClusterRequest(input) + return out, req.Send() +} + +// DeleteVirtualClusterWithContext is the same as DeleteVirtualCluster with the addition of +// the ability to pass a context and additional request options. +// +// See DeleteVirtualCluster for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *EMRContainers) DeleteVirtualClusterWithContext(ctx aws.Context, input *DeleteVirtualClusterInput, opts ...request.Option) (*DeleteVirtualClusterOutput, error) { + req, out := c.DeleteVirtualClusterRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opDescribeJobRun = "DescribeJobRun" + +// DescribeJobRunRequest generates a "aws/request.Request" representing the +// client's request for the DescribeJobRun operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See DescribeJobRun for more information on using the DescribeJobRun +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the DescribeJobRunRequest method. +// req, resp := client.DescribeJobRunRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/emr-containers-2020-10-01/DescribeJobRun +func (c *EMRContainers) DescribeJobRunRequest(input *DescribeJobRunInput) (req *request.Request, output *DescribeJobRunOutput) { + op := &request.Operation{ + Name: opDescribeJobRun, + HTTPMethod: "GET", + HTTPPath: "/virtualclusters/{virtualClusterId}/jobruns/{jobRunId}", + } + + if input == nil { + input = &DescribeJobRunInput{} + } + + output = &DescribeJobRunOutput{} + req = c.newRequest(op, input, output) + return +} + +// DescribeJobRun API operation for Amazon EMR Containers. +// +// Displays detailed information about a job run. A job run is a unit of work, +// such as a Spark jar, PySpark script, or SparkSQL query, that you submit to +// Amazon EMR on EKS. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon EMR Containers's +// API operation DescribeJobRun for usage and error information. +// +// Returned Error Types: +// * ValidationException +// There are invalid parameters in the client request. +// +// * ResourceNotFoundException +// The specified resource was not found. +// +// * InternalServerException +// This is an internal server exception. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/emr-containers-2020-10-01/DescribeJobRun +func (c *EMRContainers) DescribeJobRun(input *DescribeJobRunInput) (*DescribeJobRunOutput, error) { + req, out := c.DescribeJobRunRequest(input) + return out, req.Send() +} + +// DescribeJobRunWithContext is the same as DescribeJobRun with the addition of +// the ability to pass a context and additional request options. +// +// See DescribeJobRun for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *EMRContainers) DescribeJobRunWithContext(ctx aws.Context, input *DescribeJobRunInput, opts ...request.Option) (*DescribeJobRunOutput, error) { + req, out := c.DescribeJobRunRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opDescribeManagedEndpoint = "DescribeManagedEndpoint" + +// DescribeManagedEndpointRequest generates a "aws/request.Request" representing the +// client's request for the DescribeManagedEndpoint operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See DescribeManagedEndpoint for more information on using the DescribeManagedEndpoint +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the DescribeManagedEndpointRequest method. +// req, resp := client.DescribeManagedEndpointRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/emr-containers-2020-10-01/DescribeManagedEndpoint +func (c *EMRContainers) DescribeManagedEndpointRequest(input *DescribeManagedEndpointInput) (req *request.Request, output *DescribeManagedEndpointOutput) { + op := &request.Operation{ + Name: opDescribeManagedEndpoint, + HTTPMethod: "GET", + HTTPPath: "/virtualclusters/{virtualClusterId}/endpoints/{endpointId}", + } + + if input == nil { + input = &DescribeManagedEndpointInput{} + } + + output = &DescribeManagedEndpointOutput{} + req = c.newRequest(op, input, output) + return +} + +// DescribeManagedEndpoint API operation for Amazon EMR Containers. +// +// Displays detailed information about a managed endpoint. A managed endpoint +// is a gateway that connects EMR Studio to Amazon EMR on EKS so that EMR Studio +// can communicate with your virtual cluster. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon EMR Containers's +// API operation DescribeManagedEndpoint for usage and error information. +// +// Returned Error Types: +// * ValidationException +// There are invalid parameters in the client request. +// +// * ResourceNotFoundException +// The specified resource was not found. +// +// * InternalServerException +// This is an internal server exception. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/emr-containers-2020-10-01/DescribeManagedEndpoint +func (c *EMRContainers) DescribeManagedEndpoint(input *DescribeManagedEndpointInput) (*DescribeManagedEndpointOutput, error) { + req, out := c.DescribeManagedEndpointRequest(input) + return out, req.Send() +} + +// DescribeManagedEndpointWithContext is the same as DescribeManagedEndpoint with the addition of +// the ability to pass a context and additional request options. +// +// See DescribeManagedEndpoint for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *EMRContainers) DescribeManagedEndpointWithContext(ctx aws.Context, input *DescribeManagedEndpointInput, opts ...request.Option) (*DescribeManagedEndpointOutput, error) { + req, out := c.DescribeManagedEndpointRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opDescribeVirtualCluster = "DescribeVirtualCluster" + +// DescribeVirtualClusterRequest generates a "aws/request.Request" representing the +// client's request for the DescribeVirtualCluster operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See DescribeVirtualCluster for more information on using the DescribeVirtualCluster +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the DescribeVirtualClusterRequest method. +// req, resp := client.DescribeVirtualClusterRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/emr-containers-2020-10-01/DescribeVirtualCluster +func (c *EMRContainers) DescribeVirtualClusterRequest(input *DescribeVirtualClusterInput) (req *request.Request, output *DescribeVirtualClusterOutput) { + op := &request.Operation{ + Name: opDescribeVirtualCluster, + HTTPMethod: "GET", + HTTPPath: "/virtualclusters/{virtualClusterId}", + } + + if input == nil { + input = &DescribeVirtualClusterInput{} + } + + output = &DescribeVirtualClusterOutput{} + req = c.newRequest(op, input, output) + return +} + +// DescribeVirtualCluster API operation for Amazon EMR Containers. +// +// Displays detailed information about a specified virtual cluster. Virtual +// cluster is a managed entity on Amazon EMR on EKS. You can create, describe, +// list and delete virtual clusters. They do not consume any additional resource +// in your system. A single virtual cluster maps to a single Kubernetes namespace. +// Given this relationship, you can model virtual clusters the same way you +// model Kubernetes namespaces to meet your requirements. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon EMR Containers's +// API operation DescribeVirtualCluster for usage and error information. +// +// Returned Error Types: +// * ValidationException +// There are invalid parameters in the client request. +// +// * ResourceNotFoundException +// The specified resource was not found. +// +// * InternalServerException +// This is an internal server exception. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/emr-containers-2020-10-01/DescribeVirtualCluster +func (c *EMRContainers) DescribeVirtualCluster(input *DescribeVirtualClusterInput) (*DescribeVirtualClusterOutput, error) { + req, out := c.DescribeVirtualClusterRequest(input) + return out, req.Send() +} + +// DescribeVirtualClusterWithContext is the same as DescribeVirtualCluster with the addition of +// the ability to pass a context and additional request options. +// +// See DescribeVirtualCluster for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *EMRContainers) DescribeVirtualClusterWithContext(ctx aws.Context, input *DescribeVirtualClusterInput, opts ...request.Option) (*DescribeVirtualClusterOutput, error) { + req, out := c.DescribeVirtualClusterRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opListJobRuns = "ListJobRuns" + +// ListJobRunsRequest generates a "aws/request.Request" representing the +// client's request for the ListJobRuns operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See ListJobRuns for more information on using the ListJobRuns +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the ListJobRunsRequest method. +// req, resp := client.ListJobRunsRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/emr-containers-2020-10-01/ListJobRuns +func (c *EMRContainers) ListJobRunsRequest(input *ListJobRunsInput) (req *request.Request, output *ListJobRunsOutput) { + op := &request.Operation{ + Name: opListJobRuns, + HTTPMethod: "GET", + HTTPPath: "/virtualclusters/{virtualClusterId}/jobruns", + Paginator: &request.Paginator{ + InputTokens: []string{"nextToken"}, + OutputTokens: []string{"nextToken"}, + LimitToken: "maxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &ListJobRunsInput{} + } + + output = &ListJobRunsOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListJobRuns API operation for Amazon EMR Containers. +// +// Lists job runs based on a set of parameters. A job run is a unit of work, +// such as a Spark jar, PySpark script, or SparkSQL query, that you submit to +// Amazon EMR on EKS. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon EMR Containers's +// API operation ListJobRuns for usage and error information. +// +// Returned Error Types: +// * ValidationException +// There are invalid parameters in the client request. +// +// * InternalServerException +// This is an internal server exception. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/emr-containers-2020-10-01/ListJobRuns +func (c *EMRContainers) ListJobRuns(input *ListJobRunsInput) (*ListJobRunsOutput, error) { + req, out := c.ListJobRunsRequest(input) + return out, req.Send() +} + +// ListJobRunsWithContext is the same as ListJobRuns with the addition of +// the ability to pass a context and additional request options. +// +// See ListJobRuns for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *EMRContainers) ListJobRunsWithContext(ctx aws.Context, input *ListJobRunsInput, opts ...request.Option) (*ListJobRunsOutput, error) { + req, out := c.ListJobRunsRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// ListJobRunsPages iterates over the pages of a ListJobRuns operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListJobRuns method for more information on how to use this operation. +// +// Note: This operation can generate multiple requests to a service. +// +// // Example iterating over at most 3 pages of a ListJobRuns operation. +// pageNum := 0 +// err := client.ListJobRunsPages(params, +// func(page *emrcontainers.ListJobRunsOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *EMRContainers) ListJobRunsPages(input *ListJobRunsInput, fn func(*ListJobRunsOutput, bool) bool) error { + return c.ListJobRunsPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// ListJobRunsPagesWithContext same as ListJobRunsPages except +// it takes a Context and allows setting request options on the pages. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *EMRContainers) ListJobRunsPagesWithContext(ctx aws.Context, input *ListJobRunsInput, fn func(*ListJobRunsOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListJobRunsInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListJobRunsRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListJobRunsOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + +const opListManagedEndpoints = "ListManagedEndpoints" + +// ListManagedEndpointsRequest generates a "aws/request.Request" representing the +// client's request for the ListManagedEndpoints operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See ListManagedEndpoints for more information on using the ListManagedEndpoints +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the ListManagedEndpointsRequest method. +// req, resp := client.ListManagedEndpointsRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/emr-containers-2020-10-01/ListManagedEndpoints +func (c *EMRContainers) ListManagedEndpointsRequest(input *ListManagedEndpointsInput) (req *request.Request, output *ListManagedEndpointsOutput) { + op := &request.Operation{ + Name: opListManagedEndpoints, + HTTPMethod: "GET", + HTTPPath: "/virtualclusters/{virtualClusterId}/endpoints", + Paginator: &request.Paginator{ + InputTokens: []string{"nextToken"}, + OutputTokens: []string{"nextToken"}, + LimitToken: "maxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &ListManagedEndpointsInput{} + } + + output = &ListManagedEndpointsOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListManagedEndpoints API operation for Amazon EMR Containers. +// +// Lists managed endpoints based on a set of parameters. A managed endpoint +// is a gateway that connects EMR Studio to Amazon EMR on EKS so that EMR Studio +// can communicate with your virtual cluster. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon EMR Containers's +// API operation ListManagedEndpoints for usage and error information. +// +// Returned Error Types: +// * ValidationException +// There are invalid parameters in the client request. +// +// * InternalServerException +// This is an internal server exception. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/emr-containers-2020-10-01/ListManagedEndpoints +func (c *EMRContainers) ListManagedEndpoints(input *ListManagedEndpointsInput) (*ListManagedEndpointsOutput, error) { + req, out := c.ListManagedEndpointsRequest(input) + return out, req.Send() +} + +// ListManagedEndpointsWithContext is the same as ListManagedEndpoints with the addition of +// the ability to pass a context and additional request options. +// +// See ListManagedEndpoints for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *EMRContainers) ListManagedEndpointsWithContext(ctx aws.Context, input *ListManagedEndpointsInput, opts ...request.Option) (*ListManagedEndpointsOutput, error) { + req, out := c.ListManagedEndpointsRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// ListManagedEndpointsPages iterates over the pages of a ListManagedEndpoints operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListManagedEndpoints method for more information on how to use this operation. +// +// Note: This operation can generate multiple requests to a service. +// +// // Example iterating over at most 3 pages of a ListManagedEndpoints operation. +// pageNum := 0 +// err := client.ListManagedEndpointsPages(params, +// func(page *emrcontainers.ListManagedEndpointsOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *EMRContainers) ListManagedEndpointsPages(input *ListManagedEndpointsInput, fn func(*ListManagedEndpointsOutput, bool) bool) error { + return c.ListManagedEndpointsPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// ListManagedEndpointsPagesWithContext same as ListManagedEndpointsPages except +// it takes a Context and allows setting request options on the pages. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *EMRContainers) ListManagedEndpointsPagesWithContext(ctx aws.Context, input *ListManagedEndpointsInput, fn func(*ListManagedEndpointsOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListManagedEndpointsInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListManagedEndpointsRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListManagedEndpointsOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + +const opListTagsForResource = "ListTagsForResource" + +// ListTagsForResourceRequest generates a "aws/request.Request" representing the +// client's request for the ListTagsForResource operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See ListTagsForResource for more information on using the ListTagsForResource +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the ListTagsForResourceRequest method. +// req, resp := client.ListTagsForResourceRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/emr-containers-2020-10-01/ListTagsForResource +func (c *EMRContainers) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput) { + op := &request.Operation{ + Name: opListTagsForResource, + HTTPMethod: "GET", + HTTPPath: "/tags/{resourceArn}", + } + + if input == nil { + input = &ListTagsForResourceInput{} + } + + output = &ListTagsForResourceOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListTagsForResource API operation for Amazon EMR Containers. +// +// Lists the tags assigned to the resources. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon EMR Containers's +// API operation ListTagsForResource for usage and error information. +// +// Returned Error Types: +// * InternalServerException +// This is an internal server exception. +// +// * ValidationException +// There are invalid parameters in the client request. +// +// * ResourceNotFoundException +// The specified resource was not found. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/emr-containers-2020-10-01/ListTagsForResource +func (c *EMRContainers) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error) { + req, out := c.ListTagsForResourceRequest(input) + return out, req.Send() +} + +// ListTagsForResourceWithContext is the same as ListTagsForResource with the addition of +// the ability to pass a context and additional request options. +// +// See ListTagsForResource for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *EMRContainers) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error) { + req, out := c.ListTagsForResourceRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opListVirtualClusters = "ListVirtualClusters" + +// ListVirtualClustersRequest generates a "aws/request.Request" representing the +// client's request for the ListVirtualClusters operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See ListVirtualClusters for more information on using the ListVirtualClusters +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the ListVirtualClustersRequest method. +// req, resp := client.ListVirtualClustersRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/emr-containers-2020-10-01/ListVirtualClusters +func (c *EMRContainers) ListVirtualClustersRequest(input *ListVirtualClustersInput) (req *request.Request, output *ListVirtualClustersOutput) { + op := &request.Operation{ + Name: opListVirtualClusters, + HTTPMethod: "GET", + HTTPPath: "/virtualclusters", + Paginator: &request.Paginator{ + InputTokens: []string{"nextToken"}, + OutputTokens: []string{"nextToken"}, + LimitToken: "maxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &ListVirtualClustersInput{} + } + + output = &ListVirtualClustersOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListVirtualClusters API operation for Amazon EMR Containers. +// +// Lists information about the specified virtual cluster. Virtual cluster is +// a managed entity on Amazon EMR on EKS. You can create, describe, list and +// delete virtual clusters. They do not consume any additional resource in your +// system. A single virtual cluster maps to a single Kubernetes namespace. Given +// this relationship, you can model virtual clusters the same way you model +// Kubernetes namespaces to meet your requirements. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon EMR Containers's +// API operation ListVirtualClusters for usage and error information. +// +// Returned Error Types: +// * ValidationException +// There are invalid parameters in the client request. +// +// * InternalServerException +// This is an internal server exception. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/emr-containers-2020-10-01/ListVirtualClusters +func (c *EMRContainers) ListVirtualClusters(input *ListVirtualClustersInput) (*ListVirtualClustersOutput, error) { + req, out := c.ListVirtualClustersRequest(input) + return out, req.Send() +} + +// ListVirtualClustersWithContext is the same as ListVirtualClusters with the addition of +// the ability to pass a context and additional request options. +// +// See ListVirtualClusters for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *EMRContainers) ListVirtualClustersWithContext(ctx aws.Context, input *ListVirtualClustersInput, opts ...request.Option) (*ListVirtualClustersOutput, error) { + req, out := c.ListVirtualClustersRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// ListVirtualClustersPages iterates over the pages of a ListVirtualClusters operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListVirtualClusters method for more information on how to use this operation. +// +// Note: This operation can generate multiple requests to a service. +// +// // Example iterating over at most 3 pages of a ListVirtualClusters operation. +// pageNum := 0 +// err := client.ListVirtualClustersPages(params, +// func(page *emrcontainers.ListVirtualClustersOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *EMRContainers) ListVirtualClustersPages(input *ListVirtualClustersInput, fn func(*ListVirtualClustersOutput, bool) bool) error { + return c.ListVirtualClustersPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// ListVirtualClustersPagesWithContext same as ListVirtualClustersPages except +// it takes a Context and allows setting request options on the pages. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *EMRContainers) ListVirtualClustersPagesWithContext(ctx aws.Context, input *ListVirtualClustersInput, fn func(*ListVirtualClustersOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListVirtualClustersInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListVirtualClustersRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListVirtualClustersOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + +const opStartJobRun = "StartJobRun" + +// StartJobRunRequest generates a "aws/request.Request" representing the +// client's request for the StartJobRun operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See StartJobRun for more information on using the StartJobRun +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the StartJobRunRequest method. +// req, resp := client.StartJobRunRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/emr-containers-2020-10-01/StartJobRun +func (c *EMRContainers) StartJobRunRequest(input *StartJobRunInput) (req *request.Request, output *StartJobRunOutput) { + op := &request.Operation{ + Name: opStartJobRun, + HTTPMethod: "POST", + HTTPPath: "/virtualclusters/{virtualClusterId}/jobruns", + } + + if input == nil { + input = &StartJobRunInput{} + } + + output = &StartJobRunOutput{} + req = c.newRequest(op, input, output) + return +} + +// StartJobRun API operation for Amazon EMR Containers. +// +// Starts a job run. A job run is a unit of work, such as a Spark jar, PySpark +// script, or SparkSQL query, that you submit to Amazon EMR on EKS. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon EMR Containers's +// API operation StartJobRun for usage and error information. +// +// Returned Error Types: +// * ValidationException +// There are invalid parameters in the client request. +// +// * ResourceNotFoundException +// The specified resource was not found. +// +// * InternalServerException +// This is an internal server exception. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/emr-containers-2020-10-01/StartJobRun +func (c *EMRContainers) StartJobRun(input *StartJobRunInput) (*StartJobRunOutput, error) { + req, out := c.StartJobRunRequest(input) + return out, req.Send() +} + +// StartJobRunWithContext is the same as StartJobRun with the addition of +// the ability to pass a context and additional request options. +// +// See StartJobRun for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *EMRContainers) StartJobRunWithContext(ctx aws.Context, input *StartJobRunInput, opts ...request.Option) (*StartJobRunOutput, error) { + req, out := c.StartJobRunRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opTagResource = "TagResource" + +// TagResourceRequest generates a "aws/request.Request" representing the +// client's request for the TagResource operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See TagResource for more information on using the TagResource +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the TagResourceRequest method. +// req, resp := client.TagResourceRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/emr-containers-2020-10-01/TagResource +func (c *EMRContainers) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput) { + op := &request.Operation{ + Name: opTagResource, + HTTPMethod: "POST", + HTTPPath: "/tags/{resourceArn}", + } + + if input == nil { + input = &TagResourceInput{} + } + + output = &TagResourceOutput{} + req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(restjson.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) + return +} + +// TagResource API operation for Amazon EMR Containers. +// +// Assigns tags to resources. A tag is a label that you assign to an AWS resource. +// Each tag consists of a key and an optional value, both of which you define. +// Tags enable you to categorize your AWS resources by attributes such as purpose, +// owner, or environment. When you have many resources of the same type, you +// can quickly identify a specific resource based on the tags you've assigned +// to it. For example, you can define a set of tags for your Amazon EMR on EKS +// clusters to help you track each cluster's owner and stack level. We recommend +// that you devise a consistent set of tag keys for each resource type. You +// can then search and filter the resources based on the tags that you add. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon EMR Containers's +// API operation TagResource for usage and error information. +// +// Returned Error Types: +// * InternalServerException +// This is an internal server exception. +// +// * ValidationException +// There are invalid parameters in the client request. +// +// * ResourceNotFoundException +// The specified resource was not found. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/emr-containers-2020-10-01/TagResource +func (c *EMRContainers) TagResource(input *TagResourceInput) (*TagResourceOutput, error) { + req, out := c.TagResourceRequest(input) + return out, req.Send() +} + +// TagResourceWithContext is the same as TagResource with the addition of +// the ability to pass a context and additional request options. +// +// See TagResource for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *EMRContainers) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error) { + req, out := c.TagResourceRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opUntagResource = "UntagResource" + +// UntagResourceRequest generates a "aws/request.Request" representing the +// client's request for the UntagResource operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See UntagResource for more information on using the UntagResource +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the UntagResourceRequest method. +// req, resp := client.UntagResourceRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/emr-containers-2020-10-01/UntagResource +func (c *EMRContainers) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput) { + op := &request.Operation{ + Name: opUntagResource, + HTTPMethod: "DELETE", + HTTPPath: "/tags/{resourceArn}", + } + + if input == nil { + input = &UntagResourceInput{} + } + + output = &UntagResourceOutput{} + req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(restjson.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) + return +} + +// UntagResource API operation for Amazon EMR Containers. +// +// Removes tags from resources. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon EMR Containers's +// API operation UntagResource for usage and error information. +// +// Returned Error Types: +// * InternalServerException +// This is an internal server exception. +// +// * ValidationException +// There are invalid parameters in the client request. +// +// * ResourceNotFoundException +// The specified resource was not found. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/emr-containers-2020-10-01/UntagResource +func (c *EMRContainers) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error) { + req, out := c.UntagResourceRequest(input) + return out, req.Send() +} + +// UntagResourceWithContext is the same as UntagResource with the addition of +// the ability to pass a context and additional request options. +// +// See UntagResource for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *EMRContainers) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error) { + req, out := c.UntagResourceRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +type CancelJobRunInput struct { + _ struct{} `type:"structure"` + + // The ID of the job run to cancel. + // + // Id is a required field + Id *string `location:"uri" locationName:"jobRunId" min:"1" type:"string" required:"true"` + + // The ID of the virtual cluster for which the job run will be canceled. + // + // VirtualClusterId is a required field + VirtualClusterId *string `location:"uri" locationName:"virtualClusterId" min:"1" type:"string" required:"true"` +} + +// String returns the string representation +func (s CancelJobRunInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s CancelJobRunInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CancelJobRunInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CancelJobRunInput"} + if s.Id == nil { + invalidParams.Add(request.NewErrParamRequired("Id")) + } + if s.Id != nil && len(*s.Id) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Id", 1)) + } + if s.VirtualClusterId == nil { + invalidParams.Add(request.NewErrParamRequired("VirtualClusterId")) + } + if s.VirtualClusterId != nil && len(*s.VirtualClusterId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("VirtualClusterId", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetId sets the Id field's value. +func (s *CancelJobRunInput) SetId(v string) *CancelJobRunInput { + s.Id = &v + return s +} + +// SetVirtualClusterId sets the VirtualClusterId field's value. +func (s *CancelJobRunInput) SetVirtualClusterId(v string) *CancelJobRunInput { + s.VirtualClusterId = &v + return s +} + +type CancelJobRunOutput struct { + _ struct{} `type:"structure"` + + // The output contains the ID of the cancelled job run. + Id *string `locationName:"id" min:"1" type:"string"` + + // The output contains the virtual cluster ID for which the job run is cancelled. + VirtualClusterId *string `locationName:"virtualClusterId" min:"1" type:"string"` +} + +// String returns the string representation +func (s CancelJobRunOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s CancelJobRunOutput) GoString() string { + return s.String() +} + +// SetId sets the Id field's value. +func (s *CancelJobRunOutput) SetId(v string) *CancelJobRunOutput { + s.Id = &v + return s +} + +// SetVirtualClusterId sets the VirtualClusterId field's value. +func (s *CancelJobRunOutput) SetVirtualClusterId(v string) *CancelJobRunOutput { + s.VirtualClusterId = &v + return s +} + +// A configuration for CloudWatch monitoring. You can configure your jobs to +// send log information to CloudWatch Logs. +type CloudWatchMonitoringConfiguration struct { + _ struct{} `type:"structure"` + + // The name of the log group for log publishing. + // + // LogGroupName is a required field + LogGroupName *string `locationName:"logGroupName" min:"1" type:"string" required:"true"` + + // The specified name prefix for log streams. + LogStreamNamePrefix *string `locationName:"logStreamNamePrefix" min:"1" type:"string"` +} + +// String returns the string representation +func (s CloudWatchMonitoringConfiguration) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s CloudWatchMonitoringConfiguration) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CloudWatchMonitoringConfiguration) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CloudWatchMonitoringConfiguration"} + if s.LogGroupName == nil { + invalidParams.Add(request.NewErrParamRequired("LogGroupName")) + } + if s.LogGroupName != nil && len(*s.LogGroupName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("LogGroupName", 1)) + } + if s.LogStreamNamePrefix != nil && len(*s.LogStreamNamePrefix) < 1 { + invalidParams.Add(request.NewErrParamMinLen("LogStreamNamePrefix", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetLogGroupName sets the LogGroupName field's value. +func (s *CloudWatchMonitoringConfiguration) SetLogGroupName(v string) *CloudWatchMonitoringConfiguration { + s.LogGroupName = &v + return s +} + +// SetLogStreamNamePrefix sets the LogStreamNamePrefix field's value. +func (s *CloudWatchMonitoringConfiguration) SetLogStreamNamePrefix(v string) *CloudWatchMonitoringConfiguration { + s.LogStreamNamePrefix = &v + return s +} + +// A configuration specification to be used when provisioning virtual clusters, +// which can include configurations for applications and software bundled with +// Amazon EMR on EKS. A configuration consists of a classification, properties, +// and optional nested configurations. A classification refers to an application-specific +// configuration file. Properties are the settings you want to change in that +// file. +type Configuration struct { + _ struct{} `type:"structure"` + + // The classification within a configuration. + // + // Classification is a required field + Classification *string `locationName:"classification" min:"1" type:"string" required:"true"` + + // A list of additional configurations to apply within a configuration object. + Configurations []*Configuration `locationName:"configurations" type:"list"` + + // A set of properties specified within a configuration classification. + Properties map[string]*string `locationName:"properties" type:"map" sensitive:"true"` +} + +// String returns the string representation +func (s Configuration) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s Configuration) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *Configuration) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "Configuration"} + if s.Classification == nil { + invalidParams.Add(request.NewErrParamRequired("Classification")) + } + if s.Classification != nil && len(*s.Classification) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Classification", 1)) + } + if s.Configurations != nil { + for i, v := range s.Configurations { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Configurations", i), err.(request.ErrInvalidParams)) + } + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetClassification sets the Classification field's value. +func (s *Configuration) SetClassification(v string) *Configuration { + s.Classification = &v + return s +} + +// SetConfigurations sets the Configurations field's value. +func (s *Configuration) SetConfigurations(v []*Configuration) *Configuration { + s.Configurations = v + return s +} + +// SetProperties sets the Properties field's value. +func (s *Configuration) SetProperties(v map[string]*string) *Configuration { + s.Properties = v + return s +} + +// A configuration specification to be used to override existing configurations. +type ConfigurationOverrides struct { + _ struct{} `type:"structure"` + + // The configurations for the application running by the job run. + ApplicationConfiguration []*Configuration `locationName:"applicationConfiguration" type:"list"` + + // The configurations for monitoring. + MonitoringConfiguration *MonitoringConfiguration `locationName:"monitoringConfiguration" type:"structure"` +} + +// String returns the string representation +func (s ConfigurationOverrides) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s ConfigurationOverrides) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ConfigurationOverrides) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ConfigurationOverrides"} + if s.ApplicationConfiguration != nil { + for i, v := range s.ApplicationConfiguration { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "ApplicationConfiguration", i), err.(request.ErrInvalidParams)) + } + } + } + if s.MonitoringConfiguration != nil { + if err := s.MonitoringConfiguration.Validate(); err != nil { + invalidParams.AddNested("MonitoringConfiguration", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetApplicationConfiguration sets the ApplicationConfiguration field's value. +func (s *ConfigurationOverrides) SetApplicationConfiguration(v []*Configuration) *ConfigurationOverrides { + s.ApplicationConfiguration = v + return s +} + +// SetMonitoringConfiguration sets the MonitoringConfiguration field's value. +func (s *ConfigurationOverrides) SetMonitoringConfiguration(v *MonitoringConfiguration) *ConfigurationOverrides { + s.MonitoringConfiguration = v + return s +} + +// The information about the container used for a job run or a managed endpoint. +type ContainerInfo struct { + _ struct{} `type:"structure"` + + // The information about the EKS cluster. + EksInfo *EksInfo `locationName:"eksInfo" type:"structure"` +} + +// String returns the string representation +func (s ContainerInfo) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s ContainerInfo) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ContainerInfo) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ContainerInfo"} + if s.EksInfo != nil { + if err := s.EksInfo.Validate(); err != nil { + invalidParams.AddNested("EksInfo", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetEksInfo sets the EksInfo field's value. +func (s *ContainerInfo) SetEksInfo(v *EksInfo) *ContainerInfo { + s.EksInfo = v + return s +} + +// The information about the container provider. +type ContainerProvider struct { + _ struct{} `type:"structure"` + + // The ID of the container cluster. + // + // Id is a required field + Id *string `locationName:"id" min:"1" type:"string" required:"true"` + + // The information about the container cluster. + Info *ContainerInfo `locationName:"info" type:"structure"` + + // The type of the container provider. EKS is the only supported type as of + // now. + // + // Type is a required field + Type *string `locationName:"type" type:"string" required:"true" enum:"ContainerProviderType"` +} + +// String returns the string representation +func (s ContainerProvider) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s ContainerProvider) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ContainerProvider) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ContainerProvider"} + if s.Id == nil { + invalidParams.Add(request.NewErrParamRequired("Id")) + } + if s.Id != nil && len(*s.Id) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Id", 1)) + } + if s.Type == nil { + invalidParams.Add(request.NewErrParamRequired("Type")) + } + if s.Info != nil { + if err := s.Info.Validate(); err != nil { + invalidParams.AddNested("Info", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetId sets the Id field's value. +func (s *ContainerProvider) SetId(v string) *ContainerProvider { + s.Id = &v + return s +} + +// SetInfo sets the Info field's value. +func (s *ContainerProvider) SetInfo(v *ContainerInfo) *ContainerProvider { + s.Info = v + return s +} + +// SetType sets the Type field's value. +func (s *ContainerProvider) SetType(v string) *ContainerProvider { + s.Type = &v + return s +} + +type CreateManagedEndpointInput struct { + _ struct{} `type:"structure"` + + // The certificate ARN of the managed endpoint. + // + // CertificateArn is a required field + CertificateArn *string `locationName:"certificateArn" min:"44" type:"string" required:"true"` + + // The client idempotency token for this create call. + ClientToken *string `locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"` + + // The configuration settings that will be used to override existing configurations. + ConfigurationOverrides *ConfigurationOverrides `locationName:"configurationOverrides" type:"structure"` + + // The ARN of the execution role. + // + // ExecutionRoleArn is a required field + ExecutionRoleArn *string `locationName:"executionRoleArn" min:"20" type:"string" required:"true"` + + // The name of the managed endpoint. + // + // Name is a required field + Name *string `locationName:"name" min:"1" type:"string" required:"true"` + + // The Amazon EMR release version. + // + // ReleaseLabel is a required field + ReleaseLabel *string `locationName:"releaseLabel" min:"1" type:"string" required:"true"` + + // The tags of the managed endpoint. + Tags map[string]*string `locationName:"tags" type:"map"` + + // The type of the managed endpoint. + // + // Type is a required field + Type *string `locationName:"type" min:"1" type:"string" required:"true"` + + // The ID of the virtual cluster for which a managed endpoint is created. + // + // VirtualClusterId is a required field + VirtualClusterId *string `location:"uri" locationName:"virtualClusterId" min:"1" type:"string" required:"true"` +} + +// String returns the string representation +func (s CreateManagedEndpointInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s CreateManagedEndpointInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CreateManagedEndpointInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreateManagedEndpointInput"} + if s.CertificateArn == nil { + invalidParams.Add(request.NewErrParamRequired("CertificateArn")) + } + if s.CertificateArn != nil && len(*s.CertificateArn) < 44 { + invalidParams.Add(request.NewErrParamMinLen("CertificateArn", 44)) + } + if s.ClientToken != nil && len(*s.ClientToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ClientToken", 1)) + } + if s.ExecutionRoleArn == nil { + invalidParams.Add(request.NewErrParamRequired("ExecutionRoleArn")) + } + if s.ExecutionRoleArn != nil && len(*s.ExecutionRoleArn) < 20 { + invalidParams.Add(request.NewErrParamMinLen("ExecutionRoleArn", 20)) + } + if s.Name == nil { + invalidParams.Add(request.NewErrParamRequired("Name")) + } + if s.Name != nil && len(*s.Name) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Name", 1)) + } + if s.ReleaseLabel == nil { + invalidParams.Add(request.NewErrParamRequired("ReleaseLabel")) + } + if s.ReleaseLabel != nil && len(*s.ReleaseLabel) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ReleaseLabel", 1)) + } + if s.Type == nil { + invalidParams.Add(request.NewErrParamRequired("Type")) + } + if s.Type != nil && len(*s.Type) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Type", 1)) + } + if s.VirtualClusterId == nil { + invalidParams.Add(request.NewErrParamRequired("VirtualClusterId")) + } + if s.VirtualClusterId != nil && len(*s.VirtualClusterId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("VirtualClusterId", 1)) + } + if s.ConfigurationOverrides != nil { + if err := s.ConfigurationOverrides.Validate(); err != nil { + invalidParams.AddNested("ConfigurationOverrides", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetCertificateArn sets the CertificateArn field's value. +func (s *CreateManagedEndpointInput) SetCertificateArn(v string) *CreateManagedEndpointInput { + s.CertificateArn = &v + return s +} + +// SetClientToken sets the ClientToken field's value. +func (s *CreateManagedEndpointInput) SetClientToken(v string) *CreateManagedEndpointInput { + s.ClientToken = &v + return s +} + +// SetConfigurationOverrides sets the ConfigurationOverrides field's value. +func (s *CreateManagedEndpointInput) SetConfigurationOverrides(v *ConfigurationOverrides) *CreateManagedEndpointInput { + s.ConfigurationOverrides = v + return s +} + +// SetExecutionRoleArn sets the ExecutionRoleArn field's value. +func (s *CreateManagedEndpointInput) SetExecutionRoleArn(v string) *CreateManagedEndpointInput { + s.ExecutionRoleArn = &v + return s +} + +// SetName sets the Name field's value. +func (s *CreateManagedEndpointInput) SetName(v string) *CreateManagedEndpointInput { + s.Name = &v + return s +} + +// SetReleaseLabel sets the ReleaseLabel field's value. +func (s *CreateManagedEndpointInput) SetReleaseLabel(v string) *CreateManagedEndpointInput { + s.ReleaseLabel = &v + return s +} + +// SetTags sets the Tags field's value. +func (s *CreateManagedEndpointInput) SetTags(v map[string]*string) *CreateManagedEndpointInput { + s.Tags = v + return s +} + +// SetType sets the Type field's value. +func (s *CreateManagedEndpointInput) SetType(v string) *CreateManagedEndpointInput { + s.Type = &v + return s +} + +// SetVirtualClusterId sets the VirtualClusterId field's value. +func (s *CreateManagedEndpointInput) SetVirtualClusterId(v string) *CreateManagedEndpointInput { + s.VirtualClusterId = &v + return s +} + +type CreateManagedEndpointOutput struct { + _ struct{} `type:"structure"` + + // The output contains the ARN of the managed endpoint. + Arn *string `locationName:"arn" min:"60" type:"string"` + + // The output contains the ID of the managed endpoint. + Id *string `locationName:"id" min:"1" type:"string"` + + // The output contains the name of the managed endpoint. + Name *string `locationName:"name" min:"1" type:"string"` + + // The output contains the ID of the virtual cluster. + VirtualClusterId *string `locationName:"virtualClusterId" min:"1" type:"string"` +} + +// String returns the string representation +func (s CreateManagedEndpointOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s CreateManagedEndpointOutput) GoString() string { + return s.String() +} + +// SetArn sets the Arn field's value. +func (s *CreateManagedEndpointOutput) SetArn(v string) *CreateManagedEndpointOutput { + s.Arn = &v + return s +} + +// SetId sets the Id field's value. +func (s *CreateManagedEndpointOutput) SetId(v string) *CreateManagedEndpointOutput { + s.Id = &v + return s +} + +// SetName sets the Name field's value. +func (s *CreateManagedEndpointOutput) SetName(v string) *CreateManagedEndpointOutput { + s.Name = &v + return s +} + +// SetVirtualClusterId sets the VirtualClusterId field's value. +func (s *CreateManagedEndpointOutput) SetVirtualClusterId(v string) *CreateManagedEndpointOutput { + s.VirtualClusterId = &v + return s +} + +type CreateVirtualClusterInput struct { + _ struct{} `type:"structure"` + + // The client token of the virtual cluster. + ClientToken *string `locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"` + + // The container provider of the virtual cluster. + // + // ContainerProvider is a required field + ContainerProvider *ContainerProvider `locationName:"containerProvider" type:"structure" required:"true"` + + // The specified name of the virtual cluster. + // + // Name is a required field + Name *string `locationName:"name" min:"1" type:"string" required:"true"` + + // The tags assigned to the virtual cluster. + Tags map[string]*string `locationName:"tags" type:"map"` +} + +// String returns the string representation +func (s CreateVirtualClusterInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s CreateVirtualClusterInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CreateVirtualClusterInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreateVirtualClusterInput"} + if s.ClientToken != nil && len(*s.ClientToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ClientToken", 1)) + } + if s.ContainerProvider == nil { + invalidParams.Add(request.NewErrParamRequired("ContainerProvider")) + } + if s.Name == nil { + invalidParams.Add(request.NewErrParamRequired("Name")) + } + if s.Name != nil && len(*s.Name) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Name", 1)) + } + if s.ContainerProvider != nil { + if err := s.ContainerProvider.Validate(); err != nil { + invalidParams.AddNested("ContainerProvider", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetClientToken sets the ClientToken field's value. +func (s *CreateVirtualClusterInput) SetClientToken(v string) *CreateVirtualClusterInput { + s.ClientToken = &v + return s +} + +// SetContainerProvider sets the ContainerProvider field's value. +func (s *CreateVirtualClusterInput) SetContainerProvider(v *ContainerProvider) *CreateVirtualClusterInput { + s.ContainerProvider = v + return s +} + +// SetName sets the Name field's value. +func (s *CreateVirtualClusterInput) SetName(v string) *CreateVirtualClusterInput { + s.Name = &v + return s +} + +// SetTags sets the Tags field's value. +func (s *CreateVirtualClusterInput) SetTags(v map[string]*string) *CreateVirtualClusterInput { + s.Tags = v + return s +} + +type CreateVirtualClusterOutput struct { + _ struct{} `type:"structure"` + + // This output contains the ARN of virtual cluster. + Arn *string `locationName:"arn" min:"60" type:"string"` + + // This output contains the virtual cluster ID. + Id *string `locationName:"id" min:"1" type:"string"` + + // This output contains the name of the virtual cluster. + Name *string `locationName:"name" min:"1" type:"string"` +} + +// String returns the string representation +func (s CreateVirtualClusterOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s CreateVirtualClusterOutput) GoString() string { + return s.String() +} + +// SetArn sets the Arn field's value. +func (s *CreateVirtualClusterOutput) SetArn(v string) *CreateVirtualClusterOutput { + s.Arn = &v + return s +} + +// SetId sets the Id field's value. +func (s *CreateVirtualClusterOutput) SetId(v string) *CreateVirtualClusterOutput { + s.Id = &v + return s +} + +// SetName sets the Name field's value. +func (s *CreateVirtualClusterOutput) SetName(v string) *CreateVirtualClusterOutput { + s.Name = &v + return s +} + +type DeleteManagedEndpointInput struct { + _ struct{} `type:"structure"` + + // The ID of the managed endpoint. + // + // Id is a required field + Id *string `location:"uri" locationName:"endpointId" min:"1" type:"string" required:"true"` + + // The ID of the endpoint's virtual cluster. + // + // VirtualClusterId is a required field + VirtualClusterId *string `location:"uri" locationName:"virtualClusterId" min:"1" type:"string" required:"true"` +} + +// String returns the string representation +func (s DeleteManagedEndpointInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s DeleteManagedEndpointInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DeleteManagedEndpointInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeleteManagedEndpointInput"} + if s.Id == nil { + invalidParams.Add(request.NewErrParamRequired("Id")) + } + if s.Id != nil && len(*s.Id) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Id", 1)) + } + if s.VirtualClusterId == nil { + invalidParams.Add(request.NewErrParamRequired("VirtualClusterId")) + } + if s.VirtualClusterId != nil && len(*s.VirtualClusterId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("VirtualClusterId", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetId sets the Id field's value. +func (s *DeleteManagedEndpointInput) SetId(v string) *DeleteManagedEndpointInput { + s.Id = &v + return s +} + +// SetVirtualClusterId sets the VirtualClusterId field's value. +func (s *DeleteManagedEndpointInput) SetVirtualClusterId(v string) *DeleteManagedEndpointInput { + s.VirtualClusterId = &v + return s +} + +type DeleteManagedEndpointOutput struct { + _ struct{} `type:"structure"` + + // The output displays the ID of the managed endpoint. + Id *string `locationName:"id" min:"1" type:"string"` + + // The output displays the ID of the endpoint's virtual cluster. + VirtualClusterId *string `locationName:"virtualClusterId" min:"1" type:"string"` +} + +// String returns the string representation +func (s DeleteManagedEndpointOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s DeleteManagedEndpointOutput) GoString() string { + return s.String() +} + +// SetId sets the Id field's value. +func (s *DeleteManagedEndpointOutput) SetId(v string) *DeleteManagedEndpointOutput { + s.Id = &v + return s +} + +// SetVirtualClusterId sets the VirtualClusterId field's value. +func (s *DeleteManagedEndpointOutput) SetVirtualClusterId(v string) *DeleteManagedEndpointOutput { + s.VirtualClusterId = &v + return s +} + +type DeleteVirtualClusterInput struct { + _ struct{} `type:"structure"` + + // The ID of the virtual cluster that will be deleted. + // + // Id is a required field + Id *string `location:"uri" locationName:"virtualClusterId" min:"1" type:"string" required:"true"` +} + +// String returns the string representation +func (s DeleteVirtualClusterInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s DeleteVirtualClusterInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DeleteVirtualClusterInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeleteVirtualClusterInput"} + if s.Id == nil { + invalidParams.Add(request.NewErrParamRequired("Id")) + } + if s.Id != nil && len(*s.Id) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Id", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetId sets the Id field's value. +func (s *DeleteVirtualClusterInput) SetId(v string) *DeleteVirtualClusterInput { + s.Id = &v + return s +} + +type DeleteVirtualClusterOutput struct { + _ struct{} `type:"structure"` + + // This output contains the ID of the virtual cluster that will be deleted. + Id *string `locationName:"id" min:"1" type:"string"` +} + +// String returns the string representation +func (s DeleteVirtualClusterOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s DeleteVirtualClusterOutput) GoString() string { + return s.String() +} + +// SetId sets the Id field's value. +func (s *DeleteVirtualClusterOutput) SetId(v string) *DeleteVirtualClusterOutput { + s.Id = &v + return s +} + +type DescribeJobRunInput struct { + _ struct{} `type:"structure"` + + // The ID of the job run request. + // + // Id is a required field + Id *string `location:"uri" locationName:"jobRunId" min:"1" type:"string" required:"true"` + + // The ID of the virtual cluster for which the job run is submitted. + // + // VirtualClusterId is a required field + VirtualClusterId *string `location:"uri" locationName:"virtualClusterId" min:"1" type:"string" required:"true"` +} + +// String returns the string representation +func (s DescribeJobRunInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s DescribeJobRunInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DescribeJobRunInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeJobRunInput"} + if s.Id == nil { + invalidParams.Add(request.NewErrParamRequired("Id")) + } + if s.Id != nil && len(*s.Id) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Id", 1)) + } + if s.VirtualClusterId == nil { + invalidParams.Add(request.NewErrParamRequired("VirtualClusterId")) + } + if s.VirtualClusterId != nil && len(*s.VirtualClusterId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("VirtualClusterId", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetId sets the Id field's value. +func (s *DescribeJobRunInput) SetId(v string) *DescribeJobRunInput { + s.Id = &v + return s +} + +// SetVirtualClusterId sets the VirtualClusterId field's value. +func (s *DescribeJobRunInput) SetVirtualClusterId(v string) *DescribeJobRunInput { + s.VirtualClusterId = &v + return s +} + +type DescribeJobRunOutput struct { + _ struct{} `type:"structure"` + + // The output displays information about a job run. + JobRun *JobRun `locationName:"jobRun" type:"structure"` +} + +// String returns the string representation +func (s DescribeJobRunOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s DescribeJobRunOutput) GoString() string { + return s.String() +} + +// SetJobRun sets the JobRun field's value. +func (s *DescribeJobRunOutput) SetJobRun(v *JobRun) *DescribeJobRunOutput { + s.JobRun = v + return s +} + +type DescribeManagedEndpointInput struct { + _ struct{} `type:"structure"` + + // This output displays ID of the managed endpoint. + // + // Id is a required field + Id *string `location:"uri" locationName:"endpointId" min:"1" type:"string" required:"true"` + + // The ID of the endpoint's virtual cluster. + // + // VirtualClusterId is a required field + VirtualClusterId *string `location:"uri" locationName:"virtualClusterId" min:"1" type:"string" required:"true"` +} + +// String returns the string representation +func (s DescribeManagedEndpointInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s DescribeManagedEndpointInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DescribeManagedEndpointInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeManagedEndpointInput"} + if s.Id == nil { + invalidParams.Add(request.NewErrParamRequired("Id")) + } + if s.Id != nil && len(*s.Id) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Id", 1)) + } + if s.VirtualClusterId == nil { + invalidParams.Add(request.NewErrParamRequired("VirtualClusterId")) + } + if s.VirtualClusterId != nil && len(*s.VirtualClusterId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("VirtualClusterId", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetId sets the Id field's value. +func (s *DescribeManagedEndpointInput) SetId(v string) *DescribeManagedEndpointInput { + s.Id = &v + return s +} + +// SetVirtualClusterId sets the VirtualClusterId field's value. +func (s *DescribeManagedEndpointInput) SetVirtualClusterId(v string) *DescribeManagedEndpointInput { + s.VirtualClusterId = &v + return s +} + +type DescribeManagedEndpointOutput struct { + _ struct{} `type:"structure"` + + // This output displays information about a managed endpoint. + Endpoint *Endpoint `locationName:"endpoint" type:"structure"` +} + +// String returns the string representation +func (s DescribeManagedEndpointOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s DescribeManagedEndpointOutput) GoString() string { + return s.String() +} + +// SetEndpoint sets the Endpoint field's value. +func (s *DescribeManagedEndpointOutput) SetEndpoint(v *Endpoint) *DescribeManagedEndpointOutput { + s.Endpoint = v + return s +} + +type DescribeVirtualClusterInput struct { + _ struct{} `type:"structure"` + + // The ID of the virtual cluster that will be described. + // + // Id is a required field + Id *string `location:"uri" locationName:"virtualClusterId" min:"1" type:"string" required:"true"` +} + +// String returns the string representation +func (s DescribeVirtualClusterInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s DescribeVirtualClusterInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DescribeVirtualClusterInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeVirtualClusterInput"} + if s.Id == nil { + invalidParams.Add(request.NewErrParamRequired("Id")) + } + if s.Id != nil && len(*s.Id) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Id", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetId sets the Id field's value. +func (s *DescribeVirtualClusterInput) SetId(v string) *DescribeVirtualClusterInput { + s.Id = &v + return s +} + +type DescribeVirtualClusterOutput struct { + _ struct{} `type:"structure"` + + // This output displays information about the specified virtual cluster. + VirtualCluster *VirtualCluster `locationName:"virtualCluster" type:"structure"` +} + +// String returns the string representation +func (s DescribeVirtualClusterOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s DescribeVirtualClusterOutput) GoString() string { + return s.String() +} + +// SetVirtualCluster sets the VirtualCluster field's value. +func (s *DescribeVirtualClusterOutput) SetVirtualCluster(v *VirtualCluster) *DescribeVirtualClusterOutput { + s.VirtualCluster = v + return s +} + +// The information about the EKS cluster. +type EksInfo struct { + _ struct{} `type:"structure"` + + // The namespaces of the EKS cluster. + Namespace *string `locationName:"namespace" min:"1" type:"string"` +} + +// String returns the string representation +func (s EksInfo) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s EksInfo) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *EksInfo) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "EksInfo"} + if s.Namespace != nil && len(*s.Namespace) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Namespace", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetNamespace sets the Namespace field's value. +func (s *EksInfo) SetNamespace(v string) *EksInfo { + s.Namespace = &v + return s +} + +// This entity represents the endpoint that is managed by Amazon EMR on EKS. +type Endpoint struct { + _ struct{} `type:"structure"` + + // The ARN of the endpoint. + Arn *string `locationName:"arn" min:"60" type:"string"` + + // The certificate ARN of the endpoint. + CertificateArn *string `locationName:"certificateArn" min:"44" type:"string"` + + // The configuration settings that are used to override existing configurations + // for endpoints. + ConfigurationOverrides *ConfigurationOverrides `locationName:"configurationOverrides" type:"structure"` + + // The date and time when the endpoint was created. + CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"` + + // The execution role ARN of the endpoint. + ExecutionRoleArn *string `locationName:"executionRoleArn" min:"20" type:"string"` + + // The ID of the endpoint. + Id *string `locationName:"id" min:"1" type:"string"` + + // The name of the endpoint. + Name *string `locationName:"name" min:"1" type:"string"` + + // The EMR release version to be used for the endpoint. + ReleaseLabel *string `locationName:"releaseLabel" min:"1" type:"string"` + + // The security group configuration of the endpoint. + SecurityGroup *string `locationName:"securityGroup" min:"1" type:"string"` + + // The server URL of the endpoint. + ServerUrl *string `locationName:"serverUrl" min:"1" type:"string"` + + // The state of the endpoint. + State *string `locationName:"state" type:"string" enum:"EndpointState"` + + // The subnet IDs of the endpoint. + SubnetIds []*string `locationName:"subnetIds" type:"list"` + + // The tags of the endpoint. + Tags map[string]*string `locationName:"tags" type:"map"` + + // The type of the endpoint. + Type *string `locationName:"type" min:"1" type:"string"` + + // The ID of the endpoint's virtual cluster. + VirtualClusterId *string `locationName:"virtualClusterId" min:"1" type:"string"` +} + +// String returns the string representation +func (s Endpoint) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s Endpoint) GoString() string { + return s.String() +} + +// SetArn sets the Arn field's value. +func (s *Endpoint) SetArn(v string) *Endpoint { + s.Arn = &v + return s +} + +// SetCertificateArn sets the CertificateArn field's value. +func (s *Endpoint) SetCertificateArn(v string) *Endpoint { + s.CertificateArn = &v + return s +} + +// SetConfigurationOverrides sets the ConfigurationOverrides field's value. +func (s *Endpoint) SetConfigurationOverrides(v *ConfigurationOverrides) *Endpoint { + s.ConfigurationOverrides = v + return s +} + +// SetCreatedAt sets the CreatedAt field's value. +func (s *Endpoint) SetCreatedAt(v time.Time) *Endpoint { + s.CreatedAt = &v + return s +} + +// SetExecutionRoleArn sets the ExecutionRoleArn field's value. +func (s *Endpoint) SetExecutionRoleArn(v string) *Endpoint { + s.ExecutionRoleArn = &v + return s +} + +// SetId sets the Id field's value. +func (s *Endpoint) SetId(v string) *Endpoint { + s.Id = &v + return s +} + +// SetName sets the Name field's value. +func (s *Endpoint) SetName(v string) *Endpoint { + s.Name = &v + return s +} + +// SetReleaseLabel sets the ReleaseLabel field's value. +func (s *Endpoint) SetReleaseLabel(v string) *Endpoint { + s.ReleaseLabel = &v + return s +} + +// SetSecurityGroup sets the SecurityGroup field's value. +func (s *Endpoint) SetSecurityGroup(v string) *Endpoint { + s.SecurityGroup = &v + return s +} + +// SetServerUrl sets the ServerUrl field's value. +func (s *Endpoint) SetServerUrl(v string) *Endpoint { + s.ServerUrl = &v + return s +} + +// SetState sets the State field's value. +func (s *Endpoint) SetState(v string) *Endpoint { + s.State = &v + return s +} + +// SetSubnetIds sets the SubnetIds field's value. +func (s *Endpoint) SetSubnetIds(v []*string) *Endpoint { + s.SubnetIds = v + return s +} + +// SetTags sets the Tags field's value. +func (s *Endpoint) SetTags(v map[string]*string) *Endpoint { + s.Tags = v + return s +} + +// SetType sets the Type field's value. +func (s *Endpoint) SetType(v string) *Endpoint { + s.Type = &v + return s +} + +// SetVirtualClusterId sets the VirtualClusterId field's value. +func (s *Endpoint) SetVirtualClusterId(v string) *Endpoint { + s.VirtualClusterId = &v + return s +} + +// This is an internal server exception. +type InternalServerException struct { + _ struct{} `type:"structure"` + RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` + + Message_ *string `locationName:"message" min:"1" type:"string"` +} + +// String returns the string representation +func (s InternalServerException) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s InternalServerException) GoString() string { + return s.String() +} + +func newErrorInternalServerException(v protocol.ResponseMetadata) error { + return &InternalServerException{ + RespMetadata: v, + } +} + +// Code returns the exception type name. +func (s *InternalServerException) Code() string { + return "InternalServerException" +} + +// Message returns the exception's message. +func (s *InternalServerException) Message() string { + if s.Message_ != nil { + return *s.Message_ + } + return "" +} + +// OrigErr always returns nil, satisfies awserr.Error interface. +func (s *InternalServerException) OrigErr() error { + return nil +} + +func (s *InternalServerException) Error() string { + return fmt.Sprintf("%s: %s", s.Code(), s.Message()) +} + +// Status code returns the HTTP status code for the request's response error. +func (s *InternalServerException) StatusCode() int { + return s.RespMetadata.StatusCode +} + +// RequestID returns the service's response RequestID for request. +func (s *InternalServerException) RequestID() string { + return s.RespMetadata.RequestID +} + +// Specify the driver that the job runs on. +type JobDriver struct { + _ struct{} `type:"structure"` + + // The job driver parameters specified for spark submit. + SparkSubmitJobDriver *SparkSubmitJobDriver `locationName:"sparkSubmitJobDriver" type:"structure"` +} + +// String returns the string representation +func (s JobDriver) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s JobDriver) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *JobDriver) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "JobDriver"} + if s.SparkSubmitJobDriver != nil { + if err := s.SparkSubmitJobDriver.Validate(); err != nil { + invalidParams.AddNested("SparkSubmitJobDriver", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetSparkSubmitJobDriver sets the SparkSubmitJobDriver field's value. +func (s *JobDriver) SetSparkSubmitJobDriver(v *SparkSubmitJobDriver) *JobDriver { + s.SparkSubmitJobDriver = v + return s +} + +// This entity describes a job run. A job run is a unit of work, such as a Spark +// jar, PySpark script, or SparkSQL query, that you submit to Amazon EMR on +// EKS. +type JobRun struct { + _ struct{} `type:"structure"` + + // The ARN of job run. + Arn *string `locationName:"arn" min:"60" type:"string"` + + // The client token used to start a job run. + ClientToken *string `locationName:"clientToken" min:"1" type:"string"` + + // The configuration settings that are used to override default configuration. + ConfigurationOverrides *ConfigurationOverrides `locationName:"configurationOverrides" type:"structure"` + + // The date and time when the job run was created. + CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"` + + // The user who created the job run. + CreatedBy *string `locationName:"createdBy" min:"20" type:"string"` + + // The execution role ARN of the job run. + ExecutionRoleArn *string `locationName:"executionRoleArn" min:"20" type:"string"` + + // The reasons why the job run has failed. + FailureReason *string `locationName:"failureReason" type:"string" enum:"FailureReason"` + + // The date and time when the job run has finished. + FinishedAt *time.Time `locationName:"finishedAt" type:"timestamp"` + + // The ID of the job run. + Id *string `locationName:"id" min:"1" type:"string"` + + // Parameters of job driver for the job run. + JobDriver *JobDriver `locationName:"jobDriver" type:"structure"` + + // The name of the job run. + Name *string `locationName:"name" min:"1" type:"string"` + + // The release version of Amazon EMR. + ReleaseLabel *string `locationName:"releaseLabel" min:"1" type:"string"` + + // The state of the job run. + State *string `locationName:"state" type:"string" enum:"JobRunState"` + + // Additional details of the job run state. + StateDetails *string `locationName:"stateDetails" min:"1" type:"string"` + + // The assigned tags of the job run. + Tags map[string]*string `locationName:"tags" type:"map"` + + // The ID of the job run's virtual cluster. + VirtualClusterId *string `locationName:"virtualClusterId" min:"1" type:"string"` +} + +// String returns the string representation +func (s JobRun) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s JobRun) GoString() string { + return s.String() +} + +// SetArn sets the Arn field's value. +func (s *JobRun) SetArn(v string) *JobRun { + s.Arn = &v + return s +} + +// SetClientToken sets the ClientToken field's value. +func (s *JobRun) SetClientToken(v string) *JobRun { + s.ClientToken = &v + return s +} + +// SetConfigurationOverrides sets the ConfigurationOverrides field's value. +func (s *JobRun) SetConfigurationOverrides(v *ConfigurationOverrides) *JobRun { + s.ConfigurationOverrides = v + return s +} + +// SetCreatedAt sets the CreatedAt field's value. +func (s *JobRun) SetCreatedAt(v time.Time) *JobRun { + s.CreatedAt = &v + return s +} + +// SetCreatedBy sets the CreatedBy field's value. +func (s *JobRun) SetCreatedBy(v string) *JobRun { + s.CreatedBy = &v + return s +} + +// SetExecutionRoleArn sets the ExecutionRoleArn field's value. +func (s *JobRun) SetExecutionRoleArn(v string) *JobRun { + s.ExecutionRoleArn = &v + return s +} + +// SetFailureReason sets the FailureReason field's value. +func (s *JobRun) SetFailureReason(v string) *JobRun { + s.FailureReason = &v + return s +} + +// SetFinishedAt sets the FinishedAt field's value. +func (s *JobRun) SetFinishedAt(v time.Time) *JobRun { + s.FinishedAt = &v + return s +} + +// SetId sets the Id field's value. +func (s *JobRun) SetId(v string) *JobRun { + s.Id = &v + return s +} + +// SetJobDriver sets the JobDriver field's value. +func (s *JobRun) SetJobDriver(v *JobDriver) *JobRun { + s.JobDriver = v + return s +} + +// SetName sets the Name field's value. +func (s *JobRun) SetName(v string) *JobRun { + s.Name = &v + return s +} + +// SetReleaseLabel sets the ReleaseLabel field's value. +func (s *JobRun) SetReleaseLabel(v string) *JobRun { + s.ReleaseLabel = &v + return s +} + +// SetState sets the State field's value. +func (s *JobRun) SetState(v string) *JobRun { + s.State = &v + return s +} + +// SetStateDetails sets the StateDetails field's value. +func (s *JobRun) SetStateDetails(v string) *JobRun { + s.StateDetails = &v + return s +} + +// SetTags sets the Tags field's value. +func (s *JobRun) SetTags(v map[string]*string) *JobRun { + s.Tags = v + return s +} + +// SetVirtualClusterId sets the VirtualClusterId field's value. +func (s *JobRun) SetVirtualClusterId(v string) *JobRun { + s.VirtualClusterId = &v + return s +} + +type ListJobRunsInput struct { + _ struct{} `type:"structure"` + + // The date and time after which the job runs were submitted. + CreatedAfter *time.Time `location:"querystring" locationName:"createdAfter" type:"timestamp"` + + // The date and time before which the job runs were submitted. + CreatedBefore *time.Time `location:"querystring" locationName:"createdBefore" type:"timestamp"` + + // The maximum number of job runs that can be listed. + MaxResults *int64 `location:"querystring" locationName:"maxResults" type:"integer"` + + // The name of the job run. + Name *string `location:"querystring" locationName:"name" min:"1" type:"string"` + + // The token for the next set of job runs to return. + NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"` + + // The states of the job run. + States []*string `location:"querystring" locationName:"states" type:"list"` + + // The ID of the virtual cluster for which to list the job run. + // + // VirtualClusterId is a required field + VirtualClusterId *string `location:"uri" locationName:"virtualClusterId" min:"1" type:"string" required:"true"` +} + +// String returns the string representation +func (s ListJobRunsInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s ListJobRunsInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListJobRunsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListJobRunsInput"} + if s.Name != nil && len(*s.Name) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Name", 1)) + } + if s.NextToken != nil && len(*s.NextToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("NextToken", 1)) + } + if s.VirtualClusterId == nil { + invalidParams.Add(request.NewErrParamRequired("VirtualClusterId")) + } + if s.VirtualClusterId != nil && len(*s.VirtualClusterId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("VirtualClusterId", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetCreatedAfter sets the CreatedAfter field's value. +func (s *ListJobRunsInput) SetCreatedAfter(v time.Time) *ListJobRunsInput { + s.CreatedAfter = &v + return s +} + +// SetCreatedBefore sets the CreatedBefore field's value. +func (s *ListJobRunsInput) SetCreatedBefore(v time.Time) *ListJobRunsInput { + s.CreatedBefore = &v + return s +} + +// SetMaxResults sets the MaxResults field's value. +func (s *ListJobRunsInput) SetMaxResults(v int64) *ListJobRunsInput { + s.MaxResults = &v + return s +} + +// SetName sets the Name field's value. +func (s *ListJobRunsInput) SetName(v string) *ListJobRunsInput { + s.Name = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListJobRunsInput) SetNextToken(v string) *ListJobRunsInput { + s.NextToken = &v + return s +} + +// SetStates sets the States field's value. +func (s *ListJobRunsInput) SetStates(v []*string) *ListJobRunsInput { + s.States = v + return s +} + +// SetVirtualClusterId sets the VirtualClusterId field's value. +func (s *ListJobRunsInput) SetVirtualClusterId(v string) *ListJobRunsInput { + s.VirtualClusterId = &v + return s +} + +type ListJobRunsOutput struct { + _ struct{} `type:"structure"` + + // This output lists information about the specified job runs. + JobRuns []*JobRun `locationName:"jobRuns" type:"list"` + + // This output displays the token for the next set of job runs. + NextToken *string `locationName:"nextToken" min:"1" type:"string"` +} + +// String returns the string representation +func (s ListJobRunsOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s ListJobRunsOutput) GoString() string { + return s.String() +} + +// SetJobRuns sets the JobRuns field's value. +func (s *ListJobRunsOutput) SetJobRuns(v []*JobRun) *ListJobRunsOutput { + s.JobRuns = v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListJobRunsOutput) SetNextToken(v string) *ListJobRunsOutput { + s.NextToken = &v + return s +} + +type ListManagedEndpointsInput struct { + _ struct{} `type:"structure"` + + // The date and time after which the endpoints are created. + CreatedAfter *time.Time `location:"querystring" locationName:"createdAfter" type:"timestamp"` + + // The date and time before which the endpoints are created. + CreatedBefore *time.Time `location:"querystring" locationName:"createdBefore" type:"timestamp"` + + // The maximum number of managed endpoints that can be listed. + MaxResults *int64 `location:"querystring" locationName:"maxResults" type:"integer"` + + // The token for the next set of managed endpoints to return. + NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"` + + // The states of the managed endpoints. + States []*string `location:"querystring" locationName:"states" type:"list"` + + // The types of the managed endpoints. + Types []*string `location:"querystring" locationName:"types" type:"list"` + + // The ID of the virtual cluster. + // + // VirtualClusterId is a required field + VirtualClusterId *string `location:"uri" locationName:"virtualClusterId" min:"1" type:"string" required:"true"` +} + +// String returns the string representation +func (s ListManagedEndpointsInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s ListManagedEndpointsInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListManagedEndpointsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListManagedEndpointsInput"} + if s.NextToken != nil && len(*s.NextToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("NextToken", 1)) + } + if s.VirtualClusterId == nil { + invalidParams.Add(request.NewErrParamRequired("VirtualClusterId")) + } + if s.VirtualClusterId != nil && len(*s.VirtualClusterId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("VirtualClusterId", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetCreatedAfter sets the CreatedAfter field's value. +func (s *ListManagedEndpointsInput) SetCreatedAfter(v time.Time) *ListManagedEndpointsInput { + s.CreatedAfter = &v + return s +} + +// SetCreatedBefore sets the CreatedBefore field's value. +func (s *ListManagedEndpointsInput) SetCreatedBefore(v time.Time) *ListManagedEndpointsInput { + s.CreatedBefore = &v + return s +} + +// SetMaxResults sets the MaxResults field's value. +func (s *ListManagedEndpointsInput) SetMaxResults(v int64) *ListManagedEndpointsInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListManagedEndpointsInput) SetNextToken(v string) *ListManagedEndpointsInput { + s.NextToken = &v + return s +} + +// SetStates sets the States field's value. +func (s *ListManagedEndpointsInput) SetStates(v []*string) *ListManagedEndpointsInput { + s.States = v + return s +} + +// SetTypes sets the Types field's value. +func (s *ListManagedEndpointsInput) SetTypes(v []*string) *ListManagedEndpointsInput { + s.Types = v + return s +} + +// SetVirtualClusterId sets the VirtualClusterId field's value. +func (s *ListManagedEndpointsInput) SetVirtualClusterId(v string) *ListManagedEndpointsInput { + s.VirtualClusterId = &v + return s +} + +type ListManagedEndpointsOutput struct { + _ struct{} `type:"structure"` + + // The managed endpoints to be listed. + Endpoints []*Endpoint `locationName:"endpoints" type:"list"` + + // The token for the next set of endpoints to return. + NextToken *string `locationName:"nextToken" min:"1" type:"string"` +} + +// String returns the string representation +func (s ListManagedEndpointsOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s ListManagedEndpointsOutput) GoString() string { + return s.String() +} + +// SetEndpoints sets the Endpoints field's value. +func (s *ListManagedEndpointsOutput) SetEndpoints(v []*Endpoint) *ListManagedEndpointsOutput { + s.Endpoints = v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListManagedEndpointsOutput) SetNextToken(v string) *ListManagedEndpointsOutput { + s.NextToken = &v + return s +} + +type ListTagsForResourceInput struct { + _ struct{} `type:"structure"` + + // The ARN of tagged resources. + // + // ResourceArn is a required field + ResourceArn *string `location:"uri" locationName:"resourceArn" min:"60" type:"string" required:"true"` +} + +// String returns the string representation +func (s ListTagsForResourceInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s ListTagsForResourceInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListTagsForResourceInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListTagsForResourceInput"} + if s.ResourceArn == nil { + invalidParams.Add(request.NewErrParamRequired("ResourceArn")) + } + if s.ResourceArn != nil && len(*s.ResourceArn) < 60 { + invalidParams.Add(request.NewErrParamMinLen("ResourceArn", 60)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetResourceArn sets the ResourceArn field's value. +func (s *ListTagsForResourceInput) SetResourceArn(v string) *ListTagsForResourceInput { + s.ResourceArn = &v + return s +} + +type ListTagsForResourceOutput struct { + _ struct{} `type:"structure"` + + // The tags assigned to resources. + Tags map[string]*string `locationName:"tags" type:"map"` +} + +// String returns the string representation +func (s ListTagsForResourceOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s ListTagsForResourceOutput) GoString() string { + return s.String() +} + +// SetTags sets the Tags field's value. +func (s *ListTagsForResourceOutput) SetTags(v map[string]*string) *ListTagsForResourceOutput { + s.Tags = v + return s +} + +type ListVirtualClustersInput struct { + _ struct{} `type:"structure"` + + // The container provider ID of the virtual cluster. + ContainerProviderId *string `location:"querystring" locationName:"containerProviderId" min:"1" type:"string"` + + // The container provider type of the virtual cluster. EKS is the only supported + // type as of now. + ContainerProviderType *string `location:"querystring" locationName:"containerProviderType" type:"string" enum:"ContainerProviderType"` + + // The date and time after which the virtual clusters are created. + CreatedAfter *time.Time `location:"querystring" locationName:"createdAfter" type:"timestamp"` + + // The date and time before which the virtual clusters are created. + CreatedBefore *time.Time `location:"querystring" locationName:"createdBefore" type:"timestamp"` + + // The maximum number of virtual clusters that can be listed. + MaxResults *int64 `location:"querystring" locationName:"maxResults" type:"integer"` + + // The token for the next set of virtual clusters to return. + NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"` + + // The states of the requested virtual clusters. + States []*string `location:"querystring" locationName:"states" type:"list"` +} + +// String returns the string representation +func (s ListVirtualClustersInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s ListVirtualClustersInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListVirtualClustersInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListVirtualClustersInput"} + if s.ContainerProviderId != nil && len(*s.ContainerProviderId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ContainerProviderId", 1)) + } + if s.NextToken != nil && len(*s.NextToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("NextToken", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetContainerProviderId sets the ContainerProviderId field's value. +func (s *ListVirtualClustersInput) SetContainerProviderId(v string) *ListVirtualClustersInput { + s.ContainerProviderId = &v + return s +} + +// SetContainerProviderType sets the ContainerProviderType field's value. +func (s *ListVirtualClustersInput) SetContainerProviderType(v string) *ListVirtualClustersInput { + s.ContainerProviderType = &v + return s +} + +// SetCreatedAfter sets the CreatedAfter field's value. +func (s *ListVirtualClustersInput) SetCreatedAfter(v time.Time) *ListVirtualClustersInput { + s.CreatedAfter = &v + return s +} + +// SetCreatedBefore sets the CreatedBefore field's value. +func (s *ListVirtualClustersInput) SetCreatedBefore(v time.Time) *ListVirtualClustersInput { + s.CreatedBefore = &v + return s +} + +// SetMaxResults sets the MaxResults field's value. +func (s *ListVirtualClustersInput) SetMaxResults(v int64) *ListVirtualClustersInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListVirtualClustersInput) SetNextToken(v string) *ListVirtualClustersInput { + s.NextToken = &v + return s +} + +// SetStates sets the States field's value. +func (s *ListVirtualClustersInput) SetStates(v []*string) *ListVirtualClustersInput { + s.States = v + return s +} + +type ListVirtualClustersOutput struct { + _ struct{} `type:"structure"` + + // This output displays the token for the next set of virtual clusters. + NextToken *string `locationName:"nextToken" min:"1" type:"string"` + + // This output lists the specified virtual clusters. + VirtualClusters []*VirtualCluster `locationName:"virtualClusters" type:"list"` +} + +// String returns the string representation +func (s ListVirtualClustersOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s ListVirtualClustersOutput) GoString() string { + return s.String() +} + +// SetNextToken sets the NextToken field's value. +func (s *ListVirtualClustersOutput) SetNextToken(v string) *ListVirtualClustersOutput { + s.NextToken = &v + return s +} + +// SetVirtualClusters sets the VirtualClusters field's value. +func (s *ListVirtualClustersOutput) SetVirtualClusters(v []*VirtualCluster) *ListVirtualClustersOutput { + s.VirtualClusters = v + return s +} + +// Configuration setting for monitoring. +type MonitoringConfiguration struct { + _ struct{} `type:"structure"` + + // Monitoring configurations for CloudWatch. + CloudWatchMonitoringConfiguration *CloudWatchMonitoringConfiguration `locationName:"cloudWatchMonitoringConfiguration" type:"structure"` + + // Monitoring configurations for the persistent application UI. + PersistentAppUI *string `locationName:"persistentAppUI" type:"string" enum:"PersistentAppUI"` + + // Amazon S3 configuration for monitoring log publishing. + S3MonitoringConfiguration *S3MonitoringConfiguration `locationName:"s3MonitoringConfiguration" type:"structure"` +} + +// String returns the string representation +func (s MonitoringConfiguration) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s MonitoringConfiguration) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *MonitoringConfiguration) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "MonitoringConfiguration"} + if s.CloudWatchMonitoringConfiguration != nil { + if err := s.CloudWatchMonitoringConfiguration.Validate(); err != nil { + invalidParams.AddNested("CloudWatchMonitoringConfiguration", err.(request.ErrInvalidParams)) + } + } + if s.S3MonitoringConfiguration != nil { + if err := s.S3MonitoringConfiguration.Validate(); err != nil { + invalidParams.AddNested("S3MonitoringConfiguration", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetCloudWatchMonitoringConfiguration sets the CloudWatchMonitoringConfiguration field's value. +func (s *MonitoringConfiguration) SetCloudWatchMonitoringConfiguration(v *CloudWatchMonitoringConfiguration) *MonitoringConfiguration { + s.CloudWatchMonitoringConfiguration = v + return s +} + +// SetPersistentAppUI sets the PersistentAppUI field's value. +func (s *MonitoringConfiguration) SetPersistentAppUI(v string) *MonitoringConfiguration { + s.PersistentAppUI = &v + return s +} + +// SetS3MonitoringConfiguration sets the S3MonitoringConfiguration field's value. +func (s *MonitoringConfiguration) SetS3MonitoringConfiguration(v *S3MonitoringConfiguration) *MonitoringConfiguration { + s.S3MonitoringConfiguration = v + return s +} + +// The specified resource was not found. +type ResourceNotFoundException struct { + _ struct{} `type:"structure"` + RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` + + Message_ *string `locationName:"message" min:"1" type:"string"` +} + +// String returns the string representation +func (s ResourceNotFoundException) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s ResourceNotFoundException) GoString() string { + return s.String() +} + +func newErrorResourceNotFoundException(v protocol.ResponseMetadata) error { + return &ResourceNotFoundException{ + RespMetadata: v, + } +} + +// Code returns the exception type name. +func (s *ResourceNotFoundException) Code() string { + return "ResourceNotFoundException" +} + +// Message returns the exception's message. +func (s *ResourceNotFoundException) Message() string { + if s.Message_ != nil { + return *s.Message_ + } + return "" +} + +// OrigErr always returns nil, satisfies awserr.Error interface. +func (s *ResourceNotFoundException) OrigErr() error { + return nil +} + +func (s *ResourceNotFoundException) Error() string { + return fmt.Sprintf("%s: %s", s.Code(), s.Message()) +} + +// Status code returns the HTTP status code for the request's response error. +func (s *ResourceNotFoundException) StatusCode() int { + return s.RespMetadata.StatusCode +} + +// RequestID returns the service's response RequestID for request. +func (s *ResourceNotFoundException) RequestID() string { + return s.RespMetadata.RequestID +} + +// Amazon S3 configuration for monitoring log publishing. You can configure +// your jobs to send log information to Amazon S3. +type S3MonitoringConfiguration struct { + _ struct{} `type:"structure"` + + // Amazon S3 destination URI for log publishing. + // + // LogUri is a required field + LogUri *string `locationName:"logUri" min:"1" type:"string" required:"true"` +} + +// String returns the string representation +func (s S3MonitoringConfiguration) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s S3MonitoringConfiguration) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *S3MonitoringConfiguration) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "S3MonitoringConfiguration"} + if s.LogUri == nil { + invalidParams.Add(request.NewErrParamRequired("LogUri")) + } + if s.LogUri != nil && len(*s.LogUri) < 1 { + invalidParams.Add(request.NewErrParamMinLen("LogUri", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetLogUri sets the LogUri field's value. +func (s *S3MonitoringConfiguration) SetLogUri(v string) *S3MonitoringConfiguration { + s.LogUri = &v + return s +} + +// The information about job driver for Spark submit. +type SparkSubmitJobDriver struct { + _ struct{} `type:"structure"` + + // The entry point of job application. + // + // EntryPoint is a required field + EntryPoint *string `locationName:"entryPoint" min:"1" type:"string" required:"true" sensitive:"true"` + + // The arguments for job application. + EntryPointArguments []*string `locationName:"entryPointArguments" type:"list"` + + // The Spark submit parameters that are used for job runs. + SparkSubmitParameters *string `locationName:"sparkSubmitParameters" min:"1" type:"string" sensitive:"true"` +} + +// String returns the string representation +func (s SparkSubmitJobDriver) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s SparkSubmitJobDriver) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *SparkSubmitJobDriver) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "SparkSubmitJobDriver"} + if s.EntryPoint == nil { + invalidParams.Add(request.NewErrParamRequired("EntryPoint")) + } + if s.EntryPoint != nil && len(*s.EntryPoint) < 1 { + invalidParams.Add(request.NewErrParamMinLen("EntryPoint", 1)) + } + if s.SparkSubmitParameters != nil && len(*s.SparkSubmitParameters) < 1 { + invalidParams.Add(request.NewErrParamMinLen("SparkSubmitParameters", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetEntryPoint sets the EntryPoint field's value. +func (s *SparkSubmitJobDriver) SetEntryPoint(v string) *SparkSubmitJobDriver { + s.EntryPoint = &v + return s +} + +// SetEntryPointArguments sets the EntryPointArguments field's value. +func (s *SparkSubmitJobDriver) SetEntryPointArguments(v []*string) *SparkSubmitJobDriver { + s.EntryPointArguments = v + return s +} + +// SetSparkSubmitParameters sets the SparkSubmitParameters field's value. +func (s *SparkSubmitJobDriver) SetSparkSubmitParameters(v string) *SparkSubmitJobDriver { + s.SparkSubmitParameters = &v + return s +} + +type StartJobRunInput struct { + _ struct{} `type:"structure"` + + // The client idempotency token of the job run request. + ClientToken *string `locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"` + + // The configuration overrides for the job run. + ConfigurationOverrides *ConfigurationOverrides `locationName:"configurationOverrides" type:"structure"` + + // The execution role ARN for the job run. + // + // ExecutionRoleArn is a required field + ExecutionRoleArn *string `locationName:"executionRoleArn" min:"20" type:"string" required:"true"` + + // The job driver for the job run. + // + // JobDriver is a required field + JobDriver *JobDriver `locationName:"jobDriver" type:"structure" required:"true"` + + // The name of the job run. + Name *string `locationName:"name" min:"1" type:"string"` + + // The Amazon EMR release version to use for the job run. + // + // ReleaseLabel is a required field + ReleaseLabel *string `locationName:"releaseLabel" min:"1" type:"string" required:"true"` + + // The tags assigned to job runs. + Tags map[string]*string `locationName:"tags" type:"map"` + + // The virtual cluster ID for which the job run request is submitted. + // + // VirtualClusterId is a required field + VirtualClusterId *string `location:"uri" locationName:"virtualClusterId" min:"1" type:"string" required:"true"` +} + +// String returns the string representation +func (s StartJobRunInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s StartJobRunInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *StartJobRunInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "StartJobRunInput"} + if s.ClientToken != nil && len(*s.ClientToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ClientToken", 1)) + } + if s.ExecutionRoleArn == nil { + invalidParams.Add(request.NewErrParamRequired("ExecutionRoleArn")) + } + if s.ExecutionRoleArn != nil && len(*s.ExecutionRoleArn) < 20 { + invalidParams.Add(request.NewErrParamMinLen("ExecutionRoleArn", 20)) + } + if s.JobDriver == nil { + invalidParams.Add(request.NewErrParamRequired("JobDriver")) + } + if s.Name != nil && len(*s.Name) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Name", 1)) + } + if s.ReleaseLabel == nil { + invalidParams.Add(request.NewErrParamRequired("ReleaseLabel")) + } + if s.ReleaseLabel != nil && len(*s.ReleaseLabel) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ReleaseLabel", 1)) + } + if s.VirtualClusterId == nil { + invalidParams.Add(request.NewErrParamRequired("VirtualClusterId")) + } + if s.VirtualClusterId != nil && len(*s.VirtualClusterId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("VirtualClusterId", 1)) + } + if s.ConfigurationOverrides != nil { + if err := s.ConfigurationOverrides.Validate(); err != nil { + invalidParams.AddNested("ConfigurationOverrides", err.(request.ErrInvalidParams)) + } + } + if s.JobDriver != nil { + if err := s.JobDriver.Validate(); err != nil { + invalidParams.AddNested("JobDriver", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetClientToken sets the ClientToken field's value. +func (s *StartJobRunInput) SetClientToken(v string) *StartJobRunInput { + s.ClientToken = &v + return s +} + +// SetConfigurationOverrides sets the ConfigurationOverrides field's value. +func (s *StartJobRunInput) SetConfigurationOverrides(v *ConfigurationOverrides) *StartJobRunInput { + s.ConfigurationOverrides = v + return s +} + +// SetExecutionRoleArn sets the ExecutionRoleArn field's value. +func (s *StartJobRunInput) SetExecutionRoleArn(v string) *StartJobRunInput { + s.ExecutionRoleArn = &v + return s +} + +// SetJobDriver sets the JobDriver field's value. +func (s *StartJobRunInput) SetJobDriver(v *JobDriver) *StartJobRunInput { + s.JobDriver = v + return s +} + +// SetName sets the Name field's value. +func (s *StartJobRunInput) SetName(v string) *StartJobRunInput { + s.Name = &v + return s +} + +// SetReleaseLabel sets the ReleaseLabel field's value. +func (s *StartJobRunInput) SetReleaseLabel(v string) *StartJobRunInput { + s.ReleaseLabel = &v + return s +} + +// SetTags sets the Tags field's value. +func (s *StartJobRunInput) SetTags(v map[string]*string) *StartJobRunInput { + s.Tags = v + return s +} + +// SetVirtualClusterId sets the VirtualClusterId field's value. +func (s *StartJobRunInput) SetVirtualClusterId(v string) *StartJobRunInput { + s.VirtualClusterId = &v + return s +} + +type StartJobRunOutput struct { + _ struct{} `type:"structure"` + + // This output lists the ARN of job run. + Arn *string `locationName:"arn" min:"60" type:"string"` + + // This output displays the started job run ID. + Id *string `locationName:"id" min:"1" type:"string"` + + // This output displays the name of the started job run. + Name *string `locationName:"name" min:"1" type:"string"` + + // This output displays the virtual cluster ID for which the job run was submitted. + VirtualClusterId *string `locationName:"virtualClusterId" min:"1" type:"string"` +} + +// String returns the string representation +func (s StartJobRunOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s StartJobRunOutput) GoString() string { + return s.String() +} + +// SetArn sets the Arn field's value. +func (s *StartJobRunOutput) SetArn(v string) *StartJobRunOutput { + s.Arn = &v + return s +} + +// SetId sets the Id field's value. +func (s *StartJobRunOutput) SetId(v string) *StartJobRunOutput { + s.Id = &v + return s +} + +// SetName sets the Name field's value. +func (s *StartJobRunOutput) SetName(v string) *StartJobRunOutput { + s.Name = &v + return s +} + +// SetVirtualClusterId sets the VirtualClusterId field's value. +func (s *StartJobRunOutput) SetVirtualClusterId(v string) *StartJobRunOutput { + s.VirtualClusterId = &v + return s +} + +type TagResourceInput struct { + _ struct{} `type:"structure"` + + // The ARN of resources. + // + // ResourceArn is a required field + ResourceArn *string `location:"uri" locationName:"resourceArn" min:"60" type:"string" required:"true"` + + // The tags assigned to resources. + // + // Tags is a required field + Tags map[string]*string `locationName:"tags" type:"map" required:"true"` +} + +// String returns the string representation +func (s TagResourceInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s TagResourceInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *TagResourceInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "TagResourceInput"} + if s.ResourceArn == nil { + invalidParams.Add(request.NewErrParamRequired("ResourceArn")) + } + if s.ResourceArn != nil && len(*s.ResourceArn) < 60 { + invalidParams.Add(request.NewErrParamMinLen("ResourceArn", 60)) + } + if s.Tags == nil { + invalidParams.Add(request.NewErrParamRequired("Tags")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetResourceArn sets the ResourceArn field's value. +func (s *TagResourceInput) SetResourceArn(v string) *TagResourceInput { + s.ResourceArn = &v + return s +} + +// SetTags sets the Tags field's value. +func (s *TagResourceInput) SetTags(v map[string]*string) *TagResourceInput { + s.Tags = v + return s +} + +type TagResourceOutput struct { + _ struct{} `type:"structure"` +} + +// String returns the string representation +func (s TagResourceOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s TagResourceOutput) GoString() string { + return s.String() +} + +type UntagResourceInput struct { + _ struct{} `type:"structure"` + + // The ARN of resources. + // + // ResourceArn is a required field + ResourceArn *string `location:"uri" locationName:"resourceArn" min:"60" type:"string" required:"true"` + + // The tag keys of the resources. + // + // TagKeys is a required field + TagKeys []*string `location:"querystring" locationName:"tagKeys" type:"list" required:"true"` +} + +// String returns the string representation +func (s UntagResourceInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s UntagResourceInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *UntagResourceInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "UntagResourceInput"} + if s.ResourceArn == nil { + invalidParams.Add(request.NewErrParamRequired("ResourceArn")) + } + if s.ResourceArn != nil && len(*s.ResourceArn) < 60 { + invalidParams.Add(request.NewErrParamMinLen("ResourceArn", 60)) + } + if s.TagKeys == nil { + invalidParams.Add(request.NewErrParamRequired("TagKeys")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetResourceArn sets the ResourceArn field's value. +func (s *UntagResourceInput) SetResourceArn(v string) *UntagResourceInput { + s.ResourceArn = &v + return s +} + +// SetTagKeys sets the TagKeys field's value. +func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput { + s.TagKeys = v + return s +} + +type UntagResourceOutput struct { + _ struct{} `type:"structure"` +} + +// String returns the string representation +func (s UntagResourceOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s UntagResourceOutput) GoString() string { + return s.String() +} + +// There are invalid parameters in the client request. +type ValidationException struct { + _ struct{} `type:"structure"` + RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` + + Message_ *string `locationName:"message" min:"1" type:"string"` +} + +// String returns the string representation +func (s ValidationException) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s ValidationException) GoString() string { + return s.String() +} + +func newErrorValidationException(v protocol.ResponseMetadata) error { + return &ValidationException{ + RespMetadata: v, + } +} + +// Code returns the exception type name. +func (s *ValidationException) Code() string { + return "ValidationException" +} + +// Message returns the exception's message. +func (s *ValidationException) Message() string { + if s.Message_ != nil { + return *s.Message_ + } + return "" +} + +// OrigErr always returns nil, satisfies awserr.Error interface. +func (s *ValidationException) OrigErr() error { + return nil +} + +func (s *ValidationException) Error() string { + return fmt.Sprintf("%s: %s", s.Code(), s.Message()) +} + +// Status code returns the HTTP status code for the request's response error. +func (s *ValidationException) StatusCode() int { + return s.RespMetadata.StatusCode +} + +// RequestID returns the service's response RequestID for request. +func (s *ValidationException) RequestID() string { + return s.RespMetadata.RequestID +} + +// This entity describes a virtual cluster. A virtual cluster is a Kubernetes +// namespace that Amazon EMR is registered with. Amazon EMR uses virtual clusters +// to run jobs and host endpoints. Multiple virtual clusters can be backed by +// the same physical cluster. However, each virtual cluster maps to one namespace +// on an EKS cluster. Virtual clusters do not create any active resources that +// contribute to your bill or that require lifecycle management outside the +// service. +type VirtualCluster struct { + _ struct{} `type:"structure"` + + // The ARN of the virtual cluster. + Arn *string `locationName:"arn" min:"60" type:"string"` + + // The container provider of the virtual cluster. + ContainerProvider *ContainerProvider `locationName:"containerProvider" type:"structure"` + + // The date and time when the virtual cluster is created. + CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"` + + // The ID of the virtual cluster. + Id *string `locationName:"id" min:"1" type:"string"` + + // The name of the virtual cluster. + Name *string `locationName:"name" min:"1" type:"string"` + + // The state of the virtual cluster. + State *string `locationName:"state" type:"string" enum:"VirtualClusterState"` + + // The assigned tags of the virtual cluster. + Tags map[string]*string `locationName:"tags" type:"map"` +} + +// String returns the string representation +func (s VirtualCluster) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s VirtualCluster) GoString() string { + return s.String() +} + +// SetArn sets the Arn field's value. +func (s *VirtualCluster) SetArn(v string) *VirtualCluster { + s.Arn = &v + return s +} + +// SetContainerProvider sets the ContainerProvider field's value. +func (s *VirtualCluster) SetContainerProvider(v *ContainerProvider) *VirtualCluster { + s.ContainerProvider = v + return s +} + +// SetCreatedAt sets the CreatedAt field's value. +func (s *VirtualCluster) SetCreatedAt(v time.Time) *VirtualCluster { + s.CreatedAt = &v + return s +} + +// SetId sets the Id field's value. +func (s *VirtualCluster) SetId(v string) *VirtualCluster { + s.Id = &v + return s +} + +// SetName sets the Name field's value. +func (s *VirtualCluster) SetName(v string) *VirtualCluster { + s.Name = &v + return s +} + +// SetState sets the State field's value. +func (s *VirtualCluster) SetState(v string) *VirtualCluster { + s.State = &v + return s +} + +// SetTags sets the Tags field's value. +func (s *VirtualCluster) SetTags(v map[string]*string) *VirtualCluster { + s.Tags = v + return s +} + +const ( + // ContainerProviderTypeEks is a ContainerProviderType enum value + ContainerProviderTypeEks = "EKS" +) + +// ContainerProviderType_Values returns all elements of the ContainerProviderType enum +func ContainerProviderType_Values() []string { + return []string{ + ContainerProviderTypeEks, + } +} + +const ( + // EndpointStateCreating is a EndpointState enum value + EndpointStateCreating = "CREATING" + + // EndpointStateActive is a EndpointState enum value + EndpointStateActive = "ACTIVE" + + // EndpointStateTerminating is a EndpointState enum value + EndpointStateTerminating = "TERMINATING" + + // EndpointStateTerminated is a EndpointState enum value + EndpointStateTerminated = "TERMINATED" + + // EndpointStateTerminatedWithErrors is a EndpointState enum value + EndpointStateTerminatedWithErrors = "TERMINATED_WITH_ERRORS" +) + +// EndpointState_Values returns all elements of the EndpointState enum +func EndpointState_Values() []string { + return []string{ + EndpointStateCreating, + EndpointStateActive, + EndpointStateTerminating, + EndpointStateTerminated, + EndpointStateTerminatedWithErrors, + } +} + +const ( + // FailureReasonInternalError is a FailureReason enum value + FailureReasonInternalError = "INTERNAL_ERROR" + + // FailureReasonUserError is a FailureReason enum value + FailureReasonUserError = "USER_ERROR" + + // FailureReasonValidationError is a FailureReason enum value + FailureReasonValidationError = "VALIDATION_ERROR" + + // FailureReasonClusterUnavailable is a FailureReason enum value + FailureReasonClusterUnavailable = "CLUSTER_UNAVAILABLE" +) + +// FailureReason_Values returns all elements of the FailureReason enum +func FailureReason_Values() []string { + return []string{ + FailureReasonInternalError, + FailureReasonUserError, + FailureReasonValidationError, + FailureReasonClusterUnavailable, + } +} + +const ( + // JobRunStatePending is a JobRunState enum value + JobRunStatePending = "PENDING" + + // JobRunStateSubmitted is a JobRunState enum value + JobRunStateSubmitted = "SUBMITTED" + + // JobRunStateRunning is a JobRunState enum value + JobRunStateRunning = "RUNNING" + + // JobRunStateFailed is a JobRunState enum value + JobRunStateFailed = "FAILED" + + // JobRunStateCancelled is a JobRunState enum value + JobRunStateCancelled = "CANCELLED" + + // JobRunStateCancelPending is a JobRunState enum value + JobRunStateCancelPending = "CANCEL_PENDING" + + // JobRunStateCompleted is a JobRunState enum value + JobRunStateCompleted = "COMPLETED" +) + +// JobRunState_Values returns all elements of the JobRunState enum +func JobRunState_Values() []string { + return []string{ + JobRunStatePending, + JobRunStateSubmitted, + JobRunStateRunning, + JobRunStateFailed, + JobRunStateCancelled, + JobRunStateCancelPending, + JobRunStateCompleted, + } +} + +const ( + // PersistentAppUIEnabled is a PersistentAppUI enum value + PersistentAppUIEnabled = "ENABLED" + + // PersistentAppUIDisabled is a PersistentAppUI enum value + PersistentAppUIDisabled = "DISABLED" +) + +// PersistentAppUI_Values returns all elements of the PersistentAppUI enum +func PersistentAppUI_Values() []string { + return []string{ + PersistentAppUIEnabled, + PersistentAppUIDisabled, + } +} + +const ( + // VirtualClusterStateRunning is a VirtualClusterState enum value + VirtualClusterStateRunning = "RUNNING" + + // VirtualClusterStateTerminating is a VirtualClusterState enum value + VirtualClusterStateTerminating = "TERMINATING" + + // VirtualClusterStateTerminated is a VirtualClusterState enum value + VirtualClusterStateTerminated = "TERMINATED" + + // VirtualClusterStateArrested is a VirtualClusterState enum value + VirtualClusterStateArrested = "ARRESTED" +) + +// VirtualClusterState_Values returns all elements of the VirtualClusterState enum +func VirtualClusterState_Values() []string { + return []string{ + VirtualClusterStateRunning, + VirtualClusterStateTerminating, + VirtualClusterStateTerminated, + VirtualClusterStateArrested, + } +} diff --git a/service/emrcontainers/doc.go b/service/emrcontainers/doc.go new file mode 100644 index 00000000000..663d89f79a6 --- /dev/null +++ b/service/emrcontainers/doc.go @@ -0,0 +1,47 @@ +// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT. + +// Package emrcontainers provides the client and types for making API +// requests to Amazon EMR Containers. +// +// Amazon EMR on EKS provides a deployment option for Amazon EMR that allows +// you to run open-source big data frameworks on Amazon Elastic Kubernetes Service +// (Amazon EKS). With this deployment option, you can focus on running analytics +// workloads while Amazon EMR on EKS builds, configures, and manages containers +// for open-source applications. For more information about Amazon EMR on EKS +// concepts and tasks, see What is Amazon EMR on EKS (https://docs.aws.amazon.com/emr/latest/EMR-on-EKS-DevelopmentGuide/emr-eks.html). +// +// Amazon EMR containers is the API name for Amazon EMR on EKS. The emr-containers +// prefix is used in the following scenarios: +// +// * It is the prefix in the CLI commands for Amazon EMR on EKS. For example, +// aws emr-containers start-job-run. +// +// * It is the prefix before IAM policy actions for Amazon EMR on EKS. For +// example, "Action": [ "emr-containers:StartJobRun"]. For more information, +// see Policy actions for Amazon EMR on EKS (https://docs.aws.amazon.com/emr/latest/EMR-on-EKS-DevelopmentGuide/security_iam_service-with-iam.html#security_iam_service-with-iam-id-based-policies-actions). +// +// * It is the prefix used in Amazon EMR on EKS service endpoints. For example, +// emr-containers.us-east-2.amazonaws.com. For more information, see Amazon +// EMR on EKS Service Endpoints (https://docs.aws.amazon.com/emr/latest/EMR-on-EKS-DevelopmentGuide/service-quotas.html#service-endpoints). +// +// See https://docs.aws.amazon.com/goto/WebAPI/emr-containers-2020-10-01 for more information on this service. +// +// See emrcontainers package documentation for more information. +// https://docs.aws.amazon.com/sdk-for-go/api/service/emrcontainers/ +// +// Using the Client +// +// To contact Amazon EMR Containers with the SDK use the New function to create +// a new service client. With that client you can make API requests to the service. +// These clients are safe to use concurrently. +// +// See the SDK's documentation for more information on how to use the SDK. +// https://docs.aws.amazon.com/sdk-for-go/api/ +// +// See aws.Config documentation for more information on configuring SDK clients. +// https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config +// +// See the Amazon EMR Containers client EMRContainers for more +// information on creating client for this service. +// https://docs.aws.amazon.com/sdk-for-go/api/service/emrcontainers/#New +package emrcontainers diff --git a/service/emrcontainers/emrcontainersiface/interface.go b/service/emrcontainers/emrcontainersiface/interface.go new file mode 100644 index 00000000000..f2612fba5ac --- /dev/null +++ b/service/emrcontainers/emrcontainersiface/interface.go @@ -0,0 +1,133 @@ +// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT. + +// Package emrcontainersiface provides an interface to enable mocking the Amazon EMR Containers service client +// for testing your code. +// +// It is important to note that this interface will have breaking changes +// when the service model is updated and adds new API operations, paginators, +// and waiters. +package emrcontainersiface + +import ( + "github.com/aws/aws-sdk-go/aws" + "github.com/aws/aws-sdk-go/aws/request" + "github.com/aws/aws-sdk-go/service/emrcontainers" +) + +// EMRContainersAPI provides an interface to enable mocking the +// emrcontainers.EMRContainers service client's API operation, +// paginators, and waiters. This make unit testing your code that calls out +// to the SDK's service client's calls easier. +// +// The best way to use this interface is so the SDK's service client's calls +// can be stubbed out for unit testing your code with the SDK without needing +// to inject custom request handlers into the SDK's request pipeline. +// +// // myFunc uses an SDK service client to make a request to +// // Amazon EMR Containers. +// func myFunc(svc emrcontainersiface.EMRContainersAPI) bool { +// // Make svc.CancelJobRun request +// } +// +// func main() { +// sess := session.New() +// svc := emrcontainers.New(sess) +// +// myFunc(svc) +// } +// +// In your _test.go file: +// +// // Define a mock struct to be used in your unit tests of myFunc. +// type mockEMRContainersClient struct { +// emrcontainersiface.EMRContainersAPI +// } +// func (m *mockEMRContainersClient) CancelJobRun(input *emrcontainers.CancelJobRunInput) (*emrcontainers.CancelJobRunOutput, error) { +// // mock response/functionality +// } +// +// func TestMyFunc(t *testing.T) { +// // Setup Test +// mockSvc := &mockEMRContainersClient{} +// +// myfunc(mockSvc) +// +// // Verify myFunc's functionality +// } +// +// It is important to note that this interface will have breaking changes +// when the service model is updated and adds new API operations, paginators, +// and waiters. Its suggested to use the pattern above for testing, or using +// tooling to generate mocks to satisfy the interfaces. +type EMRContainersAPI interface { + CancelJobRun(*emrcontainers.CancelJobRunInput) (*emrcontainers.CancelJobRunOutput, error) + CancelJobRunWithContext(aws.Context, *emrcontainers.CancelJobRunInput, ...request.Option) (*emrcontainers.CancelJobRunOutput, error) + CancelJobRunRequest(*emrcontainers.CancelJobRunInput) (*request.Request, *emrcontainers.CancelJobRunOutput) + + CreateManagedEndpoint(*emrcontainers.CreateManagedEndpointInput) (*emrcontainers.CreateManagedEndpointOutput, error) + CreateManagedEndpointWithContext(aws.Context, *emrcontainers.CreateManagedEndpointInput, ...request.Option) (*emrcontainers.CreateManagedEndpointOutput, error) + CreateManagedEndpointRequest(*emrcontainers.CreateManagedEndpointInput) (*request.Request, *emrcontainers.CreateManagedEndpointOutput) + + CreateVirtualCluster(*emrcontainers.CreateVirtualClusterInput) (*emrcontainers.CreateVirtualClusterOutput, error) + CreateVirtualClusterWithContext(aws.Context, *emrcontainers.CreateVirtualClusterInput, ...request.Option) (*emrcontainers.CreateVirtualClusterOutput, error) + CreateVirtualClusterRequest(*emrcontainers.CreateVirtualClusterInput) (*request.Request, *emrcontainers.CreateVirtualClusterOutput) + + DeleteManagedEndpoint(*emrcontainers.DeleteManagedEndpointInput) (*emrcontainers.DeleteManagedEndpointOutput, error) + DeleteManagedEndpointWithContext(aws.Context, *emrcontainers.DeleteManagedEndpointInput, ...request.Option) (*emrcontainers.DeleteManagedEndpointOutput, error) + DeleteManagedEndpointRequest(*emrcontainers.DeleteManagedEndpointInput) (*request.Request, *emrcontainers.DeleteManagedEndpointOutput) + + DeleteVirtualCluster(*emrcontainers.DeleteVirtualClusterInput) (*emrcontainers.DeleteVirtualClusterOutput, error) + DeleteVirtualClusterWithContext(aws.Context, *emrcontainers.DeleteVirtualClusterInput, ...request.Option) (*emrcontainers.DeleteVirtualClusterOutput, error) + DeleteVirtualClusterRequest(*emrcontainers.DeleteVirtualClusterInput) (*request.Request, *emrcontainers.DeleteVirtualClusterOutput) + + DescribeJobRun(*emrcontainers.DescribeJobRunInput) (*emrcontainers.DescribeJobRunOutput, error) + DescribeJobRunWithContext(aws.Context, *emrcontainers.DescribeJobRunInput, ...request.Option) (*emrcontainers.DescribeJobRunOutput, error) + DescribeJobRunRequest(*emrcontainers.DescribeJobRunInput) (*request.Request, *emrcontainers.DescribeJobRunOutput) + + DescribeManagedEndpoint(*emrcontainers.DescribeManagedEndpointInput) (*emrcontainers.DescribeManagedEndpointOutput, error) + DescribeManagedEndpointWithContext(aws.Context, *emrcontainers.DescribeManagedEndpointInput, ...request.Option) (*emrcontainers.DescribeManagedEndpointOutput, error) + DescribeManagedEndpointRequest(*emrcontainers.DescribeManagedEndpointInput) (*request.Request, *emrcontainers.DescribeManagedEndpointOutput) + + DescribeVirtualCluster(*emrcontainers.DescribeVirtualClusterInput) (*emrcontainers.DescribeVirtualClusterOutput, error) + DescribeVirtualClusterWithContext(aws.Context, *emrcontainers.DescribeVirtualClusterInput, ...request.Option) (*emrcontainers.DescribeVirtualClusterOutput, error) + DescribeVirtualClusterRequest(*emrcontainers.DescribeVirtualClusterInput) (*request.Request, *emrcontainers.DescribeVirtualClusterOutput) + + ListJobRuns(*emrcontainers.ListJobRunsInput) (*emrcontainers.ListJobRunsOutput, error) + ListJobRunsWithContext(aws.Context, *emrcontainers.ListJobRunsInput, ...request.Option) (*emrcontainers.ListJobRunsOutput, error) + ListJobRunsRequest(*emrcontainers.ListJobRunsInput) (*request.Request, *emrcontainers.ListJobRunsOutput) + + ListJobRunsPages(*emrcontainers.ListJobRunsInput, func(*emrcontainers.ListJobRunsOutput, bool) bool) error + ListJobRunsPagesWithContext(aws.Context, *emrcontainers.ListJobRunsInput, func(*emrcontainers.ListJobRunsOutput, bool) bool, ...request.Option) error + + ListManagedEndpoints(*emrcontainers.ListManagedEndpointsInput) (*emrcontainers.ListManagedEndpointsOutput, error) + ListManagedEndpointsWithContext(aws.Context, *emrcontainers.ListManagedEndpointsInput, ...request.Option) (*emrcontainers.ListManagedEndpointsOutput, error) + ListManagedEndpointsRequest(*emrcontainers.ListManagedEndpointsInput) (*request.Request, *emrcontainers.ListManagedEndpointsOutput) + + ListManagedEndpointsPages(*emrcontainers.ListManagedEndpointsInput, func(*emrcontainers.ListManagedEndpointsOutput, bool) bool) error + ListManagedEndpointsPagesWithContext(aws.Context, *emrcontainers.ListManagedEndpointsInput, func(*emrcontainers.ListManagedEndpointsOutput, bool) bool, ...request.Option) error + + ListTagsForResource(*emrcontainers.ListTagsForResourceInput) (*emrcontainers.ListTagsForResourceOutput, error) + ListTagsForResourceWithContext(aws.Context, *emrcontainers.ListTagsForResourceInput, ...request.Option) (*emrcontainers.ListTagsForResourceOutput, error) + ListTagsForResourceRequest(*emrcontainers.ListTagsForResourceInput) (*request.Request, *emrcontainers.ListTagsForResourceOutput) + + ListVirtualClusters(*emrcontainers.ListVirtualClustersInput) (*emrcontainers.ListVirtualClustersOutput, error) + ListVirtualClustersWithContext(aws.Context, *emrcontainers.ListVirtualClustersInput, ...request.Option) (*emrcontainers.ListVirtualClustersOutput, error) + ListVirtualClustersRequest(*emrcontainers.ListVirtualClustersInput) (*request.Request, *emrcontainers.ListVirtualClustersOutput) + + ListVirtualClustersPages(*emrcontainers.ListVirtualClustersInput, func(*emrcontainers.ListVirtualClustersOutput, bool) bool) error + ListVirtualClustersPagesWithContext(aws.Context, *emrcontainers.ListVirtualClustersInput, func(*emrcontainers.ListVirtualClustersOutput, bool) bool, ...request.Option) error + + StartJobRun(*emrcontainers.StartJobRunInput) (*emrcontainers.StartJobRunOutput, error) + StartJobRunWithContext(aws.Context, *emrcontainers.StartJobRunInput, ...request.Option) (*emrcontainers.StartJobRunOutput, error) + StartJobRunRequest(*emrcontainers.StartJobRunInput) (*request.Request, *emrcontainers.StartJobRunOutput) + + TagResource(*emrcontainers.TagResourceInput) (*emrcontainers.TagResourceOutput, error) + TagResourceWithContext(aws.Context, *emrcontainers.TagResourceInput, ...request.Option) (*emrcontainers.TagResourceOutput, error) + TagResourceRequest(*emrcontainers.TagResourceInput) (*request.Request, *emrcontainers.TagResourceOutput) + + UntagResource(*emrcontainers.UntagResourceInput) (*emrcontainers.UntagResourceOutput, error) + UntagResourceWithContext(aws.Context, *emrcontainers.UntagResourceInput, ...request.Option) (*emrcontainers.UntagResourceOutput, error) + UntagResourceRequest(*emrcontainers.UntagResourceInput) (*request.Request, *emrcontainers.UntagResourceOutput) +} + +var _ EMRContainersAPI = (*emrcontainers.EMRContainers)(nil) diff --git a/service/emrcontainers/errors.go b/service/emrcontainers/errors.go new file mode 100644 index 00000000000..1fc223d5526 --- /dev/null +++ b/service/emrcontainers/errors.go @@ -0,0 +1,34 @@ +// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT. + +package emrcontainers + +import ( + "github.com/aws/aws-sdk-go/private/protocol" +) + +const ( + + // ErrCodeInternalServerException for service response error code + // "InternalServerException". + // + // This is an internal server exception. + ErrCodeInternalServerException = "InternalServerException" + + // ErrCodeResourceNotFoundException for service response error code + // "ResourceNotFoundException". + // + // The specified resource was not found. + ErrCodeResourceNotFoundException = "ResourceNotFoundException" + + // ErrCodeValidationException for service response error code + // "ValidationException". + // + // There are invalid parameters in the client request. + ErrCodeValidationException = "ValidationException" +) + +var exceptionFromCode = map[string]func(protocol.ResponseMetadata) error{ + "InternalServerException": newErrorInternalServerException, + "ResourceNotFoundException": newErrorResourceNotFoundException, + "ValidationException": newErrorValidationException, +} diff --git a/service/emrcontainers/service.go b/service/emrcontainers/service.go new file mode 100644 index 00000000000..e65fdcf77be --- /dev/null +++ b/service/emrcontainers/service.go @@ -0,0 +1,104 @@ +// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT. + +package emrcontainers + +import ( + "github.com/aws/aws-sdk-go/aws" + "github.com/aws/aws-sdk-go/aws/client" + "github.com/aws/aws-sdk-go/aws/client/metadata" + "github.com/aws/aws-sdk-go/aws/request" + "github.com/aws/aws-sdk-go/aws/signer/v4" + "github.com/aws/aws-sdk-go/private/protocol" + "github.com/aws/aws-sdk-go/private/protocol/restjson" +) + +// EMRContainers provides the API operation methods for making requests to +// Amazon EMR Containers. See this package's package overview docs +// for details on the service. +// +// EMRContainers methods are safe to use concurrently. It is not safe to +// modify mutate any of the struct's properties though. +type EMRContainers struct { + *client.Client +} + +// Used for custom client initialization logic +var initClient func(*client.Client) + +// Used for custom request initialization logic +var initRequest func(*request.Request) + +// Service information constants +const ( + ServiceName = "EMR containers" // Name of service. + EndpointsID = "emr-containers" // ID to lookup a service endpoint with. + ServiceID = "EMR containers" // ServiceID is a unique identifier of a specific service. +) + +// New creates a new instance of the EMRContainers client with a session. +// If additional configuration is needed for the client instance use the optional +// aws.Config parameter to add your extra config. +// +// Example: +// mySession := session.Must(session.NewSession()) +// +// // Create a EMRContainers client from just a session. +// svc := emrcontainers.New(mySession) +// +// // Create a EMRContainers client with additional configuration +// svc := emrcontainers.New(mySession, aws.NewConfig().WithRegion("us-west-2")) +func New(p client.ConfigProvider, cfgs ...*aws.Config) *EMRContainers { + c := p.ClientConfig(EndpointsID, cfgs...) + if c.SigningNameDerived || len(c.SigningName) == 0 { + c.SigningName = "emr-containers" + } + return newClient(*c.Config, c.Handlers, c.PartitionID, c.Endpoint, c.SigningRegion, c.SigningName) +} + +// newClient creates, initializes and returns a new service client instance. +func newClient(cfg aws.Config, handlers request.Handlers, partitionID, endpoint, signingRegion, signingName string) *EMRContainers { + svc := &EMRContainers{ + Client: client.New( + cfg, + metadata.ClientInfo{ + ServiceName: ServiceName, + ServiceID: ServiceID, + SigningName: signingName, + SigningRegion: signingRegion, + PartitionID: partitionID, + Endpoint: endpoint, + APIVersion: "2020-10-01", + }, + handlers, + ), + } + + // Handlers + svc.Handlers.Sign.PushBackNamed(v4.SignRequestHandler) + svc.Handlers.Build.PushBackNamed(restjson.BuildHandler) + svc.Handlers.Unmarshal.PushBackNamed(restjson.UnmarshalHandler) + svc.Handlers.UnmarshalMeta.PushBackNamed(restjson.UnmarshalMetaHandler) + svc.Handlers.UnmarshalError.PushBackNamed( + protocol.NewUnmarshalErrorHandler(restjson.NewUnmarshalTypedError(exceptionFromCode)).NamedHandler(), + ) + + // Run custom client initialization if present + if initClient != nil { + initClient(svc.Client) + } + + return svc +} + +// newRequest creates a new request for a EMRContainers operation and runs any +// custom request initialization. +func (c *EMRContainers) newRequest(op *request.Operation, params, data interface{}) *request.Request { + req := c.NewRequest(op, params, data) + + // Run custom request initialization if present + if initRequest != nil { + initRequest(req) + } + + return req +} diff --git a/service/forecastservice/api.go b/service/forecastservice/api.go index cdffe235573..ef630349413 100644 --- a/service/forecastservice/api.go +++ b/service/forecastservice/api.go @@ -752,11 +752,22 @@ func (c *ForecastService) CreatePredictorBacktestExportJobRequest(input *CreateP // CreatePredictorBacktestExportJob API operation for Amazon Forecast Service. // // Exports backtest forecasts and accuracy metrics generated by the CreatePredictor -// operation. Two CSV files are exported to a specified S3 bucket. +// operation. Two folders containing CSV files are exported to your specified +// S3 bucket. // -// You must specify a DataDestination object that includes an AWS Identity and -// Access Management (IAM) role that Amazon Forecast can assume to access the -// Amazon S3 bucket. For more information, see aws-forecast-iam-roles. +// The export file names will match the following conventions: +// +//