UNPKG

openapi-directory

Version:

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

1 lines 20.6 kB
{"openapi":"3.0.0","info":{"version":"2017-12-19","x-release":"v4","title":"Amazon Macie","description":"<fullname>Amazon Macie</fullname> <p>Amazon Macie is a security service that uses machine learning to automatically discover, classify, and protect sensitive data in AWS. Macie recognizes sensitive data such as personally identifiable information (PII) or intellectual property, and provides you with dashboards and alerts that give visibility into how this data is being accessed or moved. For more information, see the <a href=\"https://docs.aws.amazon.com/macie/latest/userguide/what-is-macie.html\">Macie User Guide</a>. </p>","x-logo":{"url":"https://twitter.com/awscloud/profile_image?size=original","backgroundColor":"#FFFFFF"},"termsOfService":"https://aws.amazon.com/service-terms/","contact":{"name":"Mike Ralphson","email":"mike.ralphson@gmail.com","url":"https://github.com/mermade/aws2openapi","x-twitter":"PermittedSoc"},"license":{"name":"Apache 2.0 License","url":"http://www.apache.org/licenses/"},"x-providerName":"amazonaws.com","x-serviceName":"macie","x-origin":[{"contentType":"application/json","url":"https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/macie-2017-12-19.normal.json","converter":{"url":"https://github.com/mermade/aws2openapi","version":"1.0.0"},"x-apisguru-direct":true}],"x-apiClientRegistration":{"url":"https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct"},"x-apisguru-categories":["cloud"],"x-preferred":true},"externalDocs":{"description":"Amazon Web Services documentation","url":"https://aws.amazon.com/macie/"},"x-hasEquivalentPaths":true,"security":[{"hmac":[]}],"paths":{"/":{"post":{"operationId":"AssociateMemberAccount","description":"Associates a specified AWS account with Amazon Macie as a member account.","responses":{"200":{"description":"Success"},"480":{"description":"InvalidInputException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidInputException"}}}},"481":{"description":"LimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LimitExceededException"}}}},"482":{"description":"InternalException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalException"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssociateMemberAccountRequest"}}},"required":true}},"parameters":[{"$ref":"#/components/parameters/Action"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/#AssociateS3Resources":{"post":{"operationId":"AssociateS3Resources","description":"Associates specified S3 resources with Amazon Macie for monitoring and data classification. If memberAccountId isn't specified, the action associates specified S3 resources with Macie for the current master account. If memberAccountId is specified, the action associates specified S3 resources with Macie for the specified member account. ","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssociateS3ResourcesResult"}}}},"480":{"description":"InvalidInputException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidInputException"}}}},"481":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"482":{"description":"LimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LimitExceededException"}}}},"483":{"description":"InternalException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalException"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssociateS3ResourcesRequest"}}},"required":true}},"parameters":[{"$ref":"#/components/parameters/Action"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/#DisassociateMemberAccount":{"post":{"operationId":"DisassociateMemberAccount","description":"Removes the specified member account from Amazon Macie.","responses":{"200":{"description":"Success"},"480":{"description":"InvalidInputException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidInputException"}}}},"481":{"description":"InternalException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalException"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DisassociateMemberAccountRequest"}}},"required":true}},"parameters":[{"$ref":"#/components/parameters/Action"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/#DisassociateS3Resources":{"post":{"operationId":"DisassociateS3Resources","description":"Removes specified S3 resources from being monitored by Amazon Macie. If memberAccountId isn't specified, the action removes specified S3 resources from Macie for the current master account. If memberAccountId is specified, the action removes specified S3 resources from Macie for the specified member account.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DisassociateS3ResourcesResult"}}}},"480":{"description":"InvalidInputException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidInputException"}}}},"481":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"482":{"description":"InternalException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalException"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DisassociateS3ResourcesRequest"}}},"required":true}},"parameters":[{"$ref":"#/components/parameters/Action"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/#ListMemberAccounts":{"post":{"operationId":"ListMemberAccounts","description":"Lists all Amazon Macie member accounts for the current Amazon Macie master account.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListMemberAccountsResult"}}}},"480":{"description":"InternalException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalException"}}}},"481":{"description":"InvalidInputException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidInputException"}}}}},"parameters":[{"name":"maxResults","in":"query","description":"Pagination limit","required":false,"schema":{"type":"string"}},{"name":"nextToken","in":"query","description":"Pagination token","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListMemberAccountsRequest"}}},"required":true}},"parameters":[{"$ref":"#/components/parameters/Action"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/#ListS3Resources":{"post":{"operationId":"ListS3Resources","description":"Lists all the S3 resources associated with Amazon Macie. If memberAccountId isn't specified, the action lists the S3 resources associated with Amazon Macie for the current master account. If memberAccountId is specified, the action lists the S3 resources associated with Amazon Macie for the specified member account. ","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListS3ResourcesResult"}}}},"480":{"description":"InvalidInputException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidInputException"}}}},"481":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"482":{"description":"InternalException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalException"}}}}},"parameters":[{"name":"maxResults","in":"query","description":"Pagination limit","required":false,"schema":{"type":"string"}},{"name":"nextToken","in":"query","description":"Pagination token","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListS3ResourcesRequest"}}},"required":true}},"parameters":[{"$ref":"#/components/parameters/Action"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/#UpdateS3Resources":{"post":{"operationId":"UpdateS3Resources","description":"Updates the classification types for the specified S3 resources. If memberAccountId isn't specified, the action updates the classification types of the S3 resources associated with Amazon Macie for the current master account. If memberAccountId is specified, the action updates the classification types of the S3 resources associated with Amazon Macie for the specified member account. ","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateS3ResourcesResult"}}}},"480":{"description":"InvalidInputException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidInputException"}}}},"481":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"482":{"description":"InternalException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalException"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateS3ResourcesRequest"}}},"required":true}},"parameters":[{"$ref":"#/components/parameters/Action"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]}},"servers":[{"url":"https://macie.amazonaws.com/"},{"url":"http://macie.amazonaws.com/"}],"components":{"parameters":{"Action":{"name":"Action","in":"query","required":true,"schema":{"type":"string"}},"Version":{"name":"Version","in":"query","required":true,"schema":{"type":"string"}},"X-Amz-Content-Sha256":{"name":"X-Amz-Content-Sha256","in":"header","required":false,"schema":{"type":"string"}},"X-Amz-Date":{"name":"X-Amz-Date","in":"header","required":false,"schema":{"type":"string"}},"X-Amz-Algorithm":{"name":"X-Amz-Algorithm","in":"header","required":false,"schema":{"type":"string"}},"X-Amz-Credential":{"name":"X-Amz-Credential","in":"header","required":false,"schema":{"type":"string"}},"X-Amz-Security-Token":{"name":"X-Amz-Security-Token","in":"header","required":false,"schema":{"type":"string"}},"X-Amz-Signature":{"name":"X-Amz-Signature","in":"header","required":false,"schema":{"type":"string"}},"X-Amz-SignedHeaders":{"name":"X-Amz-SignedHeaders","in":"header","required":false,"schema":{"type":"string"}}},"securitySchemes":{"hmac":{"type":"apiKey","name":"Authorization","in":"header","description":"Amazon Signature authorization v4","x-amazon-apigateway-authtype":"awsSigv4"}},"schemas":{"AssociateMemberAccountRequest":{"type":"object","required":["memberAccountId"],"properties":{"memberAccountId":{"$ref":"#/components/schemas/AWSAccountId"}}},"InvalidInputException":{"type":"object","properties":{"errorCode":{"$ref":"#/components/schemas/ErrorCode"},"message":{"$ref":"#/components/schemas/ExceptionMessage"},"fieldName":{"$ref":"#/components/schemas/FieldName"}},"description":"The request was rejected because an invalid or out-of-range value was supplied for an input parameter. "},"LimitExceededException":{"type":"object","properties":{"errorCode":{"$ref":"#/components/schemas/ErrorCode"},"message":{"$ref":"#/components/schemas/ExceptionMessage"},"resourceType":{"$ref":"#/components/schemas/ResourceType"}},"description":"The request was rejected because it attempted to create resources beyond the current AWS account limits. The error code describes the limit exceeded. "},"InternalException":{"type":"object","properties":{"errorCode":{"$ref":"#/components/schemas/ErrorCode"},"message":{"$ref":"#/components/schemas/ExceptionMessage"}},"description":"Internal server error."},"AssociateS3ResourcesResult":{"type":"object","properties":{"failedS3Resources":{"$ref":"#/components/schemas/FailedS3Resources"}}},"AssociateS3ResourcesRequest":{"type":"object","required":["s3Resources"],"properties":{"memberAccountId":{"$ref":"#/components/schemas/AWSAccountId"},"s3Resources":{"$ref":"#/components/schemas/S3ResourcesClassification"}}},"AccessDeniedException":{"type":"object","properties":{"message":{"$ref":"#/components/schemas/ExceptionMessage"},"resourceType":{"$ref":"#/components/schemas/ResourceType"}},"description":"You do not have required permissions to access the requested resource."},"DisassociateMemberAccountRequest":{"type":"object","required":["memberAccountId"],"properties":{"memberAccountId":{"$ref":"#/components/schemas/AWSAccountId"}}},"DisassociateS3ResourcesResult":{"type":"object","properties":{"failedS3Resources":{"$ref":"#/components/schemas/FailedS3Resources"}}},"DisassociateS3ResourcesRequest":{"type":"object","required":["associatedS3Resources"],"properties":{"memberAccountId":{"$ref":"#/components/schemas/AWSAccountId"},"associatedS3Resources":{"$ref":"#/components/schemas/S3Resources"}}},"ListMemberAccountsResult":{"type":"object","properties":{"memberAccounts":{"$ref":"#/components/schemas/MemberAccounts"},"nextToken":{"$ref":"#/components/schemas/NextToken"}}},"ListMemberAccountsRequest":{"type":"object","properties":{"nextToken":{"$ref":"#/components/schemas/NextToken"},"maxResults":{"$ref":"#/components/schemas/MaxResults"}}},"ListS3ResourcesResult":{"type":"object","properties":{"s3Resources":{"$ref":"#/components/schemas/S3ResourcesClassification"},"nextToken":{"$ref":"#/components/schemas/NextToken"}}},"ListS3ResourcesRequest":{"type":"object","properties":{"memberAccountId":{"$ref":"#/components/schemas/AWSAccountId"},"nextToken":{"$ref":"#/components/schemas/NextToken"},"maxResults":{"$ref":"#/components/schemas/MaxResults"}}},"UpdateS3ResourcesResult":{"type":"object","properties":{"failedS3Resources":{"$ref":"#/components/schemas/FailedS3Resources"}}},"UpdateS3ResourcesRequest":{"type":"object","required":["s3ResourcesUpdate"],"properties":{"memberAccountId":{"$ref":"#/components/schemas/AWSAccountId"},"s3ResourcesUpdate":{"$ref":"#/components/schemas/S3ResourcesClassificationUpdate"}}},"AWSAccountId":{"type":"string","pattern":"[0-9]{12}"},"ExceptionMessage":{"type":"string","maxLength":10000},"ResourceType":{"type":"string","description":"Resource type that caused the exception","maxLength":1000},"S3ResourcesClassification":{"type":"array","items":{"$ref":"#/components/schemas/S3ResourceClassification"}},"FailedS3Resources":{"type":"array","items":{"$ref":"#/components/schemas/FailedS3Resource"}},"BucketName":{"type":"string","maxLength":500},"S3OneTimeClassificationType":{"type":"string","enum":["FULL","NONE"]},"S3ContinuousClassificationType":{"type":"string","enum":["FULL"]},"ClassificationType":{"type":"object","required":["oneTime","continuous"],"properties":{"oneTime":{"$ref":"#/components/schemas/S3OneTimeClassificationType"},"continuous":{"$ref":"#/components/schemas/S3ContinuousClassificationType"}},"description":"The classification type that Amazon Macie applies to the associated S3 resources. "},"ClassificationTypeUpdate":{"type":"object","properties":{"oneTime":{"$ref":"#/components/schemas/S3OneTimeClassificationType"},"continuous":{"$ref":"#/components/schemas/S3ContinuousClassificationType"}},"description":"The classification type that Amazon Macie applies to the associated S3 resources. At least one of the classification types (oneTime or continuous) must be specified. "},"S3Resources":{"type":"array","items":{"$ref":"#/components/schemas/S3Resource"}},"ErrorCode":{"type":"string","description":"Error code for the exception","maxLength":10},"S3Resource":{"type":"object","required":["bucketName"],"properties":{"bucketName":{"$ref":"#/components/schemas/BucketName"},"prefix":{"$ref":"#/components/schemas/Prefix"}},"description":"Contains information about the S3 resource. This data type is used as a request parameter in the DisassociateS3Resources action and can be used as a response parameter in the AssociateS3Resources and UpdateS3Resources actions. "},"FailedS3Resource":{"type":"object","properties":{"failedItem":{"$ref":"#/components/schemas/S3Resource"},"errorCode":{"$ref":"#/components/schemas/ErrorCode"},"errorMessage":{"$ref":"#/components/schemas/ExceptionMessage"}},"description":"Includes details about the failed S3 resources."},"FieldName":{"type":"string","description":"Field that has invalid input","maxLength":1000},"NextToken":{"type":"string","maxLength":500},"MaxResults":{"type":"integer","maximum":250},"MemberAccounts":{"type":"array","items":{"$ref":"#/components/schemas/MemberAccount"}},"MemberAccount":{"type":"object","properties":{"accountId":{"$ref":"#/components/schemas/AWSAccountId"}},"description":"Contains information about the Amazon Macie member account."},"Prefix":{"type":"string","maxLength":10000},"S3ResourceClassification":{"type":"object","required":["bucketName","classificationType"],"properties":{"bucketName":{"$ref":"#/components/schemas/BucketName"},"prefix":{"$ref":"#/components/schemas/Prefix"},"classificationType":{"$ref":"#/components/schemas/ClassificationType"}},"description":"The S3 resources that you want to associate with Amazon Macie for monitoring and data classification. This data type is used as a request parameter in the AssociateS3Resources action and a response parameter in the ListS3Resources action. "},"S3ResourceClassificationUpdate":{"type":"object","required":["bucketName","classificationTypeUpdate"],"properties":{"bucketName":{"$ref":"#/components/schemas/BucketName"},"prefix":{"$ref":"#/components/schemas/Prefix"},"classificationTypeUpdate":{"$ref":"#/components/schemas/ClassificationTypeUpdate"}},"description":"The S3 resources whose classification types you want to update. This data type is used as a request parameter in the UpdateS3Resources action. "},"S3ResourcesClassificationUpdate":{"type":"array","items":{"$ref":"#/components/schemas/S3ResourceClassificationUpdate"}}}}}